Jump to

• Request
• Response
• Examples

View All Snapshots

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/snapshots

Returns information about all the storage snapshots of a MySQL Cloud Service instance.

Request

Path Parameters

• identityDomainId: string
  Name of the identity domain for the MySQL Cloud Service account.
• serviceId: string
  The user-defined name of the Oracle MySQL Cloud Service instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Name of the identity domain for the MySQL Cloud Service account.

Response

Supported Media Types

• application/json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Body ()

Root Schema : Response Body

Type: array

Title: Response Body

Array of JSON object elements, with one element each for snapshot.

Show Source

• [0]: object Response Body Array Item
  Title: Response Body Array Item

{
    "title":"Response Body",
    "type":"array",
    "description":"Array of JSON object elements, with one element each for snapshot.",
    "items":{
        "$ref":"#/definitions/view-all-snapshots-array-item"
    }
}

Nested Schema : Response Body Array Item

Type: object

Title: Response Body Array Item

Show Source

• cloneCount(optional): integer
  Number of service instances created from the snapshot.
• description(optional): string
  Description of the snapshot.
• name(optional): string
  Name of the snapshot.
• opInProgress(optional): string
  In-progress operation of the snapshot: RemoveSnapshot or Clone.
• opStatusMessage(optional): string
  Status message of the snapshot: Snapshot In Progress, Clone In Progress, Remove Snapshot In Progress, or Snapshot Succeeded.
• status(optional): string
  Status of the snapshot: In Progress or Succeeded.
• timestamp(optional): string
  The date-and-time stamp when the snapshot was created.

{
    "title":"Response Body Array Item",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the snapshot."
        },
        "description":{
            "type":"string",
            "description":"Description of the snapshot."
        },
        "cloneCount":{
            "type":"integer",
            "description":"Number of service instances created from the snapshot."
        },
        "timestamp":{
            "type":"string",
            "description":"The date-and-time stamp when the snapshot was created."
        },
        "status":{
            "type":"string",
            "description":"Status of the snapshot: <code>In Progress</code> or <code>Succeeded</code>."
        },
        "opInProgress":{
            "type":"string",
            "description":"In-progress operation of the snapshot: <code>RemoveSnapshot</code> or <code>Clone</code>."
        },
        "opStatusMessage":{
            "type":"string",
            "description":"Status message of the snapshot: <code>Snapshot In Progress</code>, <code>Clone In Progress</code>, <code>Remove Snapshot In Progress</code>, or <code>Snapshot Succeeded</code>."
        }
    }
}

Examples

The following example shows how to view information about all snapshots of a MySQL Cloud Service instance by submitting a GET request on the REST endpoint using cURL.

In this example, the identity domain is ExampleIdentityDomain and the Oracle Cloud user name and password are username and password. The response shows three snapshots, snaptest, snaptest1, and snaptest2.

cURL Command

curl -i -X GET \
  -u "username:password" \
  -u "X-ID-TENANT-NAME:ExampleIdentityDomain" \
https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/snapshots

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: Wed, 26 Jul 2017 14:25:45 GMT
Server: Oracle-Application-Server-11g
Strict-Transport-Security: max-age=31536000; includeSubDomains
Content-Length: 498
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: 005LJ^tEIOy2zGILIqH7if0004vG0000Fk
X-ORACLE-DMS-ECID: 005LJ^tEIOy2zGILIqH7if0004vG0000Fk
Content-Language: en
X-Frame-Options: DENY
Vary: Accept-Encoding,User-Agent
Content-Type: application/json

Response Body

[
	{
		"name":"snaptest2",
		"description":"stringTest",
		"cloneCount":0,
		"timestamp":"2017-07-26T14:00:15.040+0000",
		"status":"Succeeded",
		"opStatusMessage":"Snapshot Succeeded"
	},
	{
		"name":"snaptest1",
		"description":"stringTest",
		"cloneCount":0,
		"timestamp":"2017-07-26T13:46:03.720+0000",
		"status":"Succeeded",
		"opStatusMessage":"Snapshot Succeeded"
	},
	{
		"name":"snaptest",
		"description":"stringTest",
		"cloneCount":0,
		"timestamp":"2017-07-26T12:40:22.273+0000",
		"status":"Succeeded",
		"opStatusMessage":"Snapshot Succeeded"
	}
]