Jump to

• Request
• Response
• Examples

View a Snapshot Master

get

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

Returns information about a snapshot master and linked clones associated with an Exadata Cloud Service database deployment.

Request

Path Parameters

• identityDomainId: string

  The value depends on the type of Exadata Cloud Service account that is used to make the request:

  • For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.

  • For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.

• serviceId: string
  The name of the Exadata Cloud Service database deployment.
• snapshotName: string
  Name of the snapshot master.

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

  The value depends on the type of Exadata Cloud Service account that is used to make the request:

  • For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.

  • For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.

  For more information, see Security, Authentication and Authorization.

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 linked clone created from the snapshot master.
• clonedServicesSize(optional): integer
  Number of linked clones created from the snapshot master.
• creationTime(optional): string
  The date-and-time stamp when the snapshot master was created.
• description(optional): string
  Description of the snapshot master.
• name(optional): string
  Name of the snapshot master.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "clonedServices":{
            "title":"clonedServices Array",
            "type":"array",
            "description":"Array of JSON object elements, with one element for each linked clone created from the snapshot master.",
            "items":{
                "$ref":"#/definitions/view-snapshot-clonedServices-array-item"
            }
        },
        "clonedServicesSize":{
            "type":"integer",
            "description":"Number of linked clones created from the snapshot master."
        },
        "creationTime":{
            "type":"string",
            "description":"The date-and-time stamp when the snapshot master was created."
        },
        "description":{
            "type":"string",
            "description":"Description of the snapshot master."
        },
        "name":{
            "type":"string",
            "description":"Name of the snapshot master."
        }
    }
}

Nested Schema : clonedServices Array

Type: array

Title: clonedServices Array

Array of JSON object elements, with one element for each linked clone created from the snapshot master.

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 linked clone created from the snapshot master.",
    "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 linked clone was created.
• clonedServiceName(optional): string
  Name of the linked cloned database deployment.

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

Back to Top

Examples

The following example shows how to view information about a snapshot master and related clones that are associated with an Exadata Cloud Service database deployment by submitting a GET request on the REST endpoint using cURL.

In this example, the identity domain is usexample, and the Oracle Cloud user name and password are serviceadmin and Pa55_word. The name of the database deployment is db12c, and the name of the snapshot master is SnapMstr12c.

cURL Command

curl -i -X GET --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample"  https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db12c/snapshots/SnapMstr12c

HTTP Status Code and Response Headers

HTTP/2.0 200
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
content-language: en
access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
x-oracle-dms-ecid: 005L05WzgAP6uHFpR0H7id0003Ux0000sS
x-oracle-dms-ecid: 005L05WzgAP6uHFpR0H7id0003Ux0000sS
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Tue, 11 Jul 2017 02:23:03 GMT
content-length: 166

Response Body

{
	"name": "SnapMstr12c",
	"description": "Snapshot Master created using REST API",
	"creationTime": "Jul 11, 2017 01:52:15 AM UTC",
	"clonedServicesSize": 0,
	"clonedServices": []
}

Back to Top