REST API for Oracle Database Exadata Cloud Service (OCI-C)

View All Recovery Operations

get

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups/recovery/history

Returns a list of recovery operations performed on 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

Name of the Exadata Cloud Service 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 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.

Response

Supported Media Types

application/json

200 Response

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

Root Schema : Response Body

Type: object

Title: Response Body

Show Source

recoveryList(optional): array recoveryList Array

Title: recoveryList Array

Array of JSON object elements, with one element for each recovery operation.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "recoveryList":{
            "title":"recoveryList Array",
            "type":"array",
            "description":"Array of JSON object elements, with one element for each recovery operation.",
            "items":{
                "$ref":"#/definitions/view-all-recoveries-recoveryList-array-item"
            }
        }
    }
}

Nested Schema : recoveryList Array

Type: array

Title: recoveryList Array

Array of JSON object elements, with one element for each recovery operation.

Show Source

Array of: object recoveryList Array Item

Title: recoveryList Array Item

{
    "title":"recoveryList Array",
    "type":"array",
    "description":"Array of JSON object elements, with one element for each recovery operation.",
    "items":{
        "$ref":"#/definitions/view-all-recoveries-recoveryList-array-item"
    }
}

Nested Schema : recoveryList Array Item

Type: object

Title: recoveryList Array Item

Show Source

dbTag(optional): string

Database Tag used if the recovery was performed using a tag.
latest(optional): string

True if the recovery was performed to the latest available backup.
recoveryCompleteDate(optional): string

The date-and-time stamp when the recovery operation completed. Applies to completed recovery operations only.
recoveryStartDate(optional): string

The date-and-time stamp when the recovery operation started. Applies to in-progress and failed recovery operations only.
scn(optional): string

SCN (System Change Number) used if the recovery was performed using an SCN.
status(optional): string

Status of the recovery operation; one of IN PROGRESS, FAILED, or COMPLETED.
timestamp(optional): string

Timestamp used if the recovery was performed using a timestamp.

{
    "title":"recoveryList Array Item",
    "type":"object",
    "properties":{
        "dbTag":{
            "type":"string",
            "description":"Database Tag used if the recovery was performed using a tag."
        },
        "latest":{
            "type":"string",
            "description":"True if the recovery was performed to the latest available backup."
        },
        "recoveryCompleteDate":{
            "type":"string",
            "description":"The date-and-time stamp when the recovery operation completed. Applies to completed recovery operations only."
        },
        "recoveryStartDate":{
            "type":"string",
            "description":"The date-and-time stamp when the recovery operation started. Applies to in-progress and failed recovery operations only."
        },
        "scn":{
            "type":"string",
            "description":"SCN (System Change Number) used if the recovery was performed using an SCN."
        },
        "status":{
            "type":"string",
            "description":"Status of the recovery operation; one of <code>IN PROGRESS</code>, <code>FAILED</code>, or <code>COMPLETED</code>."
        },
        "timestamp":{
            "type":"string",
            "description":"Timestamp used if the recovery was performed using a timestamp."
        }
    }
}

Examples

The following example shows how to view information about recovery operations 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, the Exadata Cloud Service database deployment is db12c and the Oracle Cloud user name and password are serviceadmin and Pa55_word.

cURL Command

curl -i -X GET --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample" https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c/backups/recovery/history

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: 005KB9A4pKt6uHFpR0H7id00067c0002lS
x-oracle-dms-ecid: 005KB9A4pKt6uHFpR0H7id00067c0002lS
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Mon, 29 May 2017 23:46:01 GMT
content-length: 156

Response Body

{
	"recoveryList": [{
			"recoveryStartDate": "29-May-2017 23:31:23 UTC",
			"status": "COMPLETED",
			"recoveryCompleteDate": "29-May-2017 23:44:01 UTC",
			"latest": "latest"
		}
	]
}