AssociateAnycastEipAddress - Anycast Elastic IP Address - Alibaba Cloud Documentation Center

Associates an Anycast EIP with a specified backend cloud resource.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eipanycast:AssociateAnycastEipAddress

create

*AnycastEipAddress

acs:eipanycast:{#regionId}:{#accountId}:anycast/{#anycastId}

LoadBalancer

acs:eipanycast:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

Instance

acs:eipanycast:{#regionId}:{#accountId}:networkinterface/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
BindInstanceId	string	Yes	The ID of the cloud resource with which you want to associate the Anycast EIP.	lb-d7oxbixhxv1uupnon****
BindInstanceRegionId	string	Yes	The ID of the region where the cloud resource is deployed. You can associate Anycast EIPs with cloud resources in specific regions. You can call the operation to query the region IDs.	us-west-1
BindInstanceType	string	Yes	The type of the cloud resource with which you want to associate the Anycast EIP. Valid values: SlbInstance: a Classic Load Balancer (CLB) instance in a virtual private cloud (VPC). NetworkInterface: an elastic network interface (ENI).	SlbInstance
AnycastId	string	Yes	The ID of the Anycast EIP instance.	aeip-bp1ix34fralt4ykf3****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId may be different for each request.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether to perform a dry run, without performing the actual request. Valid values: true: performs a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
PopLocations	array<object>	No	The information about the access points in the access areas that are associated with the cloud resource. If this is your first time to associate a cloud resource, you do not need to configure this parameter. The system automatically associates all access areas. You can call the operation to query the information about the access points in the supported access areas.
	object	No	The information about the access points in the access areas that are associated with the cloud resource. If this is your first time to associate a cloud resource, you do not need to configure this parameter. The system automatically associates all access areas. You can call the operation to query the information about the access points in the supported access areas.
PopLocation	string	No	The information about the access points in the access areas that are associated with the cloud resource. If this is your first time to associate a cloud resource, you do not need to configure this parameter. The system automatically associates all access areas. You can call the operation to query the information about the access points in the supported access areas.	us-west-1-pop
AssociationMode	string	No	The association mode. Valid values: Default: the default mode. In this mode, the associated cloud resource is the default origin server. Normal: the normal mode. In this mode, the associated cloud resource is a normal origin server. Note An Anycast EIP can be associated with cloud resources in multiple regions. However, you can specify only one default origin server and multiple normal origin servers. When you do not specify an access point or add a new access point, requests are forwarded to the default origin server by default. If this is your first time to associate a cloud resource with the Anycast EIP, the association mode is Default by default. If this is not your first time to associate a cloud resource with the Anycast EIP, you can set the association mode to Default. This makes the new cloud resource the default origin server, and the original default origin server becomes a normal origin server.	Default
PrivateIpAddress	string	No	The secondary private IP address of the ENI. This parameter is required when BindInstanceType is set to NetworkInterface. If you do not specify this parameter, the primary private IP address of the ENI is used.	192.168.XX.XX

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	FBDB18D8-E91E-4978-8D6C-6E2E3EE10133

Examples

Success response

JSON format

{
  "RequestId": "FBDB18D8-E91E-4978-8D6C-6E2E3EE10133"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InstanceNotExist.ENI	Instance does not exist: The specified Elastic Network Interface (ENI) was not found. Please verify the instance ID or check if the resource has been released.
400	InstanceNotExist.SLB	Instance does not exist: The specified Server Load Balancer (SLB) was not found. Please verify the instance ID or check if the resource has been released.
400	IncorrectStatus.Anycast	The status of the Anycast instance is invalid.
400	OperationFailed.BindOnFreeNetworkInterface	Operation failed because the specified network interface is not bound on instance.	The operation failed because the specified ENI is not bound to the instance.
400	OperationFailed.Conflict	Operation failed: The request was too frequent or there was a concurrency conflict. Please try again later.
400	OperationUnsupported.BACKEND_REGION_NOT_OPEN	The specified Region is not supported.	The specified region is not supported.
400	OperationUnsupported.ServiceManaged	Operation is forbidden because this instance belongs to Service manager.	The operation is prohibited and the instance belongs to a managed resource.
400	ResourceNotFound.BindInstanceId	Resource not found: The specified BindInstanceId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.