Create an IP Reservation
/paas/api/v1.1/network/{identityDomainId}/services/dbaas/ipreservations
Creates an IP reservation for Database Classic Cloud Service.
Only one IP reservation can be created at a time. If a create activity is already in progress, you cannot initiate another create request.
Request
- application/json
-
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.
-
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.
object
Request Body
-
ipResName:
string
Name of the IP reservation to create.
-
networkType(optional):
string
Indicates whether the IP reservation is for instances attached to IP networks or the shared network.
- If you intend to assign this reservation to an instance attached to an IP network, then specify
IPNetwork
. - If you intend to use this reservation for an instance attached to the shared network, then omit this parameter.
- If you intend to assign this reservation to an instance attached to an IP network, then specify
-
region:
string
Name of the region to create the IP reservation in.
Response
202 Response
-
Location: string
A REST URI you can use to check the progress and completion of the IP reservation creation operation.
object
Response Body
-
computeSite(optional):
string
Location (region) of the IP reservation.
-
ipResName(optional):
string
Name of the IP reservation.
-
jobId(optional):
string
Job ID of the creation operation.
Examples
The following example shows how to create an IP reservation for Database Classic Cloud Service by submitting a POST 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
.
Note that the request body containing the ipResName
, region
and networkType
parameters is provided in the cURL command's --data
option.
Also note that the Location
response header provides a URI you can do a GET on to track completion of the creation operation.
cURL Command
curl --include --request POST \ --user dbcsadmin:password \ --header "X-ID-TENANT-NAME:idcs-270644901b..." \ --header "Content-Type: application/json" \ --data '{"ipResName":"ipResViaRest","region":"uscom-central-1","networkType":"IPNetwork"}' \ https://psm.us.oraclecloud.com/paas/api/v1.1/network/idcs-270644901b.../services/dbaas/ipreservations
HTTP Status Code and Response Headers
HTTP/1.0 200 Connection established HTTP/1.1 202 Accepted Server: Oracle-Application-Server-11g Strict-Transport-Security: max-age=31536000;includeSubDomains Location: https://psm.us.oraclecloud.com:443/paas/api/v1.1/activitylog/idcs-270644901b.../job/27058213 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 Connection: close
Response Body
{ "jobId": "27058213", "ipResName": "ipResViaRest", "computeSite": "uscom-central-1" }