View a Service Instance's Compute Nodes
/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/servers
Request
-
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.
-
serviceId: string
Name of the Database Classic Cloud Service instance.
-
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
- application/json
202 Response
array
Response Body
-
Array of:
object Response Body Array Item
Title:
Response Body Array Item
object
Response Body Array Item
-
availabilityDomain(optional):
string
Applicable only in Oracle Cloud Infrastructure regions.
Name of the availability domain within the region where the compute node is provisioned.
-
connect_descriptor(optional):
string
The connection descriptor for Oracle Net Services (SQL*Net).
-
connect_descriptor_with_public_ip(optional):
string
The connection descriptor for Oracle Net Services (SQL*Net) with IP addresses instead of host names.
-
created_by(optional):
string
The user name of the Oracle Cloud user who created the service instance.
-
creation_job_id(optional):
string
The job id of the job that created the service instance.
-
creation_time(optional):
string
The date-and-time stamp when the service instance was created.
-
hostname(optional):
string
The host name of the compute node.
-
initialPrimary(optional):
boolean
Indicates whether the compute node hosted the primary database of an Oracle Data Guard configuration when the service instance was created.
-
listenerPort(optional):
integer
The listener port for Oracle Net Services (SQL*Net) connections.
-
pdbName(optional):
string
The name of the default PDB (pluggable database) created when the service instance was created.
-
reservedIP(optional):
string
The IP address of the compute node.
-
shape(optional):
string
The Oracle Compute Cloud shape of the compute node.
-
sid(optional):
string
The SID of the database on the compute node.
-
status(optional):
string
The status of the compute node:
Configured
: the compute node has been configured.In Progress
: the compute node is being created.Maintenance
: the compute node is being stopped, started, restarted or scaled.Running
: the compute node is running.Stopped
: the compute node is stopped.Terminating
: the compute node is being deleted.
-
storageAllocated(optional):
integer
The size in MB of the storage allocated to the compute node. For compute nodes of a service instance hosting an Oracle RAC database, this number does not include the storage shared by the nodes.
-
subnet(optional):
string
Applicable only in Oracle Cloud Infrastructure regions.
Name of the subnet within the region where the compute node is provisioned.
Examples
The following example shows how to view information about the compute nodes of a Database Classic Cloud Service instance hosting an Oracle RAC database 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 service instance is db12c-xp-rac
and the Oracle Cloud user name of the user making the call is dbcsadmin
.
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/db12c-xp-rac/servers
HTTP Status Code and Response Headers
HTTP/1.1 200 OK Date: date-and-time-stamp Server: Oracle-Application-Server-11g Content-Length: 1894 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
[ { "status": "Running", "creation_job_id": "5495118", "creation_time": "Tue Jun 28 23:52:45 UTC 2016", "created_by": "dbcsadmin", "shape": "oc4", "sid": "ORCL1", "pdbName": "PDB1", "listenerPort": 1521, "connect_descriptor": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=db12c-xp-rac2)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=db12c-xp-rac1)(PORT=1521))(LOAD_BALANCE=ON)(FAILOVER=ON))(CONNECT_DATA=(SERVICE_NAME=PDB1.usexample.oraclecloud.internal)))", "connect_descriptor_with_public_ip": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=129.144.23.176)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=129.144.23.112)(PORT=1521))(LOAD_BALANCE=ON)(FAILOVER=ON))(CONNECT_DATA=(SERVICE_NAME=PDB1.usexample.oraclecloud.internal)))", "initialPrimary": true, "storageAllocated": 97280, "reservedIP": "129.144.23.112", "hostname": "db12c-xp-rac1" }, { "status": "Running", "creation_job_id": "5495118", "creation_time": "Tue Jun 28 23:52:45 UTC 2016", "created_by": "dbcsadmin", "shape": "oc4", "sid": "ORCL2", "pdbName": "PDB1", "listenerPort": 1521, "connect_descriptor": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=db12c-xp-rac2)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=db12c-xp-rac1)(PORT=1521))(LOAD_BALANCE=ON)(FAILOVER=ON))(CONNECT_DATA=(SERVICE_NAME=PDB1.usexample.oraclecloud.internal)))", "connect_descriptor_with_public_ip": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=129.144.23.176)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=129.144.23.112)(PORT=1521))(LOAD_BALANCE=ON)(FAILOVER=ON))(CONNECT_DATA=(SERVICE_NAME=PDB1.usexample.oraclecloud.internal)))", "initialPrimary": true, "storageAllocated": 97280, "reservedIP": "129.144.23.176", "hostname": "db12c-xp-rac2" } ]