Jump to

• Request
• Response
• Examples

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

• application/oracle-compute-v3+json

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.

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(optional): string
  Description of the IP address association.
• ipAddressReservation(optional): string
  The three-part name of the NAT IP address reservation (/Compute-identity_domain/user/object).
• name: string
  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(optional): array tags
  Description of the IP address association.
• vnic(optional): string
  Multipart name of the virtual NIC that you want to associate with the NAT IP reservation.

{
    "required":[
        "name"
    ],
    "description":"The request body contains details of the IP address association that you want to create. ",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the IP address association."
        },
        "ipAddressReservation":{
            "type":"string",
            "description":"The three-part name of the NAT IP address reservation (/Compute-identity_domain/user/object)."
        },
        "name":{
            "type":"string",
            "description":"The three-part name of the Ip address association (/Compute-identity_domain/user/object).<p>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":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Description of the IP address association."
        },
        "vnic":{
            "type":"string",
            "description":"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

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Description of the IP address association."
}

Back to Top

Response

Supported Media Types

• application/oracle-compute-v3+json

201 Response

Created. 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 : IpAddressAssociation-response

Type: object

Show Source

• description(optional): string
  Description of the object.
• ipAddressReservation(optional): string
  The three-part name of the NAT IP address reservation (/Compute-identity_domain/user/object).
• name(optional): string
  The three-part name of the NAT IP address association (/Compute-identity_domain/user/object).
• tags(optional): array tags
  Tags associated with the object.
• uri(optional): string
  Uniform Resource Identifier
• vnic(optional): string
  Multipart name of the virtual NIC associated with this NAT IP reservation.

{
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the object."
        },
        "ipAddressReservation":{
            "type":"string",
            "description":"The three-part name of the NAT IP address reservation (/Compute-identity_domain/user/object)."
        },
        "name":{
            "type":"string",
            "description":"The three-part name of the NAT IP address association (/Compute-identity_domain/user/object)."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Tags associated with the object."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        },
        "vnic":{
            "type":"string",
            "description":"Multipart name of the virtual NIC associated with this NAT IP reservation."
        }
    }
}

Nested Schema : tags

Type: array

Tags associated with the object.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Tags associated with the object."
}

Back to Top

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/[e-mail]/ipassociation1 to associate the IP reservation /Compute-acme/[e-mail]/ipreservation1 with vNIC /Compute-acme/[e-mail]/2e6627de-6842-49bc-9c28-21da524c297d/eth0.

{
  "ipAddressReservation": "/Compute-acme/[e-mail]/ipreservation1",
  "vnic": "/Compute-acme/[e-mail]/2e6627de-6842-49bc-9c28-21da524c297d/eth0",
  "name": "/Compute-acme/[e-mail]/ipassociation1"
}

Example of Response Body

The following example shows the response body in JSON format.

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

Back to Top