Jump to

• Request
• Response
• Examples

Create a Snapshot

post

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

Creates a snapshot of the storage volumes of a MySQL Cloud Service instance.

With every snapshot that you take of a service instance, the billable block storage will increase by the total size of all the volumes attached to the instance. For example, if an instance has 100 GB of block storage volumes, the first snapshot will increase the billable block storage for the instance to 200 GB, the second snapshot will increase the billable block storage to 300 GB, and so on.

After creating a snapshot, use the same endpoint for creating a service instance to create the service instance clone.

Request

Supported Media Types

• application/json

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.

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."
        }
    }
}

Response

202 Response

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

Body ()

Root Schema : Response Body

Type: object

Title: Response Body

The response body contains information about the operation.

Show Source

• jobId(optional): string
  Job ID for the operation.
• message(optional): string
  System message that describes the operation. For example: Snapshot a service [{serviceId}] is submitted as an asynchronous job.

{
    "title":"Response Body",
    "description":"The response body contains information about the operation.",
    "properties":{
        "message":{
            "description":"System message that describes the operation. For example: <code>Snapshot a service [{serviceId}] is submitted as an asynchronous job.</code>",
            "type":"string"
        },
        "jobId":{
            "description":"Job ID for the operation.",
            "type":"string"
        }
    }
}

Examples

The following example shows how to create a snapshot of a MySQL Cloud Service instance by submitting a POST request on the REST endpoint using cURL.

In this example, the identity domain is ExampleIdentityDomain, the service instance is mysql57?aas and the Oracle Cloud user name and password are username and password.

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.

Note:

The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the Oracle Public Cloud or Oracle Cloud Machine REST server to contact for your identity domain or tenant name. See Send Requests for the appropriate URL structure to use on Oracle Public Cloud or Oracle Cloud Machine.

cURL Command

curl --include --request POST \
--user "username:password" \
--header "X-ID-TENANT-NAME:ExampleIdentityDomain" \
--header "Content-Type: application/json" \
--data '{"name":"snapshot001", "description":"This is snapshot 001"}' \
https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/mysql57-aas/snapshots

HTTP Status Code and Response Headers

HTTP/1.1 202 Accepted
Date: Wed, 26 Jul 2017 12:40:14 GMT
Server: Oracle-Application-Server-11g
Location: http:/rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/5145052
Content-Length: 127
Content-Language: en
Access-Control-Allow-Headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
Retry-After: 60
X-ORACLE-DMS-ECID: 005LJUzt3nT2zGILIqH7if0004vG0001Zr
X-ORACLE-DMS-ECID: 005LJUzt3nT2zGILIqH7if0004vG0001Zr
Access-Control-Allow-Origin: *
X-Frame-Options: DENY
Vary: Accept-Encoding,User-Agent
Content-Type: application/json
{"status":"New","details":{"message":"Snapshot a service [mysql57-aas] is submitted as an asynchronous job.","jobId":"5145052"}}