Anycast Elastic IP Address (Anycast EIP) provides a visualized console for you to perform operations. Anycast EIP works with Alibaba Cloud SDK, Terraform, Resource Orchestration Service (ROS). You can also use OpenAPI Explorer for online debugging. We recommend that you select an appropriate integration method wo improve development efficiency.
OpenAPI Explorer overview
Alibaba Cloud provides OpenAPI Explorer for you to efficiently understand and use the API operations of various Alibaba Cloud services. OpenAPI Explorer integrates the following features for API operations: intelligent search, documentation, online debugging, SDK obtaining, CodeSample, call error diagnosis, and call statistics. In OpenAPI Explorer, you can call API operations of Alibaba Cloud services and view API requests and responses. In addition, OpenAPI Explorer automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services. For more information, see What is an API?
Versions
Alibaba Cloud API uses version numbers to manage the lists of operations in major versions of cloud service APIs.
For example, Anycast EIP supports the list of operations of version 2020-03-09
. 2020-03-09
is an API version number rather than a date. Users are presented with the latest public information about the API. 2020-03-09
is the up-to-date version of the Anycast EIP API.
Version | Description |
We recommend that you use this version. |
Online debugging
Anycast EIP supports features such as online debugging in OpenAPI Explorer. Before you call API operations, make sure that you understand concepts such as the API version, endpoint, and integration method.
Debugging page
Endpoints
Select an endpoint based on the region where your resource resides to reduce latency.
For more information about access points of Anycast EIP, see Anycast EIP.
Identities
By default, after you log on to OpenAPI Explorer by using your Alibaba Cloud account, the Alibaba Cloud account is used to perform online debugging. An Alibaba Cloud account has permissions on all API operations. If you use an Alibaba Cloud account to call API operations, security risks may arise. We strongly recommend that you call API operations or perform routine O&M as a Resource Access Management (RAM) user. Before you call API operations as a RAM user, grant the required permissions to the RAM user based on your business requirements. The RAM user needs to obtain the permissions on Anycast EIP resources. For more information, see Use RAM to implement access control.
Identity | Supported |
Alibaba Cloud account | Yes |
RAM user (recommended) | Yes |
RAM role (recommended) | Yes |
For more information about user identities, see Identity.
References
For more information about OpenAPI Explorer user identities, credentials, authorization, traffic control, and quotas, see the following topics.
Integration methods
Anycast EIP provides multiple integration methods, such as SDK and CLI. Select an integration method based on your requirements.
Integration method | Supported |
Alibaba Cloud SDK (recommended) | Yes |
Yes | |
Yes | |
Yes | |
Yes |
Alibaba Cloud SDK
Alibaba Cloud provides SDKs in multiple programming languages, including Java, C#, Go, Python, TypeScript, Node.js, PHP, and C++. Your applications integrated with the SDKs can directly call API operations. The SDKs encapsulate information such as the signature logic, timeout mechanism, and retry mechanism, and return structured response objects based on specifications. This provides convenience for developers. For more information, see Alibaba Cloud SDKs.
You can use Alibaba Cloud SDKs to call Anycast EIP operations in OpenAPI Explorer. For more information about supported languages and dependencies, see Anycast EIP SDK.
Alibaba Cloud CLI
You can run the
aliyun
command to interact with Alibaba Cloud services and manage cloud resources. For more information, see What is Alibaba Cloud CLI?You can use Alibaba Cloud CLI to call Anycast EIP operations. For more information, see Call RPC API and RESTful API.
Terraform
Terraform is an open source tool that is used to securely and efficiently preview, configure, and manage cloud infrastructure and resources. Terraform works in a similar way as ROS. Terraform calls API operations by interpreting templates. For more information, see What is Terraform?
ROS
ROS is an Alibaba Cloud service that helps you manage cloud computing resources in a simplified manner. You can compile stack templates to describe cloud computing resources, such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, and the dependencies between resources in the templates. The ROS engine automatically creates and configures all resources in a stack based on a template to implement automatic deployment and O&M. For more information, see What is ROS?
You can use ROS to call Anycast EIP operations. The following resources are supported:
ALIYUN::VPC::AnycastEIP: creates an Anycast EIP.
ALIYUN::VPC::AnycastEIPAssociation: associates an Anycast EIP with an instance in a specified region.
Custom API encapsulation
If none of the preceding methods meets your business requirements, you can manually encapsulate API requests. However, this method is not recommended. For more information, see Request syntax and signature method V3.
Usage notes
If an error is returned after you call an API operation, check whether the request parameters and the parameter values are valid based on the returned error code. For a list of error codes, see Service error codes.
You can also perform self-service diagnostics based on the returned request ID or SDK error information on the OpenAPI problem diagnostics page.