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

View a Database Deployment

get

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

Returns information about an Exadata Cloud at Customer database deployment.

Request

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
Back to Top

Response

Supported Media Types

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : instance-response
Type: object
The response body contains information about the specified database deployment.
Show Source
Back to Top

Examples

The following example shows how to view detailed information about 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, the Exadata Cloud at Customer 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

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-origin: *
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: 005KA6qEAoM6uHFpR05Eid0007dd00000I
x-oracle-dms-ecid: 005KA6qEAoM6uHFpR05Eid0007dd00000I
service-uri: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db12c
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Mon, 29 May 2017 03:59:21 GMT
content-length: 2749

Response Body

{
  "service_name": "db12c",
  "version": "12.1.0.2",
  "status": "Running",
  "description": "Example Exadata Cloud at Customer database deployment created using REST API",
  "identity_domain": "usexample",
  "creation_time": "2017-05-29T01:48:26.563+0000",
  "last_modified_time": "2017-05-29T01:48:26.543+0000",
  "created_by": "serviceadmin",
  "sm_plugin_version": "17.2.3-539",
  "tools_version": "17.2.3-539",
  "backup_supported_version": "16.1.5",
  "service_uri": "https:\/\/dbaas.oraclecloud.com:443\/paas\/service\/dbcs\/api\/v1.1\/instances\/usexample\/db12c",
  "database_id": "0",
  "num_nodes": 2,
  "level": "PAAS_EXADATA",
  "edition": "EE_EP",
  "subscriptionType": "MONTHLY",
  "creation_job_id": "12209047",
  "num_ip_reservations": 2,
  "backup_destination": "OSS",
  "cloud_storage_container": "Storage-usexample\/ExaCSbackups",
  "cloud_storage_pass": "Pa55_word",
  "cloud_storage_user": "serviceadmin",
  "failover_database": false,
  "rac_database": true,
  "current_version": "12.1.0.2.161018",
  "sid": "DB12C",
  "pdbName": "DB12CP1",
  "demoPdb": "",
  "listenerPort": 1521,
  "em_url": "https:\/\/192.168.214.130:5502\/em",
  "connect_descriptor": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(HOST=192.168.214.134)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.135)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.136)(PORT=1521)(PROTOCOL=TCP)))(CONNECT_DATA=(SERVICE_NAME=DB12CP1.us2.oraclecloud.com)))",
  "connect_descriptor_with_public_ip": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(HOST=192.168.214.134)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.135)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.136)(PORT=1521)(PROTOCOL=TCP)))(CONNECT_DATA=(SERVICE_NAME=DB12CP1.us2.oraclecloud.com)))",
  "glassfish_url": "",
  "charset": "AL32UTF8",
  "ncharset": "AL16UTF16",
  "is_clone": false,
  "clone_supported_version": "17.2.1",
  "total_shared_storage": 0,
  "service_associations": [],
  "subscription_name": "exasys",
  "snapshot_service": false,
  "cluster_names": "exasys-00a",
  "networking_info": {
    "scan_ips": [
      "192.168.214.134",
      "192.168.214.135",
      "192.168.214.136"
    ],
    "admin_network": "192.168.214.160\/28",
    "backup_network": "192.168.214.176\/28",
    "client_network": "192.168.214.128\/27",
    "computes": [
      {
        "hostname": "node01.us2.oraclecloud.com",
        "client_ip": "192.168.214.130",
        "virtual_ip": "192.168.214.131",
        "admin_ip": "192.168.214.162"
      },
      {
        "hostname": "node02.us2.oraclecloud.com",
        "client_ip": "192.168.214.132",
        "virtual_ip": "192.168.214.133",
        "admin_ip": "192.168.214.163"
      }
    ]
  },
  "jaas_instances_using_service": ""
}
Back to Top