All Products
Search
Document Center

ENS:AssociateEnsEipAddress

Last Updated:Jul 26, 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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:AssociateEnsEipAddress
  • All Resources
    *
    none
none

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 messageDescription
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.The Eip status is incorrect. Check the Eip status.
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 changedView Change Details
2023-09-21The Error code has changedView Change Details
2023-07-18The Error code has changed. The request parameters of the API has changedView Change Details
2023-03-14The Error code has changedView Change Details