1. REST API for Oracle Database Exadata Cloud at Customer (Gen 1/OCI-C)
  2. Tasks
  3. Manage Database Deployments

Synchronize a Database Deployment

put

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/synch

Synchronize the attributes of a database deployment to update the control plane in case outside updates were applied.

Update values such as Grid Infrastructure software version, Oracle Database software version, pluggable database name, etc.

Request

Supported Media Types
Path Parameters

  • 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-.

  • Name of the Exadata Cloud at Customer database deployment.
Header Parameters
Body ()
The request body defines the details of the request. Bold indicates a required value.
Root Schema : synch-request
Type: object
Contains the details of the synchronization request.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Accepted. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : synch-response
Type: object
Contains the details of the synchronization response.
Show Source
Nested Schema : sync-response-details
Type: object
Contains the details of the synchronization response.
Show Source
Back to Top

Examples

The following example shows how to synchronize an Exadata Cloud at Customer database deployment by submitting a PUT request on the REST endpoint using cURL.

In this example:

  • The identity domain associated with the request is usexample.

  • The user name and password for the Oracle Cloud user performing the request are serviceadmin and Pa55_word.

  • The name of the target database deployment is mydb.

cURL Command

In the following cURL command, the request body is provided in the -d option by using the @ notation to refer to the contents of the synchrequestbody.json file on the local machine. 

curl -i -X PUT -u serviceadmin:Pa55_word -H Content-Type:application/json -H Accept:application/json -d @synchrequestbody.json https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/mydb/synch

Request Body

Here is a listing of the request body, which is contained in the synchrequestbody.json file. 

{
  "action": "syncproperties",
  "DBVersion": "19.0.0.0.0",
  "gridVersion": "19.0.0.0",
  "PDBName": "PDBTest",
  "oracleHomeName": "oracleHomeTest",
  "oracleHome": "/u02/app/oracle/product/19.0.0/dbhome_1",
  "currentOSVersion": "12.2.0.0.0",
  "connectDescriptor": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(HOST=myhost.example.com)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=myhost.example.com)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=myhost.example.com)(PORT=1521)(PROTOCOL=TCP)))(CONNECT_DATA=(SERVICE_NAME=PDBTest.testoraclecloudatcust.com)))",
  "connectDescriptorWithPublicIP": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(HOST=198.51.100.26)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=198.51.100.27)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=198.51.100.28)(PORT=1521)(PROTOCOL=TCP)))(CONNECT_DATA=(SERVICE_NAME=PDBTest.testoraclecloudatcust.com)))"
}

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: 005MJGj^9dg6uHFpR0H7id0003mK0003iW
x-oracle-dms-ecid: 005MJGj^9dg6uHFpR0H7id0003mK0003iW
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Fri, 31 Jul 2020 06:05:57 GMT

Response Body

{  
"status": "New",  
"details": {
     "message": "syncproperties",
     "jobId": "10361992"
  }
}
Back to Top