To call Anycast Elastic IP Address (Anycast EIP) API operations, you must send HTTP GET requests to the endpoint of the Anycast EIP API. You must add the request parameters that correspond to the API operation being called. After you call the API operation, the system returns a response. The request and response are both encoded in UTF-8.

Request syntax

Anycast EIP API operations use the RPC protocol. You can call Anycast API operations by sending HTTP GET requests.

Request syntax:
http://Endpoint/?Action=xx&Parameters
where:
  • Endpoint: the endpoint of the Anycast EIP API. The current endpoint is eipanycast.cn-hangzhou.aliyuncs.com.
  • Action: the operation that you want to perform. For example, to create an Anycast EIP, you must set the Action parameter to AllocateAnycastEipAddress.
  • Version: the version of the API that you want to call. The current Anycast EIP API version is 2020-03-09.
  • Parameters: the request parameters for the operation. Separate multiple parameters with ampersands (&).

    Request parameters include both common request parameters and operation-specific parameters. Common parameters include information such as the API version number and authentication information. For more information, see Common parameters.

The following example demonstrates how to call the AllocateAnycastEipAddress operation to apply for an Anycast EIP:
Note The following code has been edited to improve readability:
https://eipanycast.cn-hangzhou.aliyuncs.com/?Action=AllocateAnycastEipAddress
&Format=XML
&Version=2020-03-09
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z
…

Authorization

To ensure the security of your account, we recommend that you call API operations as a Resource Access Management (RAM) user. To call Anycast EIP API operations as a RAM user, you must create a permission policy that contains the required permissions and attach the policy to the RAM user.

For more information about the Anycast EIP resources and API operations that can be authorized to a RAM user, see RAM user authorization.

Signature

You must sign all API requests to ensure security. Alibaba Cloud uses the request signature to verify the identity of the API caller.

Anycast EIP implements symmetric encryption with an AccessKey pair to verify the identity of the request sender. An AccessKey pair is an identity credential that is issued to Alibaba Cloud accounts and RAM users. An AccessKey pair is similar to a pair of username and password. An AccessKey pair consists of an AccessKey ID and an AccessKey secret. The AccessKey ID is used to verify the identity of the user, while the AccessKey secret is used to encrypt and verify the signature string. You must keep your AccessKey secret strictly confidential.

To call an RPC API operation, you must add the signature to the API request in the following format:

https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=XXXX%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx

Take AllocateAnycastEipAddress as an example. The AccessKey ID is testid and the AccessKey secret is testsecret. The URL before the request is signed is:

http://eipanycast.cn-hangzhou.aliyuncs.com/?Action=AllocateAnycastEipAddress
&Timestamp=2016-05-23T12:46:24Z
&Format=XML
&AccessKeyId=testid
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx
&Version=2020-03-09
&SignatureVersion=1.0
Perform the following operations to calculate the signature:
  1. Use the request parameters to create a query string for signature.
    GET&%2F&AccessKeyId%3Dtestid&Action%3DAllocateAnycastEipAddress&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx&SignatureVersion%3D1.0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2020-03-09
  2. Calculate the HMAC value of the string that you want to sign.

    Add an ampersand (&) after the AccessKey secret as the key to calculate the HMAC value. In this example, the key is testsecret&.

    CT9X0VtwR86fNWS********juE=
  3. Add the signature to the request parameters:
    http://eipanycast.cn-hangzhou.aliyuncs.com/?Action=AllocateAnycastEipAddress
    &Timestamp=2016-05-23T12:46:24Z
    &Format=XML
    &AccessKeyId=testid
    &SignatureMethod=HMAC-SHA1
    &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx
    &Version=2020-03-09
    &SignatureVersion=1.0
    &Signature=XXXX%3D