Jump to

• Request
• Response
• Examples

View All Snapshot Masters

get

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

Returns infomation about all snapshot masters for an Exadata Cloud at Customer database deployment.

Request

Path Parameters

• identityDomainId: string

  The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.

• serviceId: string
  The name of the Exadata Cloud at Customer database deployment.

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 at Customer 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 is a character string beginning with idcs-.

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

Title: Response Body

Array of JSON object elements, with one element each for snapshot master.

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 master.",
    "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 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.
• status(optional): string
  Status of the snapshot master: In Progress or Succeeded.

{
    "title":"Response Body Array Item",
    "type":"object",
    "properties":{
        "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."
        },
        "status":{
            "type":"string",
            "description":"Status of the snapshot master: <code>In Progress</code> or <code>Succeeded</code>."
        }
    }
}

Back to Top

Examples

The following example shows how to view information about all snapshot masters that are associated with an Exadata Cloud at Customer 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.

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

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: 005L05_Sfic6uHFpR05Eid0006y90001mY
x-oracle-dms-ecid: 005L05_Sfic6uHFpR05Eid0006y90001mY
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Tue, 11 Jul 2017 02:24:17 GMT
content-length: 170

Response Body

[{
		"name": "SnapMstr12c",
		"description": "Snapshot Master created using REST API",
		"creationTime": "Jul 11, 2017 01:52:15 AM UTC",
		"clonedServicesSize": 0,
		"status": "Succeeded"
	},
 {
		"name": "SnapMstr2",
		"description": "Another Snapshot Master",
		"creationTime": "Jul 11, 2017 02:27:32 AM UTC",
		"clonedServicesSize": 0,
		"status": "Succeeded"
	}
]

Back to Top