Create an IP Address Association for IP Networks

post

/network/v1/ipassociation/

Creates an IP address association.

Required Role: To complete this task, you must have the 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
Header Parameters
Body ()
The request body contains details of the IP address association that you want to create.
Root Schema : IpAddressAssociation-post-request
Type: object
The request body contains details of the IP address association that you want to create.
Show Source
  • Description of the IP address association.
  • The three-part name of the NAT IP address reservation (/Compute-identity_domain/user/object).
  • The three-part name of the Ip address association (/Compute-identity_domain/user/object).

    Object names can contain only alphanumeric characters, hyphens, underscores, and periods. Object names are case-sensitive. When you specify the object name, ensure that an object of the same type and with the same name doesn't already exist. If such an object already exists, another object of the same type and with the same name won't be created and the existing object won't be updated.

  • tags
    Description of the IP address association.
  • Multipart name of the virtual NIC that you want to associate with the NAT IP reservation.
Nested Schema : tags
Type: array
Description of the IP address association.
Show Source

Response

Supported Media Types

201 Response

Created. See Status Codes for information about other possible HTTP status codes.
Headers
Body ()
Root Schema : IpAddressAssociation-response
Type: object
Show Source
Nested Schema : tags
Type: array
Tags associated with the object.
Show Source

Examples

cURL Command

The following example shows how to create an IP association to associate a reserved IP address with an instance by submitting a POST 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 -i -X POST
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Content-Type: application/oracle-compute-v3+json"
     -H "Accept: application/oracle-compute-v3+json"
     -d "@requestbody.json"
        https://api-z999.compute.us0.oraclecloud.com/network/v1/ipassociation/
  • 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.

Example of Request Body

The following shows an example of the request body content in the requestbody.json file to create an IP association /Compute-acme/jack.jones@example.com/ipassociation1 to associate the IP reservation /Compute-acme/jack.jones@example.com/ipreservation1 with vNIC /Compute-acme/jack.jones@example.com/2e6627de-6842-49bc-9c28-21da524c297d/eth0.

{
  "ipAddressReservation": "/Compute-acme/jack.jones@example.com/ipreservation1",
  "vnic": "/Compute-acme/jack.jones@example.com/2e6627de-6842-49bc-9c28-21da524c297d/eth0",
  "name": "/Compute-acme/jack.jones@example.com/ipassociation1"
}

Example of Response Body

The following example shows the response body in JSON format.

{
  "name": "/Compute-acme/jack.jones@example.com/ipassociation1",
  "uri": "https://api-z999.compute.us0.oraclecloud.com/network/v1/ipassociation/Compute-acme/jack.jones@example.com/ipassociation1",
  "description": null,
  "tags": [],
  "vnic": "/Compute-acme/jack.jones@example.com/2e6627de-6842-49bc-9c28-21da524c297d/eth0",
  "ipAddressReservation": "/Compute-acme/jack.jones@example.com/ipreservation1"
}