Jump to

• Request
• Response
• Examples

View All Snapshots

get

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

Returns infomation about all snapshots of an Oracle Java Cloud Service instance.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Java Cloud Service account.
• serviceId: string
  Name of the Oracle Java Cloud Service instance.

Header Parameters

• Authorization: string
  Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Java Cloud Service account.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : view-all-snapshots

Type: array

Array of JSON object elements. Each object element is a snapshot.

Show Source

• Array of: object available-snapshots

{
    "type":"array",
    "description":"Array of JSON object elements. Each object element is a snapshot.",
    "items":{
        "$ref":"#/definitions/available-snapshots"
    }
}

Nested Schema : available-snapshots

Type: object

Show Source

• cloneCount(optional): integer
  Number of service instance clones created from this snapshot.

  On Oracle Cloud Infrastructure Classic and Oracle Cloud at Customer: A snapshot cannot be deleted as long as there exists one or more service instance clones created from the snapshot.

• description(optional): string
  Description of this snapshot.
• name(optional): string
  Name of this snapshot.
• opStatusMessage(optional): string
  Last status message. For example: Snapshot Succeeded
• status(optional): string
  Status of the snapshot. For example: In Progress, Succeeded
• timestamp(optional): string
  The date-and-time stamp when this snapshot was created.

{
    "type":"object",
    "properties":{
        "cloneCount":{
            "type":"integer",
            "description":"Number of service instance clones created from this snapshot.<p>On Oracle Cloud Infrastructure Classic and Oracle Cloud at Customer: A snapshot cannot be deleted as long as there exists one or more service instance clones created from the snapshot."
        },
        "description":{
            "type":"string",
            "description":"Description of this snapshot."
        },
        "name":{
            "type":"string",
            "description":"Name of this snapshot."
        },
        "opStatusMessage":{
            "type":"string",
            "description":"Last status message. For example: <code>Snapshot Succeeded</code>"
        },
        "status":{
            "type":"string",
            "description":"Status of the snapshot. For example: <code>In Progress</code>, <code>Succeeded</code>"
        },
        "timestamp":{
            "type":"string",
            "description":"The date-and-time stamp when this snapshot was created."
        }
    }
}

Back to Top

Examples

The following example shows how to view all snapshots created for an Oracle Java Cloud Service instance, by submitting a GET request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

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

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Fri, 27 Oct 2017 20:34:54 GMT
Content-Length: 170
Content-Type: application/json

Example of Response Body

The following is an example of the response returned in JSON format.

[
   {
      "name":"mysnap11",
      "description":"A snapshot description",
      "cloneCount":0,
      "timestamp":"2018-08-30T21:15:32.458+0000",
      "remoteSnapshot":false,
      "scheduledSnapshot":false,
      "detachableSnapshot":false,
      "status":"Succeeded",
      "opStatusMessage":"Snapshot Succeeded"
   },
   {
      "name":"testsnap10",
      "description":"Snapshot description",
      "cloneCount":0,
      "timestamp":"2018-08-30T20:52:53.710+0000",
      "remoteSnapshot":false,
      "scheduledSnapshot":false,
      "detachableSnapshot":false,
      "status":"Succeeded",
      "opStatusMessage":"Snapshot Succeeded"
   }
]

Back to Top