All Products
Search
Document Center

ENS:AssociateEnsEipAddress

Last Updated:Mar 12, 2024

Associates an elastic IP address (EIP) with a cloud resource that is deployed in the same region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
AllocationIdstringYes

The ID of the EIP.

eip-5sc1sgcrsrwgwdvx44hru3p63
InstanceIdstringYes

The ID of the cloud service with which you want to associate the EIP.

Note IDs of Edge Load Balancer (ELB) are supported.
lb-5saivuir6b1mupxjfbhmk1xkb
InstanceTypestringNo

The type of instance with which you want to associate the EIP. Valid values:

  • Nat: a NAT gateway.
  • SlbInstance: an ELB instance.
  • NetworkInterface: a secondary ENI.
  • NatSlbInstance: If you want to associate multiple EIPs to an ELB instance, you need to set the parameter to this value.
  • EnsInstance (default): an ENS instance.
SlbInstance
StandbybooleanNo

Specifies whether the EIP is a secondary EIP. Valid values:

  • true
  • false
true

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status codeError codeError message
400RegionAccessDeniedCould not operate this region's resource
400InstanceNotFoundThe input parameter instancdId that is not found.
400ens.interface.errorAn error occurred while call the API.
400Invalid%sThe specified parameter %s is invalid.
400Missing%sYou must specify the parameter %s.
400IncorrectEipStatusThe current status of the resource does not support this operation.
400InvalidAssociation.DuplicatedSpecified instance already is associated.
400LoadBalancerNotFoundThe input parameter allocationId that is not found.
400EipNotFoundThe input parameter allocationId that is not found.
400IncorrectInstanceStatusCurrent instance status does not support this operation.
400InvalidAssociation.AssociateEipFistAssociate EIP first.
400InvalidAssociation.RegionNotSupportStandbyThe region of EIP does not support standby.
400NatNotFoundThe input parameter allocationId that is not found.
400InvalidAssociation.NetworkTypeNotSupportThe instance network type does not support binding to EIP.
400EniNotFoundThe input parameter allocationId that is not found.
400IncorrectEniStatusCurrent instance status does not support this operation.
400InvalidParameter.EniServiceManaged The eni is managed by service.
400InvalidAssociation.EniNotSupportStandbyEni does not support standby eip.
400IncorrectEniTypeThe type of eni is invalid.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-23The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-09-21The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-07-18The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Standby
2023-03-14The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change