Domain Names:Integration overview

Introduction to OpenAPI

Alibaba Cloud provides OpenAPI Explorer, a platform that integrates API search, documentation, online debugging, SDK generation, sample code, call diagnostics, and statistics. OpenAPI Explorer also generates SDK sample code to help you get started quickly. For more information, see What is OpenAPI?.

Versions

Alibaba Cloud OpenAPI uses version numbers to manage APIs across major product releases. Domain Names currently supports API version 2018-01-29. This value is a version identifier, not a date. It always provides access to the latest public API data, and the API may have been updated since 2018-01-29.

Online debugging

To call an API, you must know its version, endpoint, style, and supported calling methods.

For example, to use the SaveSingleTaskForCreatingOrderActivate (submit a domain registration task) API, select the target API in the left-side navigation pane of OpenAPI Explorer. In the central area, select an endpoint, such as China (Hangzhou), and enter the request parameters. These parameters include the required DomainName (the domain you want to register), SubscriptionDuration (purchase period), RegistrantProfileId (domain profile ID), EnableDomainProxy (whether to enable domain privacy protection), and PermitPremiumActivation (whether to allow registration of a premium domain). Then, click Initiate Request. You can view the API description and request parameter documentation in the right-side panel.

Debugging entry point

The debugging page is available at: Debugging page of the Domain Names API.

Endpoints

To minimize latency, select the endpoint in your resources' region.

Endpoint for Singapore: domain-intl.aliyuncs.com.

API style

RPC style.

Identity

By default, OpenAPI Explorer uses your Alibaba Cloud account identity for API calls. Because this account has full API access, we strongly recommend creating a RAM user for API access and daily operations. Grant the RAM user the required Domain Names permissions before making API calls. For more information, see Create a RAM user to perform Domain Names operations.

More information

• Identity, credentials, and authorization

• Throttling and quota management

Integration methods

• Alibaba Cloud SDKs

  • Alibaba Cloud provides SDKs for Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. The SDKs encapsulate signature logic, timeout handling, and retry logic, and provide Request and Response objects to simplify development. For more information, see Alibaba Cloud SDK.

  • You can use the Domain Names SDK to call the OpenAPI. For information about the supported languages and how to install dependencies, see SDK for Java code examples.

• Alibaba Cloud CLI

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

  • The Alibaba Cloud CLI does not currently support Domain Names APIs.

• Terraform

  • Terraform is an open-source tool for previewing, provisioning, and managing cloud infrastructure by translating templates into API calls. For more information, see What is Alibaba Cloud Terraform?.

  • Terraform does not currently support Domain Names APIs.

• Resource Orchestration Service (ROS)

  • Resource Orchestration Service (ROS) automates cloud resource provisioning through templates. You define the required resources and their dependencies in a template, and ROS automatically creates and configures them. For more information, see What is Resource Orchestration Service.

  • ROS does not currently support Domain Names APIs.

• Custom API calls

  • To make native HTTP calls, you must implement the signature algorithm, construct a custom request, and initiate the HTTP call. For more information about the signature mechanism, see V3 request structure and signature.

Usage notes

• If a Domain Names API call returns an error, use the error code to verify that your request parameters and values are correct.

• You can also record the request ID from the response or the SDK error message and use the Alibaba Cloud OpenAPI Diagnostic Platform for self-service diagnostics.