Jump to

• Request
• Response
• Examples

Retrieve Details of all IP Associations in a Container

get

/ip/association/{container}/

Retrieves details of the IP associations 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 associations 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 or

  /Compute-identity_domain

Query Parameters

• enabled(optional): boolean
  Start the NAT Connection in enabled state. In disabled state networking will be torn down
• parentpool(optional): string
  Use this option if you want to retrieve details of temporary IP addresses from the pool. Specify ippool:/oracle/public/ippool as the value.
• reservation(optional): string
  Use this option if you want to retrieve details of a specific persistent IP address. Specify the name of the reservation in the format, ipreservation:ipreservation_name, where ipreservation_name is three-part name of an existing IP reservation in the /Compute-identity_domain/user/object format.
• vcable(optional): string
  vcable ID of the instance that you want to associate with the IP reservation.

  For more information about the vcable of an instance, see Retrieve Details of 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 : IPAssociation-list-response

Type: object

Show Source

• result(optional): array result

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

Nested Schema : result

Type: array

Show Source

• Array of: object IPAssociation-response

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

Nested Schema : IPAssociation-response

Type: object

Show Source

• account(optional): string
  Shows the default account for your identity domain.
• ip(optional): string
  The public IP address which is attached 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
  • To associate a temporary IP address from the pool, specify ippool:/oracle/public/ippool.
  • To associate a persistent IP address, specify ipreservation:ipreservation_name, where ipreservation_name is three-part name of an existing IP reservation in the /Compute-identity_domain/user/object_name format. For more information about how to create an IP reservation, see Create an IP Reservation.
• reservation(optional): string
  The three-part name of the IP reservation object in the format (/Compute-identity_domain/user/object). An IP reservation is a public IP address which is attached to a Compute Classic instance that requires access to or from the Internet.
• uri(optional): string
  Uniform Resource Identifier
• vcable(optional): string
  The three-part name of a vcable ID of an instance that is associated with the IP reservation. The three-part name is in the format: /Compute-identity_domain/user/object.

{
    "properties":{
        "account":{
            "type":"string",
            "description":"Shows the default account for your identity domain."
        },
        "ip":{
            "type":"string",
            "description":"The public IP address which is attached to a Compute Classic instance that requires access to or from the Internet."
        },
        "name":{
            "type":"string",
            "description":"The three-part name of the object (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>)."
        },
        "parentpool":{
            "type":"string",
            "description":"<ul><li>To associate a temporary IP address from the pool, specify ippool:/oracle/public/ippool.</li><li>To associate a persistent IP address, specify ipreservation:ipreservation_name, where ipreservation_name is three-part name of an existing IP reservation in the <code>/Compute-identity_domain/user/object_name</code> format. For more information about how to create an IP reservation, see <a class=\"xref\" href=\"op-ip-reservation--post.html\">Create an IP Reservation</a>.</li></ul>"
        },
        "reservation":{
            "type":"string",
            "description":"The three-part name of the IP reservation object in the format (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>). An IP reservation is a public IP address which is attached to a Compute Classic instance that requires access to or from the Internet."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        },
        "vcable":{
            "type":"string",
            "description":"The three-part name of a vcable ID of an instance that is associated with the IP reservation. The three-part name is in the format: <code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>."
        }
    }
}

Back to Top

Examples

cURL Command

The following example shows how to retrieve details about all IP associations 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/association/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.

{
  "result": [
    {
      "account": "/Compute-acme/default",
      "vcable": "6bc9db0a-6676-45b0-8bc4-3adb9ee96970",
      "name": /Compute-acme/[e-mail]/1f36bc5a-c104-44ce-9c7e-1742a260f6b5,
      "ip": "192.0.2.18",
      "uri": "https://api-z999.compute.us0.oraclecloud.com/ip/association/Compute-acme/[e-mail]/1f36bc5a-c104-44ce-9c7e-1742a260f6b5",
      "parentpool": "ippool:/oracle/public/ippool",
      "reservation": "/Compute-acme/[e-mail]/b6849b19-7cab-4d87-9e7b-a5d6ba690033"
    }
  ]
}

Back to Top