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

View All Database Deployments

get

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

Returns information about all database deployments in an identity domain.

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

Query Parameters
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 : allinstances-response
Type: object
The response body contains information about database deployments.
Show Source
Back to Top

Examples

The following example shows how to view information about all Exadata Cloud at Customer database deployments 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 serviceadmin and Pa55_word. The response shows two running deployments, db12c and starter12c.

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

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: 005KA6tOaMj6uHFpR05Eid0007dd00000j
x-oracle-dms-ecid: 005KA6tOaMj6uHFpR05Eid0007dd00000j
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Mon, 29 May 2017 04:00:14 GMT
content-length: 1611

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",
			"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"
		}, {
			"service_name": "starter12c",
			"version": "12.2.0.1",
			"status": "Running",
			"description": "Starter database. Oracle Database 12c Release 2.",
			"identity_domain": "usexample",
			"creation_time": "2017-05-10T23:26:04.275+0000",
			"last_modified_time": "2017-05-10T23:26:04.253+0000",
			"created_by": "serviceadmin",
			"sm_plugin_version": "17.2.3-537",
			"tools_version": "17.2.3-537",
			"backup_supported_version": "16.1.5",
			"service_uri": "https:\/\/dbaas.oraclecloud.com:443\/paas\/service\/dbcs\/api\/v1.1\/instances\/usexample\/starter12c",
			"database_id": "0"
		}
	],
	"subscriptions": [{
			"subscriptionId": "4E34F6442616F4CAE050C10A169415E5",
			"name": "exasys",
			"isTrial": "false",
			"exadata_system_name": "exasys",
			"exadata_backup_to_disk": "true",
			"size": "QUARTER",
			"starter_db_created": "true",
			"snapClone_enabled": "true",
			"hostClusters": [{
					"clusterName": "exasys-00a",
					"hostNames": ["node01.us2.oraclecloud.com", "node02.us2.oraclecloud.com"]
				}
			]
		}
	]
}
Back to Top