1. REST API for Oracle Database Classic Cloud Service
  2. Tasks
  3. Service Instances

View a Service Instance

get

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

Returns information about a Database Classic Cloud Service instance.

Request

Path Parameters
  • Identity domain ID for the Database Classic Cloud Service account:
     

    • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

    • For a traditional cloud account: the name of the identity domain.

  • Name of the Database Classic Cloud Service instance.
Header Parameters
  • Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
  • Identity domain ID for the Database Classic Cloud Service account:
     

    • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

    • For a traditional cloud account: the name of the identity domain.

Back to Top

Response

Supported Media Types

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : Response Body
Type: object
Title: Response Body
Show Source
Back to Top

Examples

The following example shows how to view detailed information about a Database Classic Cloud Service instance by submitting a GET request on the REST endpoint using cURL.

This example uses a traditional cloud account, so the {identityDomainId} path parameter and the X-ID-TENANT-NAME header parameter are set to the account's domain name, which is usexample. The service instance is db12c-xp-rac and the Oracle Cloud user name of the user making the call is dbcsadmin.

cURL Command

$ curl --include --request GET \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c-xp-rac

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Content-Length: 1890
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
X-Frame-Options: DENY
Service-URI: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db12c-xp-rac
Vary: Accept-Encoding,User-Agent
Content-Language: en
Content-Type: application/json

Response Body

{
  "service_name": "db12c-xp-rac",
  "version": "12.1.0.2",
  "status": "Running",
  "description": "Example service instance",
  "identity_domain": "usexample",
  "creation_time": "Tue Jun 28 23:52:45 UTC 2016",
  "last_modified_time": "Tue Jun 28 23:52:45 UTC 2016",
  "created_by": "dbcsadmin",
  "sm_plugin_version": "16.2.5-125",
  "backup_supported_version": "16.1.5",
  "service_uri": "https:\/\/dbaas.oraclecloud.com:443\/paas\/service\/dbcs\/api\/v1.1\/instances\/usexample\/db12c-xp-rac",
  "num_nodes": 2,
  "level": "PAAS",
  "edition": "EE_EP",
  "shape": "oc4",
  "subscriptionType": "MONTHLY",
  "creation_job_id": "5495118",
  "num_ip_reservations": 2,
  "backup_destination": "BOTH",
  "cloud_storage_container": "Storage-usexample\/dbcsbackups",
  "failover_database": false,
  "rac_database": true,
  "current_version": "12.1.0.2.160119",
  "sid": "ORCL",
  "pdbName": "PDB1",
  "listenerPort": 1521,
  "timezone": "UTC",
  "em_url": "https:\/\/129.144.23.112:5500\/em",
  "connect_descriptor": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=db12c-xp-rac2)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=db12c-xp-rac1)(PORT=1521))(LOAD_BALANCE=ON)(FAILOVER=ON))(CONNECT_DATA=(SERVICE_NAME=PDB1.usexample.oraclecloud.internal)))",
  "connect_descriptor_with_public_ip": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=129.144.23.176)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=129.144.23.112)(PORT=1521))(LOAD_BALANCE=ON)(FAILOVER=ON))(CONNECT_DATA=(SERVICE_NAME=PDB1.usexample.oraclecloud.internal)))",
  "apex_url": "https:\/\/129.144.23.112\/apex\/pdb1\/",
  "glassfish_url": "",
  "dbaasmonitor_url": "https:\/\/129.144.23.112\/dbaas_monitor",
  "charset": "AL32UTF8",
  "ncharset": "AL16UTF16",
  "total_shared_storage": 95232,
  "compute_site_name": "US006_Z25",
  "jaas_instances_using_service": ""
}
Back to Top