Jump to

• Request
• Response
• Examples

Create an IP Reservation

post

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

This endpoint is not available in accounts where regions are not supported. It is also not applicable to service instances created on Oracle Cloud Infrastructure.

Creates an IP reservation for Oracle SOA Cloud Service in the identity domain. 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

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle SOA Cloud Service account.

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle SOA Cloud Service account.

Body ()

The request body defines the IP reservation to create.

Root Schema : createipres-postrequest

Type: object

Show Source

• 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.
• region: string
  Name of the region to create the IP reservation in.

{
    "properties":{
        "ipResName":{
            "type":"string",
            "description":"Name of the IP reservation to create."
        },
        "region":{
            "type":"string",
            "description":"Name of the region to create the IP reservation in."
        },
        "networkType":{
            "type":"string",
            "description":"Indicates whether the IP reservation is for instances attached to IP networks or the shared network.<ul><li>If you intend to assign this reservation to an instance attached to an IP network, then specify <code>IPNetwork</code>.</li><li>If you intend to use this reservation for an instance attached to the shared network, then omit this parameter.</li></ul>"
        }
    },
    "required":[
        "ipResName",
        "region"
    ]
}

Back to Top

Response

202 Response

Accepted.

The Location header returns a URI that can be used to view the job status, as described in View the Status of an Operation by Job Id.

Body ()

Root Schema : createipres-response

Type: object

Show Source

• computeSite: string
  Location of the IP reservation.
• ipResName: string
  Name of the IP reservation.
• jobId: string
  Job ID of the create operation.

{
    "required":[
        "computeSite",
        "ipResName",
        "jobId"
    ],
    "properties":{
        "computeSite":{
            "type":"string",
            "description":"Location of the IP reservation."
        },
        "ipResName":{
            "type":"string",
            "description":"Name of the IP reservation."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID of the create operation."
        }
    }
}

Back to Top

Examples

The following example shows how to create an IP reservation by submitting a POST request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud account). See Send Requests.

cURL Command

curl -i -X POST -u username:Password! -d @createip.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/network/ExampleIdentityDomain/services/soa/ipreservations

Example of Request Body

The following example shows the contents of the request body in JSON format. Both attributes are mandatory.

{
    "ipResName":"ipres03",
    "region":"uscom-central-1"
}

Example of Response Header

The following example shows the response header. The Location header returns the URI that can be used to view the job status. See View the Status of an Operation by Job Id.

HTTP/1.1 202 Accepted
Date: Wed, 22 Nov 2021 21:23:23 GMT
Location: https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/1450657
Content-Type: application/json

Example of Response Body

The following example shows the response body in JSON format.

{
    "jobId":"1450657",
    "ipResName":"ipres03",
    "computeSite":"uscom-central-1"
}

Back to Top