Jump to

• Request
• Response
• Examples

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

• identityDomainId: string

  The value depends on the type of Exadata Cloud Service 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 has the format idcs-letters-and-numbers.

Query Parameters

• outputLevel(optional): boolean
  Set this parameter to verbose to generate a response that contains the full set of details for all database deployments.

Header Parameters

• Authorization: string
  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: string

  The value depends on the type of Exadata Cloud Service 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 has the format idcs-letters-and-numbers.

  For more information, see Security, Authentication and Authorization.

Back to Top

Response

Supported Media Types

• application/json

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

• created_by(optional): string
  Name of the Oracle Cloud user who created the database deployment.
• creation_job_id(optional): string

  The job ID for the job that created the database deployment.

  This attribute is returned when you set the ?outputLevel=verbose query parameter.

• creation_time(optional): string
  The database deployment creation date and time.
• deletion_job_id(optional): integer

  The job ID for the job that deleted the database deployment.

  This attribute is returned when you set the ?outputLevel=verbose query parameter.

• description(optional): string
  The database deployment description.
• edition(optional): string

  The Oracle Database software edition.

  For Exadata Cloud Service the value is always EE_EP.

  This attribute is returned when you set the ?outputLevel=verbose query parameter.

• identity_domain(optional): string
  The identity domain associated with the database deployment.
• last_modified_time(optional): string
  The date and time of last modification.
• level(optional): string

  The service level.

  For Exadata Cloud Service the value is always PAAS_EXADATA.

  This attribute is returned when you set the ?outputLevel=verbose query parameter.

• lifecycle_control_job_id(optional): integer

  The job ID of a compute node lifecycle state control operation (start, stop or restart a compute node).

  This attribute appears only if an operation is in progress.

  You can use this ID to check the status of the operation, as described in View the Status of an Operation.

  This attribute is returned when you set the ?outputLevel=verbose query parameter.

• num_nodes(optional): integer

  The number of compute nodes associated with the database deployment.

  This attribute is returned when you set the ?outputLevel=verbose query parameter.

• service_name(optional): string
  Name of the database deployment.
• service_url(optional): string
  The resource URL for the database deployment.
• status(optional): string

  The database deployment status.

  Values include: Running, In Progress, Maintenance, Stopped, Terminating, and Failed.

• subscription_type(optional): string

  The billing frequency.

  For Exadata Cloud Service the value is always MONTHLY.

  This attribute is returned when you set the ?outputLevel=verbose query parameter.

• uri(optional): string
  The URL for the REST resource.
• version(optional): string
  The Oracle Database software version in use.

{
    "description":"The response body contains information about database deployments.",
    "properties":{
        "service_name":{
            "type":"string",
            "description":"Name of the database deployment."
        },
        "identity_domain":{
            "type":"string",
            "description":"The identity domain associated with the database deployment."
        },
        "description":{
            "type":"string",
            "description":"The database deployment description."
        },
        "status":{
            "type":"string",
            "description":"<p>The database deployment status.</p><p>Values include: <code>Running</code>, <code>In Progress</code>, <code>Maintenance</code>, <code>Stopped</code>, <code>Terminating</code>, and <code>Failed</code>.</p>"
        },
        "version":{
            "type":"string",
            "description":"The Oracle Database software version in use."
        },
        "creation_time":{
            "type":"string",
            "description":"The database deployment creation date and time."
        },
        "last_modified_time":{
            "type":"string",
            "description":"The date and time of last modification."
        },
        "created_by":{
            "type":"string",
            "description":"Name of the Oracle Cloud user who created the database deployment."
        },
        "subscription_type":{
            "type":"string",
            "description":"<p>The billing frequency.</p><p>For Exadata Cloud Service the value is always <code>MONTHLY</code>.</p><p>This attribute is returned when you set the <code>?outputLevel=verbose</code> query parameter.</p>"
        },
        "level":{
            "type":"string",
            "description":"<p>The service level.</p><p>For Exadata Cloud Service the value is always <code>PAAS_EXADATA</code>.</p><p>This attribute is returned when you set the <code>?outputLevel=verbose</code> query parameter.</p>"
        },
        "edition":{
            "type":"string",
            "description":"<p>The Oracle Database software edition.</p><p>For Exadata Cloud Service the value is always <code>EE_EP</code>.</p><p>This attribute is returned when you set the <code>?outputLevel=verbose</code> query parameter.</p>"
        },
        "num_nodes":{
            "type":"integer",
            "description":"<p>The number of compute nodes associated with the database deployment.</p><p>This attribute is returned when you set the <code>?outputLevel=verbose</code> query parameter.</p>"
        },
        "creation_job_id":{
            "type":"string",
            "description":"<p>The job ID for the job that created the database deployment.</p><p>This attribute is returned when you set the <code>?outputLevel=verbose</code> query parameter.</p>"
        },
        "deletion_job_id":{
            "type":"integer",
            "description":"<p>The job ID for the job that deleted the database deployment.</p><p>This attribute is returned when you set the <code>?outputLevel=verbose</code> query parameter.</p>"
        },
        "lifecycle_control_job_id":{
            "type":"integer",
            "description":"<p>The job ID of a compute node lifecycle state control operation (start, stop or restart a compute node).</p><p>This attribute appears only if an operation is in progress.</p><p>You can use this ID to check the status of the operation, as described in <a href='op-paas-service-dbcs-api-v1.1-instances-identitydomainid-status-requestname-job-jobid-get.html'>View the Status of an Operation</a>.</p><p>This attribute is returned when you set the <code>?outputLevel=verbose</code> query parameter.</p>"
        },
        "service_url":{
            "type":"string",
            "description":"The resource URL for the database deployment."
        },
        "uri":{
            "type":"string",
            "description":"The URL for the REST resource."
        }
    }
}

Back to Top

Examples

The following example shows how to view information about all Exadata Cloud Service 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 Service 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