Jump to

• Request
• Response
• Examples

Retrieve Details of all IP Reservations in a Container

get

/ip/reservation/{container}/

Retrieves details of the IP reservations that are available in the specified container and match the specified query criteria. If you don't specify any query criteria, then details of all the IP reservations in the container are displayed. To filter the search results, you can pass one or more of the following query parameters, by appending them to the URI in the following syntax:

?parameter1=value1&parameter2=value2&parameterN=valueN

Required Role: To complete this task, you must have the Compute_Monitor or Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types

• application/oracle-compute-v3+json

Path Parameters

• container: string

  /Compute-identity_domain/user

Query Parameters

• permanent(optional): boolean
  true indicates that the IP reservation has a persistent public IP address. You can associate either a temporary or a persistent public IP address with an instance when you create the instance.

  Temporary public IP addresses are assigned dynamically from a pool of public IP addresses. When you associate a temporary public IP address with an instance, if the instance is restarted or is deleted and created again later, its public IP address might change.

• tags(optional): array
  A comma-separated list of strings which helps you to identify IP reservations.

  • [0]: string

  {
      "name":"tags",
      "in":"query",
      "description":"A comma-separated list of strings which helps you to identify IP reservations.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      }
  }

• used(optional): boolean
  true indicates that the IP reservation is associated with an instance.

Header Parameters

• Cookie: string
  The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.

Back to Top

Response

Supported Media Types

• application/oracle-compute-v3+json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Headers

• set-cookie: string
  The cookie value is returned if the session is extended

Body ()

Root Schema : IPReservation-list-response

Type: object

Show Source

• result(optional): array result

{
    "properties":{
        "result":{
            "items":{
                "$ref":"#/definitions/IPReservation-response"
            },
            "type":"array"
        }
    }
}

Nested Schema : result

Type: array

Show Source

• Array of: object IPReservation-response

{
    "items":{
        "$ref":"#/definitions/IPReservation-response"
    },
    "type":"array"
}

Nested Schema : IPReservation-response

Type: object

Show Source

• account(optional): string
  Shows the default account for your identity domain.
• ip(optional): string
  Public IP address.

  An IP reservation is a public IP address that you can attach to a Compute Classic instance that requires access to or from the Internet.

• name(optional): string

  The three-part name of the object (/Compute-identity_domain/user/object).

• parentpool(optional): string
  /oracle/public/ippool

  Pool of public IP addresses

• permanent(optional): boolean
  true indicates that the IP reservation has a persistent public IP address. You can associate either a temporary or a persistent public IP address with an instance when you create the instance.

  Temporary public IP addresses are assigned dynamically from a pool of public IP addresses. When you associate a temporary public IP address with an instance, if the instance is restarted or is deleted and created again later, its public IP address might change.

• quota(optional): string
  Not used
• tags(optional): array tags
  A comma-separated list of strings which helps you to identify IP reservation.
• uri(optional): string
  Uniform Resource Identifier
• used(optional): boolean
  true indicates that the IP reservation is associated with an instance.

{
    "properties":{
        "account":{
            "type":"string",
            "description":"Shows the default account for your identity domain."
        },
        "ip":{
            "type":"string",
            "description":"Public IP address.<p>An IP reservation is a public IP address that you can attach to a Compute Classic instance that requires access to or from the Internet."
        },
        "name":{
            "type":"string",
            "description":"<p>The three-part name of the object (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>)."
        },
        "parentpool":{
            "type":"string",
            "description":"<code>/oracle/public/ippool</code><p>Pool of public IP addresses"
        },
        "permanent":{
            "type":"boolean",
            "description":"<code>true</code> indicates that the IP reservation has a persistent public IP address. You can associate either a temporary or a persistent public IP address with an instance when you create the instance.<p>Temporary public IP addresses are assigned dynamically from a pool of public IP addresses. When you associate a temporary public IP address with an instance, if the instance is restarted or is deleted and created again later, its public IP address might change."
        },
        "quota":{
            "type":"string",
            "description":"Not used"
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"A comma-separated list of strings which helps you to identify IP reservation."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        },
        "used":{
            "type":"boolean",
            "description":"<code>true</code> indicates that the IP reservation is associated with an instance."
        }
    }
}

Nested Schema : tags

Type: array

A comma-separated list of strings which helps you to identify IP reservation.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"A comma-separated list of strings which helps you to identify IP reservation."
}

Back to Top

Examples

cURL Command

The following example shows how to retrieve details about all IP reservations in the /Compute-acme/[e-mail]/ container by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Accept: application/oracle-compute-v3+json"
     https://api-z999.compute.us0.oraclecloud.com/ip/reservation/Compute-acme/[e-mail]/

• COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.

• api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.

• acme and [e-mail] are example values. Replace acme with the identity domain ID of your Compute Classic account, and [e-mail] with your user name.

Example of Response Body

The following example shows the response body in JSON format.

Some lines may be truncated with ellipses (...) for readability.

{
  "result": [
    {
      "account": "/Compute-acme/default",
      "used": false,
      "name": "/Compute-acme/[e-mail]/375570f2-a8a0-482b-9b1d-3978cde33c61",
      "tags": [],
      "ip": "129.144.54.42",
      "uri": "https://api-z999.compute.us0.oraclecloud.com/ip/reservation/Compute-acme/[e-mail]/375570f2-a8a0-482b-9b1d-3978cde33c61",
      "quota": null,
      "parentpool": "/oracle/public/ippool",
      "permanent": true
    },
    {
      "account": "/Compute-acme/default",
      "used": false,
      "name": "/Compute-acme/[e-mail]/c7588bef-dab7-4b0d-adb4-648ba462c2c1",
      "tags": [],
      "ip": "129.144.53.38",
      "uri": "https://api-z999.compute.us0.oraclecloud.com/ip/reservation/Compute-acme/[e-mail]/c7588bef-dab7-4b0d-adb4-648ba462c2c1",
      "quota": null,
      "parentpool": "/oracle/public/ippool",
      "permanent": true
    }
  ]
}

Back to Top