AssociateAnycastEipAddress - Anycast Elastic IP Address

Associates an Anycast EIP with an endpoint.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
Eipanycast:AssociateAnycastEipAddress	WRITE	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
BindInstanceId	string	Yes	The ID of the endpoint with which you want to associate the Anycast EIP.	lb-d7oxbixhxv1uupnon****
BindInstanceRegionId	string	Yes	The ID of the region where the endpoint is deployed. You can associate Anycast EIPs only with endpoints in specific regions. You can call the DescribeAnycastServerRegions operation to query the region IDs.	us-west-1
BindInstanceType	string	Yes	The type of endpoint with which you want to associate the Anycast EIP. Valid values: SlbInstance: internal-facing Server Load Balancer (SLB) instance that is deployed in a virtual private cloud (VPC) NetworkInterface: elastic network interface (ENI)	SlbInstance
AnycastId	string	Yes	The ID of the Anycast EIP.	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 request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only 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	object []	No	The information about the access points in associated access areas when you associate an Anycast EIP with an endpoint. If this is your first time to associate an Anycast EIP with an endpoint, ignore this parameter. The system automatically associates all access areas. You can call the DescribeAnycastPopLocations operation to query information about access points in supported access areas.
PopLocation	string	No	The information about the access points in associated access areas when you associate an Anycast EIP with an endpoint. If this is your first time to associate an Anycast EIP with an endpoint, ignore this parameter. The system automatically associates all access areas. You can call the DescribeAnycastPopLocations operation to query information about access points in supported access areas.	us-west-1-pop
AssociationMode	string	No	The association mode. Valid values: Default: the default mode. In this mode, the endpoint to be associated serves as the default origin server. Normal: the standard mode. In this mode, the endpoint to be associated serves as a standard origin server. Note You can associate endpoints in multiple regions with an Anycast EIP. However, only one endpoint can serve as the default origin server. Others serve as standard origin servers. If you do not specify or add an access point, requests are forwarded to the default origin server.\ If this is your first time to associate an Anycast EIP with an endpoint, set the value to Default. If not, you can also set the value to Default, which specifies a new default origin server. In this case, the previous origin server functions as a standard origin server.	Default
PrivateIpAddress	string	No	The secondary private IP address of the ENI with which you want to associate the Anycast EIP. This parameter is valid only when you set BindInstanceType to NetworkInterface. If you do not set this parameter, the primary private IP address of the ENI is used.	192.168.XX.XX

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history