Jump to

• Request
• Response
• Examples

View a Snapshot

get

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

Returns information about a storage snapshot 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.
• snapshotName: string
  Name of the snapshot.

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: object

Title: Response Body

Show Source

• clonedServices(optional): array clonedServices Array
  Title: clonedServices Array

  Array of JSON object elements, with one element for each service instance created from the snapshot.
• 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.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "clonedServices":{
            "title":"clonedServices Array",
            "type":"array",
            "description":"Array of JSON object elements, with one element for each service instance created from the snapshot.",
            "items":{
                "$ref":"#/definitions/view-snapshot-clonedServices-array-item"
            }
        },
        "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."
        }
    }
}

Nested Schema : clonedServices Array

Type: array

Title: clonedServices Array

Array of JSON object elements, with one element for each service instance created from the snapshot.

Show Source

• Array of: object clonedServices Array Item
  Title: clonedServices Array Item

{
    "title":"clonedServices Array",
    "type":"array",
    "description":"Array of JSON object elements, with one element for each service instance created from the snapshot.",
    "items":{
        "$ref":"#/definitions/view-snapshot-clonedServices-array-item"
    }
}

Nested Schema : clonedServices Array Item

Type: object

Title: clonedServices Array Item

Show Source

• clonedServiceCreationTime(optional): string
  The date-and-time stamp when the cloned service instance was created.
• clonedServiceName(optional): string
  Name of the cloned service instance.

{
    "title":"clonedServices Array Item",
    "type":"object",
    "properties":{
        "clonedServiceCreationTime":{
            "type":"string",
            "description":"The date-and-time stamp when the cloned service instance was created."
        },
        "clonedServiceName":{
            "type":"string",
            "description":"Name of the cloned service instance."
        }
    }
}

Back to Top

Examples

The following example shows how to view detailed information about a snapshot 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. Detailed information is being requested for the snapshot4patchtest snapshot of the db121-ep-si service instance. Note that one service instance, db121-ep-si-patchtest, has been created from this snapshot.

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/snapshot4patchtest

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Content-Length: 287
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":"snapshot4patchtest",
  "description":"Snapshot to test application of PSU patch",
  "creationTime":"Aug 17, 2016 07:21:41 PM UTC",
  "clonedServicesSize":1, 
  "clonedServices":[
    {
      "clonedServiceName":"db121-ep-si-patchtest",
      "clonedServiceCreationTime":"Aug 17, 2016 09:10:27 PM UTC"
    }
  ]
}

Back to Top