REST API for Oracle Database Classic Cloud Service

View All Service Instances

get

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

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

Request

Path Parameters

identityDomainId: string
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.

Query Parameters

outputLevel(optional): 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: 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
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.

Response

Supported Media Types

application/json

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.

Root Schema : Response Body

Type: object

Title: Response Body

Show Source

implementation_version(optional): string

The value 1.0.
service_type(optional): string

The value dbaas to denote Database Classic Cloud Service.
services(optional): array services Array

Title: services Array

Array of JSON object elements, with one element for each service instance in the identity domain.
uri(optional): string

REST endpoint URI for Database Classic Cloud Service in the identity domain.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "uri":{
            "type":"string",
            "description":"REST endpoint URI for Database Classic Cloud Service in the identity domain."
        },
        "service_type":{
            "type":"string",
            "description":"The value <code>dbaas</code> to denote Database Classic Cloud Service."
        },
        "implementation_version":{
            "type":"string",
            "description":"The value <code>1.0</code>."
        },
        "services":{
            "title":"services Array",
            "type":"array",
            "description":"Array of JSON object elements, with one element for each service instance in the identity domain.",
            "items":{
                "$ref":"#/definitions/view-all-instances-services-array-item"
            }
        }
    }
}

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.

Show Source

Array of: object services Array Item

Title: services Array Item

{
    "title":"services Array",
    "type":"array",
    "description":"Array of JSON object elements, with one element for each service instance in the identity domain.",
    "items":{
        "$ref":"#/definitions/view-all-instances-services-array-item"
    }
}

Nested Schema : services Array Item

Type: object

Title: services Array Item

Show Source

backup_supported_version(optional): string

The version of cloud tooling for backup and recovery supported by the service instance.
created_by(optional): string

The user name of the Oracle Cloud user who created the service instance.
creation_time(optional): string

The date-and-time stamp when the service instance was created.
description(optional): string

The description of the service instance, if one was provided when the instance was created.
identity_domain(optional): string

The identity domain housing the service instance.
last_modified_time(optional): string

The date-and-time stamp when the service instance was last modified.
service_name(optional): string

The name of the service instance.
service_uri(optional): string

The REST endpoint URI of the service instance.
sm_plugin_version(optional): string

The version of the cloud tooling service manager plugin supported by the service instance.
status(optional): string
The status of the service instance:
- Configured: the service instance has been configured.
- In Progress: the service instance is being created.
- Maintenance: the service instance is being stopped, started, restarted or scaled.
- Running: the service instance is running.
- Stopped: the service instance is stopped.
- Terminating: the service instance is being deleted.
version(optional): string

The Oracle Database version on the service instance.

{
    "title":"services Array Item",
    "type":"object",
    "properties":{
        "backup_supported_version":{
            "type":"string",
            "description":"The version of cloud tooling for backup and recovery supported by the service instance."
        },
        "created_by":{
            "type":"string",
            "description":"The user name of the Oracle Cloud user who created the service instance."
        },
        "creation_time":{
            "type":"string",
            "description":"The date-and-time stamp when the service instance was created."
        },
        "description":{
            "type":"string",
            "description":"The description of the service instance, if one was provided when the instance was created."
        },
        "identity_domain":{
            "type":"string",
            "description":"The identity domain housing the service instance."
        },
        "last_modified_time":{
            "type":"string",
            "description":"The date-and-time stamp when the service instance was last modified."
        },
        "service_name":{
            "type":"string",
            "description":"The name of the service instance."
        },
        "service_uri":{
            "type":"string",
            "description":"The REST endpoint URI of the service instance."
        },
        "sm_plugin_version":{
            "type":"string",
            "description":"The version of the cloud tooling service manager plugin supported by the service instance."
        },
        "status":{
            "type":"string",
            "description":"The status of the service instance:<ul><li><code>Configured</code>: the service instance has been configured.</li><li><code>In Progress</code>: the service instance is being created.</li><li><code>Maintenance</code>: the service instance is being stopped, started, restarted or scaled.</li><li><code>Running</code>: the service instance is running.</li><li><code>Stopped</code>: the service instance is stopped.</li><li><code>Terminating</code>: the service instance is being deleted.</li></ul>"
        },
        "version":{
            "type":"string",
            "description":"The Oracle Database version on the service instance."
        }
    }
}

Examples

The following example shows how to view information about all Database Classic Cloud Service instances 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 Oracle Cloud user name of the user making the call is dbcsadmin. The response shows two running services, db12c-xp-si and db12c-xp-rac.

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

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Content-Length: 1182
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
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":"dbcsadmin",
      "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":"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"
}
],
"subscriptions":[]
}