View All IP Reservations
/paas/api/v1.1/network/{identityDomainId}/services/dbaas/ipreservations
Returns information about the IP reservations created for Database Classic Cloud Service in the given identity domain. Both used and unused IP reservations are returned.
Use the optional ?networkType
query parameter to get details of all the IP reservations or only those that can be assigned to instances associated with IP networks.
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.
-
networkType(optional): string
Allowed values (case-sensitive):
ALL
: Get details of all the IP reservations.IPNetwork
: Get details of only those IP reservations that can be assigned to instances attached to IP networks.
-
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
200 Response
object
Response Body
-
activities(optional):
array activities Array
Title:
activities Array
Array of JSON object elements, with one element for each ongoing or failed activity log entry related to IP reservations. -
ipReservations(optional):
array ipReservations Array
Title:
ipReservations Array
Array of JSON object elements, with one element for each IP reservation.
array
activities Array
-
Array of:
object activities Array Item
Title:
activities Array Item
array
ipReservations Array
-
Array of:
object ipReservations Array Item
Title:
ipReservations Array Item
object
activities Array Item
-
activity(optional):
array activity
Array of JSON object elements, with one element for each item of an ongoing or failed activity log entry related to IP reservations.
array
-
Array of:
object activity Array Item
Title:
activity Array Item
object
activity Array Item
-
errors(optional):
string
Error encountered for an ongoing or failed activity.
-
message(optional):
string
Message of an ongoing or failed activity.
object
ipReservations Array Item
-
computeSiteName(optional):
string
Location (region) of the IP reservation.
-
creationTime(optional):
string
Date and time the IP reservatione was created.
-
hostName(optional):
string
Name of the compute node using the IP reservation. This parameter is returned only when the IP reservation is in use.
-
id(optional):
string
Id of the IP reservation.
-
identityDomain(optional):
string
The identity domain ID of the IP reservation.
-
ipAddress(optional):
string
The public IP address for the IP reservation.
-
name(optional):
string
Name of the IP reservation.
-
networkType(optional):
string
Indicates whether the IP reservation is intended for instances attached to IP networks or the shared network.
-
serviceEntitlementId(optional):
string
The service entitlement Id of Database Classic Cloud Service within the Cloud account.
-
serviceName(optional):
string
Name of the Database Classic Cloud Service instance where the named IP reservation is used. This parameter is returned only when the IP reservation is in use.
-
serviceType(optional):
string
The value
DBaaS
. -
status(optional):
string
Status of the IP reservation. Valid values:
INITIALIZING
,UNUSED
,USED
.
Examples
The following example shows how to view details about IP reservations created for Database Cloud Service by submitting a GET request on the REST endpoint using cURL.
This example uses a cloud account with Identity Cloud Service, so the {identityDomainId}
path parameter and the X-ID-TENANT-NAME
header parameter are set to the account's identity service ID, which begins with idcs-270644901b
. The Oracle Cloud user name of the user making the call is dbcsadmin
. The request includes the networkType
query parameter to get details about all IP reservations.
cURL Command
curl --include --request GET \ --user dbcsadmin:password \ --header "X-ID-TENANT-NAME:idcs-270644901b..." \ https://psm.us.oraclecloud.com/paas/api/v1.1/network/idcs-270644901b.../services/dbaas/ipreservations\?networkType=ALL
HTTP Status Code and Response Headers
HTTP/1.0 200 Connection established HTTP/1.1 200 OK Server: Oracle-Application-Server-11g Strict-Transport-Security: max-age=31536000;includeSubDomains X-ORACLE-DMS-ECID: id-string X-ORACLE-DMS-ECID: id-string X-Frame-Options: DENY Content-Language: en Content-Type: application/json Vary: user-agent Date: date-and-time-stamp Content-Length: 605 Connection: keep-alive
Response Body
{ "ipReservations": [ { "id": 10653, "name": "ipnetres", "networkType": "IPNetwork", "ipAddress": "129.150.102.54", "status": "UNUSED", "identityDomain": "idcs-270644901b...", "serviceType": "DBaaS", "computeSiteName": "uscom-central-1", "serviceEntitlementId": "596600480", "creationTime": "2018-04-24T01:01:10.157+0000" }, { "id": 9016, "name": "sharedres", "ipAddress": "129.150.82.74", "status": "UNUSED", "identityDomain": "idcs-270644901b...", "serviceType": "DBaaS", "computeSiteName": "uscom-central-1", "serviceEntitlementId": "596600480", "creationTime": "2018-03-16T16:45:56.649+0000" } ], "activities": [ ] }