Jump to

• Request
• Response
• Examples

Create a Snapshot

post

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

Creates a snapshot of the storage volumes of a Database Classic Cloud Service instance.

Request

Supported Media Types

• application/json

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.

Body ()

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• description(optional): string
  Description of the snapshot.
• name(optional): string
  Name of the snapshot.

{
    "title":"Request Body",
    "type":"object",
    "description":"",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the snapshot."
        },
        "name":{
            "type":"string",
            "description":"Name of the snapshot."
        }
    }
}

Back to Top

Response

202 Response

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

Headers

• Location: string
  A REST URI you can use to check the progress and completion of the snapshot creation operation.

Back to Top

Examples

The following example shows how to create a snapshot of a Database Classic Cloud Service instance by submitting a POST 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 service instance is db121-ep-si and the Oracle Cloud user name of the user making the call is dbcsadmin.

Note that the request body containing the name and description parameters is provided in the cURL command's --data option.

Also note that the Location response header provides a URI you can do a GET on to track completion of the creation operation.

cURL Command

curl --include --request POST \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
--header "Content-Type: application/json" \
--data '{"name":"snapshot4patchtest", "description":"Snapshot to test application of PSU patch"}' \
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 202 Accepted
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Location: https://dbaas.oraclecloud.com:443/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db121-ep-si/snapshots/job/1801775
Content-Length: 0
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
X-Frame-Options: DENY
Retry-After: 60
Content-Language: en
Content-Type: application/json

Back to Top