Jump to

• Request
• Response
• Examples

View Compute Nodes

get

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

Returns information about the compute nodes associated with an Exadata Cloud Service database deployment.

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.

• serviceId: string
  Name of the Exadata Cloud Service database deployment.

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 : instance-response

Type: object

The response body contains information about the specified database deployment.

Show Source

• charset(optional): string
  The Character Set for the database deployment.
• 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.
• 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.
• 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.
• error_status_desc(optional): string
  A description of the reason why a database deployment is in an error state.
• goldenGate(optional): string
  Identifies if the database deployment is configured for use as the replication database of an Oracle GoldenGate Cloud Service instance.
• 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.
• 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.

• ncharset(optional): string
  The National Character Set for the database deployment.
• num_nodes(optional): integer
  The number of compute nodes associated with the database deployment.
• psm_plugin_version(optional): string
  The Platform Service Manager version associated with the database deployment.
• 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.

• version(optional): string
  The Oracle Database software version in use.

{
    "description":"The response body contains information about the specified database deployment.",
    "properties":{
        "created_by":{
            "type":"string",
            "description":"Name of the Oracle Cloud user who created the database deployment."
        },
        "creation_job_id":{
            "type":"string",
            "description":"The job ID for the job that created the database deployment."
        },
        "creation_time":{
            "type":"string",
            "description":"The database deployment creation date and time."
        },
        "deletion_job_id":{
            "type":"integer",
            "description":"The job ID for the job that deleted the database deployment."
        },
        "description":{
            "type":"string",
            "description":"The database deployment description."
        },
        "edition":{
            "type":"string",
            "description":"The Oracle Database software edition. For Exadata Cloud Service the value is always <code>EE_EP</code>."
        },
        "error_status_desc":{
            "type":"string",
            "description":"A description of the reason why a database deployment is in an error state."
        },
        "identity_domain":{
            "type":"string",
            "description":"The identity domain associated with the database deployment."
        },
        "last_modified_time":{
            "type":"string",
            "description":"The date and time of last modification."
        },
        "level":{
            "type":"string",
            "description":"The service level. For Exadata Cloud Service the value is always <code>PAAS_EXADATA</code>."
        },
        "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>"
        },
        "num_nodes":{
            "type":"integer",
            "description":"The number of compute nodes associated with the database deployment."
        },
        "psm_plugin_version":{
            "type":"string",
            "description":"The Platform Service Manager version associated with the database deployment."
        },
        "service_name":{
            "type":"string",
            "description":"Name of the database deployment."
        },
        "service_url":{
            "type":"string",
            "description":"The resource URL for the database deployment."
        },
        "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>"
        },
        "subscription_type":{
            "type":"string",
            "description":"<p>The billing frequency.</p><p>For Exadata Cloud Service the value is always <code>MONTHLY</code>.</p>"
        },
        "version":{
            "type":"string",
            "description":"The Oracle Database software version in use."
        },
        "goldenGate":{
            "type":"string",
            "description":"Identifies if the database deployment is configured for use as the replication database of an Oracle GoldenGate Cloud Service instance."
        },
        "ncharset":{
            "type":"string",
            "description":"The National Character Set for the database deployment."
        },
        "charset":{
            "type":"string",
            "description":"The Character Set for the database deployment."
        }
    }
}

Back to Top

Examples

The following example shows how to view information about the compute nodes associated with an Exadata Cloud Service database deployment by submitting a GET request on the REST endpoint using cURL.

In this example, the identity domain is usexample, the Exadata Cloud Service database deployment is db12c and the Oracle Cloud user name and password are serviceadmin and Pa55_word.

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/db12c/servers

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

Response Body

[
  {
    "status": "Running",
    "creation_job_id": "12209047",
    "creation_time": "2017-05-29T01:48:26.563+0000",
    "created_by": "serviceadmin",
    "sid": "DB12C1",
    "pdbName": "DB12CP1",
    "listenerPort": 1521,
    "connect_descriptor": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(HOST=192.168.214.134)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.135)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.136)(PORT=1521)(PROTOCOL=TCP)))(CONNECT_DATA=(SERVICE_NAME=DB12CP1.us2.oraclecloud.com)))",
    "connect_descriptor_with_public_ip": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(HOST=192.168.214.134)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.135)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.136)(PORT=1521)(PROTOCOL=TCP)))(CONNECT_DATA=(SERVICE_NAME=DB12CP1.us2.oraclecloud.com)))",
    "initialPrimary": true,
    "storageAllocated": "21",
    "reservedIP": "192.168.214.130",
    "hostname": "node01.us2.oraclecloud.com",
    "vmType": "EXADATA",
    "numberOfCores": "11",
    "memoryAllocated": "720"
  },
  {
    "status": "Running",
    "creation_job_id": "12209047",
    "creation_time": "2017-05-29T01:48:26.563+0000",
    "created_by": "serviceadmin",
    "sid": "DB12C2",
    "pdbName": "DB12CP1",
    "listenerPort": 1521,
    "connect_descriptor": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(HOST=192.168.214.134)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.135)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.136)(PORT=1521)(PROTOCOL=TCP)))(CONNECT_DATA=(SERVICE_NAME=DB12CP1.us2.oraclecloud.com)))",
    "connect_descriptor_with_public_ip": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(HOST=192.168.214.134)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.135)(PORT=1521)(PROTOCOL=TCP))(ADDRESS=(HOST=192.168.214.136)(PORT=1521)(PROTOCOL=TCP)))(CONNECT_DATA=(SERVICE_NAME=DB12CP1.us2.oraclecloud.com)))",
    "initialPrimary": true,
    "storageAllocated": "21",
    "reservedIP": "192.168.214.132",
    "hostname": "node02.us2.oraclecloud.com",
    "vmType": "EXADATA",
    "numberOfCores": "11",
    "memoryAllocated": "720"
  }
]

Back to Top