Jump to

• Request
• Response
• Examples

View All IP Reservations

get

/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.

Returns information about all IP reservations defined for Oracle SOA Cloud Service in the given identity domain. Both used and unused IP reservations are returned.

Request

Path Parameters

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

Query Parameters

• 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.

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ipres-response

Type: object

The response body contains information about used and unused IP reservations.

Show Source

• activities: array activities
  Groups details about ongoing and failed activity messages, if available.
• ipReservations: array ipReservations
  Groups all IP reservations.

{
    "required":[
        "ipReservations",
        "activities"
    ],
    "description":"The response body contains information about used and unused IP reservations.",
    "properties":{
        "ipReservations":{
            "type":"array",
            "description":"Groups all IP reservations.",
            "items":{
                "$ref":"#/definitions/ipreservations"
            }
        },
        "activities":{
            "type":"array",
            "description":"Groups details about ongoing and failed activity messages, if available.",
            "items":{
                "$ref":"#/definitions/ipreservations-activities"
            }
        }
    }
}

Nested Schema : activities

Type: array

Groups details about ongoing and failed activity messages, if available.

Show Source

• Array of: object ipreservations-activities

{
    "type":"array",
    "description":"Groups details about ongoing and failed activity messages, if available.",
    "items":{
        "$ref":"#/definitions/ipreservations-activities"
    }
}

Nested Schema : ipReservations

Type: array

Groups all IP reservations.

Show Source

• Array of: object ipreservations

{
    "type":"array",
    "description":"Groups all IP reservations.",
    "items":{
        "$ref":"#/definitions/ipreservations"
    }
}

Nested Schema : ipreservations-activities

Type: object

Show Source

• activity(optional): array activity
  Groups messages and errors for ongoing and failed activities.

{
    "properties":{
        "activity":{
            "type":"array",
            "description":"Groups messages and errors for ongoing and failed activities.",
            "items":{
                "$ref":"#/definitions/message-errors"
            }
        }
    }
}

Nested Schema : activity

Type: array

Groups messages and errors for ongoing and failed activities.

Show Source

• Array of: object message-errors

{
    "type":"array",
    "description":"Groups messages and errors for ongoing and failed activities.",
    "items":{
        "$ref":"#/definitions/message-errors"
    }
}

Nested Schema : message-errors

Type: object

Show Source

• errors(optional): string
  Error encountered for an ongoing or failed activity.
• message(optional): string
  Message of an ongoing or failed activity.

{
    "properties":{
        "errors":{
            "type":"string",
            "description":"Error encountered for an ongoing or failed activity."
        },
        "message":{
            "type":"string",
            "description":"Message of an ongoing or failed activity."
        }
    }
}

Nested Schema : ipreservations

Type: object

Show Source

• accountId(optional): string
  The identity domain ID and service type of the service. For example, myidentitydomain_SOA, where SOA is the service type of Oracle SOA Cloud Service.
• computeSiteName(optional): string
  Location of the IP reservation.
• creationTime(optional): string
  Date and time the IP reservatione was created.
• hostName(optional): string
  Name of the Managed Server or Load Balancer node that is using the named IP reservation. This attribute is returned only when the IP reservation is in use.
• id(optional): string
  Id of the IP reservation.
• ipAddress(optional): string
  The public IP address for the IP reservation.
• name(optional): string
  Name of the IP reservation.
• serviceName(optional): string
  Name of the Oracle SOA Cloud Service instance where the named IP reservation is used. This attribute is returned only when the IP reservation is in use.
• status(optional): string
  Status of the IP reservation. Valid values: INITIALIZING, UNUSED, USED.

{
    "properties":{
        "accountId":{
            "type":"string",
            "description":"The identity domain ID and service type of the service. For example, <code>myidentitydomain_SOA</code>, where <code>SOA</code> is the service type of Oracle SOA Cloud Service."
        },
        "computeSiteName":{
            "type":"string",
            "description":"Location of the IP reservation."
        },
        "creationTime":{
            "type":"string",
            "description":"Date and time the IP reservatione was created."
        },
        "hostName":{
            "type":"string",
            "description":"Name of the Managed Server or Load Balancer node that is using the named IP reservation. This attribute is returned only when the IP reservation is in use."
        },
        "id":{
            "type":"string",
            "description":"Id of the IP reservation."
        },
        "ipAddress":{
            "type":"string",
            "description":"The public IP address for the IP reservation."
        },
        "name":{
            "type":"string",
            "description":"Name of the IP reservation."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Oracle SOA Cloud Service instance where the named IP reservation is used. This attribute is returned only when the IP reservation is in use."
        },
        "status":{
            "type":"string",
            "description":"Status of the IP reservation. Valid values: <code>INITIALIZING</code>, <code>UNUSED</code>, <code>USED</code>."
        }
    }
}

Back to Top

Examples

The following example shows how to view all IP reservations created for Oracle SOA Cloud Service, by submitting a GET 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 GET -u username:Password! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/network/ExampleIdentityDomain/services/soa/ipreservations

Example of Response Header

The following example shows the response header.

HTTP/1.1 200 OK
Date: Wed, 22 Nov 2021 21:24:07 GMT
Content-Language: en
Content-Type: application/json

Example of Response Body

The following is an example of the response returned in JSON format, showing USED and UNUSED IP reservations.

{
    "ipReservations":[
    {
        "id":3001,
        "name":"ipres01",
        "ipAddress":"10.11.111.11",
        "status":"UNUSED",
        "accountId":"exampleidentitydomain_SOA",
        "computeSiteName":"uscom-central-1",
        "creationTime":"2021-11-22T21:19:46.179+0000"
    },
    {
        "id":3002,
        "name":"ipres02",
        "ipAddress":"10.22.222.22",
        "status":"USED",
        "accountId":"exampleidentitydomain_SOA",
        "computeSiteName":"uscom-central-1",
        "serviceName":"ExampleInstance",
        "hostName":"exampleinstance-wls-3",
        "creationTime":"2021-11-22T21:20:25.080+0000"
    },

    {
        "id":3203,
        "name":"ipres04",
        "ipAddress":"10.33.333.33",
        "status":"UNUSED",
        "accountId":"exampleidentitydomain_SOA",
        "computeSiteName":"uscom-central-1",
        "creationTime":"2021-11-22T21:23:25.080+0000"
    }
    ],
    "activities":[]
}

Back to Top