Jump to

• Request
• Response
• Examples

View All Snapshots

get

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

Returns infomation about all the storage snapshots of a Database Classic Cloud Service instance.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

• serviceId: string
  Name of the Database Classic Cloud Service instance.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

Back to Top

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

• Array of: 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

• clonedServicesSize(optional): integer
  Number of service instances created from the snapshot.
• creationTime(optional): string
  The date-and-time stamp when the snapshot was created.
• description(optional): string
  Description of the snapshot.
• name(optional): string
  Name of the snapshot.
• status(optional): string
  Status of the snapshot: In Progress or Succeeded.

{
    "title":"Response Body Array Item",
    "type":"object",
    "properties":{
        "clonedServicesSize":{
            "type":"integer",
            "description":"Number of service instances created from the snapshot."
        },
        "creationTime":{
            "type":"string",
            "description":"The date-and-time stamp when the snapshot was created."
        },
        "description":{
            "type":"string",
            "description":"Description of the snapshot."
        },
        "name":{
            "type":"string",
            "description":"Name of the snapshot."
        },
        "status":{
            "type":"string",
            "description":"Status of the snapshot: <code>In Progress</code> or <code>Succeeded</code>."
        }
    }
}

Back to Top

Examples

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

This example uses a traditional cloud account, so the {identityDomainId} path parameter and the X-ID-TENANT-NAME header parameter are set to the account's domain name, which is usexample. The Oracle Cloud user name of the user making the call is dbcsadmin. The response shows two snapshots, snapshot and snapshot4patchtest.

cURL Command

curl --include --request GET \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db121-ep-si/snapshots

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Content-Length: 180
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
X-Frame-Options: DENY
Content-Language: en
Content-Type: application/json

Response Body

[
  {
    "name":"snapshot",
    "creationTime":"Aug 17, 2016 06:51:06 AM UTC",
    "clonedServicesSize":0,
    "status":"Succeeded"
  },
  {
    "name":"snapshot4patchtest",
    "description":"Snapshot to test application of PSU patch",
    "creationTime":"Aug 17, 2016 07:21:41 PM UTC",
    "clonedServicesSize":1,
    "status":"Succeeded"
  }
]

Back to Top