Domain Names:Integration overview

Overview of OpenAPI Explorer

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, sample code, call error diagnostics, 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 operations of major versions of cloud service APIs. For example, Domain Names supports the operations of the 2018-01-29 version. 2018-01-29 is an API version number instead of a date. Users are presented with the latest public information about the API. 2018-01-29 is not the last update date of the API.

Online debugging

OpenAPI Explorer provides the online debugging feature for the Domain Names API. Before you call the operations of the Domain Names API, you must understand the information about the API, including the API version, endpoints, API style, and call methods.

URL of the online debugging page

URL of the online debugging page: Debugging page of the Domain Names API.

Endpoints

Select an endpoint based on the region in which your resource resides to reduce latency.

The endpoint in the Singapore region is domain-intl.aliyuncs.com.

API style

The API operations are of the remote procedure call (RPC) style.

Identities

After you log on to OpenAPI Explorer by using your Alibaba Cloud account, OpenAPI uses your Alibaba Cloud account to perform online debugging by default. An Alibaba Cloud account has permissions on all API operations. Security risks may arise if you use an Alibaba Cloud account to call API operations. We 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 must have the permissions to manage Cloud Backup resources. For more information, see Create a RAM user and authorize the RAM user to access Cloud Backup.

References

• Identity, credential, and authorization

• Throttling and quota management

Integration methods

• Alibaba Cloud SDKs

  • Alibaba Cloud provides SDKs in multiple programming languages, including Java, C#, Go, Python, TypeScript, Node.js, PHP, and C++. You can integrate the SDKs into your applications to directly call API operations. The encapsulated SDKs include the signature logic, timeout mechanism, and retry mechanism and also provide the request and response parameters of API operations, which facilitates development. For more information, see Alibaba Cloud SDKs.

  • You can use Domain Names SDKs to call API operations. For more information about the supported programming languages and how to install dependencies, see Example of using an SDK for Java.

• Alibaba Cloud CLI

  • Alibaba Cloud CLI allows you to run aliyun commands to interact with Alibaba Cloud services and manage cloud service resources. For more information, see What is Alibaba Cloud CLI?

  • You cannot use Alibaba Cloud CLI to call the API operations of Domain Names.

• Terraform

  • Terraform is an open source tool that is used to preview, configure, and manage cloud infrastructure and resources in a secure and efficient manner. Terraform works based on a similar mechanism as ROS. It calls API operations by interpreting templates. For more information, see What is Terraform?

  • You cannot use Terraform to call the API operations of Domain Names.

• ROS

  • ROS is an Alibaba Cloud service that can simplify the management of cloud computing resources. You can create a template to describe the cloud computing resources that you need, such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, and the relationship between the resources. ROS automatically creates and configures all the resources based on the template to implement automated deployment and O&M. For more information, see What is ROS?

  • You cannot use ROS to call the API operations of Domain Names.

• Custom encapsulated API calls

  • To make native HTTP calls, you must construct custom requests and sign the requests. For more information about the signature method, see Request syntax and signature method V3.

Usage notes

• If an error is returned after you call an API operation of Domain Names, you can check whether the request parameters and the parameter values are valid based on the error code.

• You can also perform self-service diagnostics based on the returned request ID or SDK error information on the OpenAPI problem diagnostics page.