View All Service Instances

get

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

Returns information about all Database Cloud Service instances. You can view the full set of details by specifying the ?outputLevel=verbose query parameter.

Request

Path Parameters
identityDomainId
Type: string
Required: true
Name of the identity domain for the Database Cloud Service account.
Query Parameters
outputLevel
Type: boolean
Flag that when set to verbose specifies that the response should include the full set of details for all service instances.
Header Parameters
Authorization
Type: string
Required: true
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
Type: string
Required: true
Name of the identity domain for the Database Cloud Service account. For more information, see Security, Authentication and Authorization.

Response

Supported Media Types
  • application/json
202 Response
Accepted. See Status Codes for information about other possible HTTP status codes.
Body
Root Schema : Response Body
Type: object
Title: Response Body
Nested Schema : services Array
Type: array
Title: services Array
Array of JSON object elements, with one element for each service instance in the identity domain.
Nested Schema : services Array Item
Type: object
Title: services Array Item

Examples

The following example shows how to view information about all Database Cloud Service instances 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 dbaasadmin and Pa55_word. The response shows two running services, db12c-xp-si and db12c-xp-rac.

cURL Command

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

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: Wed, 29 Jun 2016 01:07:10 GMT
Server: Oracle-Application-Server-11g
Content-Length: 1182
X-ORACLE-DMS-ECID: 005Da1VXSRo6uHFpR0H7id0003kQ0000Q3
X-ORACLE-DMS-ECID: 005Da1VXSRo6uHFpR0H7id0003kQ0000Q3
X-Frame-Options: DENY
Vary: Accept-Encoding,User-Agent
Content-Language: en
Content-Type: application/json

Response Body

{
  "uri":"https:\/\/dbaas.oraclecloud.com:443\/paas\/service\/dbcs\/api\/v1.1\/instances\/usexample",
  "service_type":"dbaas",
  "implementation_version":"1.0",
  "services":[
    {
      "service_name":"db12c-xp-si",
      "version":"12.1.0.2",
      "status":"Running",
      "description":"Example service instance",
      "identity_domain":"usexample",
      "creation_time":"Tue Jun 21 17:2:56 UTC 2016",
      "last_modified_time":"Tue Jun 21 17:2:55 UTC 2016",
      "created_by":"dbaasadmin",
      "sm_plugin_version":"16.2.5-125",
      "backup_supported_version":"16.2.3",
      "service_uri":"https:\/\/dbaas.oraclecloud.com:443\/paas\/service\/dbcs\/api\/v1.1\/instances\/usexample\/db12c-xp-si"
    },
    {
      "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":"dbaasadmin",
      "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"
}
],
"subscriptions":[]
}