1. REST API for Oracle Database Classic Cloud Service
  2. Tasks
  3. IP Reservations

View All IP Reservations

get

/paas/api/v1.1/network/{identityDomainId}/services/dbaas/ipreservations

This endpoint is available only in Cloud accounts that support Oracle Cloud Infrastructure Classic regions. Additionally, It is not applicable to Oracle Cloud Infrastructure.

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

Path Parameters
  • 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
  • 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.
    If you omit this parameter, details about IP reservations that can be assigned to the shared network are returned.
Header Parameters
  • Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
  • 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.

Back to Top

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : Response Body
Type: object
Title: Response Body
Show Source
Nested Schema : activities Array
Type: array
Title: activities Array
Array of JSON object elements, with one element for each ongoing or failed activity log entry related to IP reservations.
Show Source
Nested Schema : ipReservations Array
Type: array
Title: ipReservations Array
Array of JSON object elements, with one element for each IP reservation.
Show Source
Nested Schema : activities Array Item
Type: object
Title: activities Array Item
Show Source
Nested Schema : activity
Type: array
Array of JSON object elements, with one element for each item of an ongoing or failed activity log entry related to IP reservations.
Show Source
Nested Schema : activity Array Item
Type: object
Title: activity Array Item
Show Source
Nested Schema : ipReservations Array Item
Type: object
Title: ipReservations Array Item
Show Source
Back to Top

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": [
    
  ]
}
Back to Top