This product(
Alidns/2015-01-09) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
cloud resolution instance
| API | Title | Description |
|---|---|---|
| DescribeDnsProductInstance | DescribeDnsProductInstance | Queries the details about a paid Alibaba Cloud DNS instance based on the instance ID. |
| DescribeDnsProductInstances | DescribeDnsProductInstances | Calls the DescribeDnsProductInstances operation to query the list of paid Alibaba Cloud DNS instances based on input parameters. |
Domain Name
| API | Title | Description |
|---|---|---|
| AddDomain | AddDomain | Adds a domain name based on the specified parameters. |
| AddDomainBackup | AddDomainBackup | Creates a backup task for a domain name. |
| AddDomainGroup | AddDomainGroup | Creates a domain name group based on the specified parameters. |
| DeleteDomainGroup | DeleteDomainGroup | Deletes a domain name group. After you delete the domain name group, the domain names in the group are moved to the default group. |
| DeleteDomain | DeleteDomain | Deletes a domain name based on the specified parameters. |
| ModifyHichinaDomainDNS | ModifyHichinaDomainDNS | Changes the names of DNS servers bound to a domain name from DNS server names provided by a third-party service provider to DNS server names provided by Alibaba Cloud DNS. |
| UpdateDomainGroup | UpdateDomainGroup | Modifies the name of a domain name group based on the specified parameters. |
| UpdateDomainRemark | UpdateDomainRemark | Modifies the description of a domain name based on the specified parameters. |
| ChangeDomainGroup | ChangeDomainGroup | Moves a domain name from the original group to the new group based on the specified parameters. |
| SetDomainDnssecStatus | SetDomainDnssecStatus | Enables or disables the Domain Name System Security Extensions (DNSSEC) for a domain name. This feature is available only for the users of the paid editions of Alibaba Cloud DNS. |
| DescribeDomainInfo | DescribeDomainInfo | Queries the information about a domain name based on specified parameters. |
| DescribeDomainLogs | DescribeDomainLogs | Queries the operation logs of domain names based on the specified parameters. |
| DescribeDomainNs | DescribeDomainNs | Queries the name servers configured for a specified domain name and checks whether all the name servers are Alibaba Cloud Domain Name System (DNS) servers. |
| DescribeDomains | DescribeDomains | Calls the DescribeDomains operation to query domain names of a user based on input parameters. |
| DescribeDomainStatistics | DescribeDomainStatistics | Queries the real-time statistics on the Domain Name System (DNS) requests for a primary domain name. |
| DescribeDomainStatisticsSummary | DescribeDomainStatisticsSummary | Calls the DescribeDomainStatisticsSummary operation to obtain the query volume of all paid domain names under your account. |
| DescribeRecordStatistics | DescribeRecordStatistics | Queries the real-time statistics on the Domain Name System (DNS) requests for a subdomain name. |
| DescribeRecordStatisticsSummary | DescribeRecordStatisticsSummary | Queries the number of Domain Name System (DNS) requests for all subdomain names of a specified domain name. |
| DescribeInstanceDomains | DescribeInstanceDomains | Queries the domain names that are bound to an Alibaba Cloud DNS instance. |
| DescribeTransferDomains | DescribeTransferDomains | Queries the domain names that were transferred between the current account and another account based on the specified parameters. |
| GetMainDomainName | GetMainDomainName | Queries a primary domain name based on the specified parameters. |
| DescribeDNSSLBSubDomains | DescribeDNSSLBSubDomains | Queries the subdomains for which weighted round-robin is enabled based on the specified parameters. |
| DescribeDomainDnssecInfo | DescribeDomainDnssecInfo | Queries the Domain Name System Security Extensions (DNSSEC) configurations of a domain name based on the specified parameters. |
| DescribeDomainGroups | DescribeDomainGroups | Queries all domain name groups based on the specified parameters. |
| BindInstanceDomains | BindInstanceDomains | Binds one or more domain names to a paid Alibaba Cloud DNS instance. |
| RetrieveDomain | RetrieveDomain | Retrieves a domain name. |
| OperateBatchDomain | OperateBatchDomain | Submits a batch operation task to add or delete multiple domain names or multiple Domain Name System (DNS) records at a time. |
| TransferDomain | TransferDomain | Transfers multiple domain names from the current account to another account at a time. |
| UnbindInstanceDomains | UnbindInstanceDomains | Unbinds one or more domain names from a paid Alibaba Cloud DNS instance based on the instance ID. |
Authoritative Agent Domain Name
| API | Title | Description |
|---|---|---|
| AddDnsCacheDomain | AddDnsCacheDomain | |
| UpdateDnsCacheDomain | UpdateDnsCacheDomain | |
| UpdateDnsCacheDomainRemark | UpdateDnsCacheDomainRemark | |
| DeleteDnsCacheDomain | DeleteDnsCacheDomain | |
| DescribeDnsCacheDomains | DescribeDnsCacheDomains |
Parsing records
| API | Title | Description |
|---|---|---|
| AddDomainRecord | AddDomainRecord | Adds a Domain Name System (DNS) record based on the specified parameters. |
| DeleteDomainRecord | DeleteDomainRecord | Deletes an Alibaba Cloud DNS (DNS) record based on the specified parameters. |
| DeleteSubDomainRecords | Deleting DNS records corresponding to a host record | Calls the DeleteSubDomainRecords operation to delete DNS records corresponding to a host record based on input parameters. |
| UpdateDomainRecord | UpdateDomainRecord | Modifies a Domain Name System (DNS) record based on the specified parameters. |
| UpdateDomainRecordRemark | UpdateDomainRecordRemark | Modifies the description of a Domain Name System (DNS) record based on the specified parameters. |
| SetDomainRecordStatus | SetDomainRecordStatus | Specifies the status of an Alibaba Cloud DNS (DNS) record based on the specified parameters. |
| DescribeDomainRecordInfo | DescribeDomainRecordInfo | Queries the information about a Domain Name System (DNS) record. |
| DescribeDomainRecords | DescribeDomainRecords | Queries all Domain Name System (DNS) records of the specified primary domain names based on the specified parameters. |
| DescribeRecordLogs | DescribeRecordLogs | Queries the operation logs of a domain name based on the specified parameters. |
| DescribeSubDomainRecords | DescribeSubDomainRecords | Queries all Domain Name System (DNS) records of a subdomain name based on the specified parameters. |
| GetTxtRecordForVerify | GetTxtRecordForVerify | Generates a text (TXT) record. TXT records are used to retrieve domain names and subdomain names, enable the subdomain name verification feature, and perform batch retrievals. |
Resolve request source line
| API | Title | Description |
|---|---|---|
| AddCustomLine | AddCustomLine | Adds a custom line. |
| DeleteCustomLines | DeleteCustomLines | Deletes multiple custom lines at a time. |
| UpdateCustomLine | UpdateCustomLine | Modifies a custom line. |
| DescribeCustomLine | DescribeCustomLine | Queries a custom line. |
| DescribeCustomLines | DescribeCustomLines | Queries a list of custom lines. |
| DescribeSupportLines | DescribeSupportLines | Queries all lines that are supported by Alibaba Cloud DNS. |
Weight
| API | Title | Description |
|---|---|---|
| SetDNSSLBStatus | SetDNSSLBStatus | Enables or disables weighted round-robin based on the specified parameters. |
| UpdateDNSSLBWeight | UpdateDNSSLBWeight | Modifies the weight of a Domain Name System (DNS) record based on the specified parameters. |
Batch Processing
| API | Title | Description |
|---|---|---|
| DescribeBatchResultCount | DescribeBatchResultCount | Queries the result of a batch operation task. |
| DescribeBatchResultDetail | DescribeBatchResultDetail | Queries the detailed results of a batch operation task. |
Resources
| API | Title | Description |
|---|---|---|
| DescribeTags | DescribeTags | Queries existing tags. |
| ListTagResources | ListTagResources | Queries the tags that are added to a specified resource. |
| TagResources | TagResources | Adds and modifies a tag for a resource. |
| UntagResources | UntagResources | Removes tags from resources. |
| MoveDomainResourceGroup | MoveDomainResourceGroup | Moves a domain name to another resource group. |
GTM instance
| API | Title | Description |
|---|---|---|
| SetGtmAccessMode | SetGtmAccessMode | Modifies a policy for switchover between address pool sets. |
| UpdateDnsGtmInstanceGlobalConfig | UpdateDnsGtmInstanceGlobalConfig | Modifies the configurations of a Global Traffic Manager (GTM) instance. |
| UpdateGtmInstanceGlobalConfig | UpdateGtmInstanceGlobalConfig | Modifies the configurations of a Global Traffic Manager (GTM) instance based on the specified parameters. |
| UpdateDnsGtmAccessStrategy | UpdateDnsGtmAccessStrategy | Modifies an access policy. |
| DescribeDnsGtmAddrAttributeInfo | DescribeDnsGtmAddrAttributeInfo | Queries the source regions of addresses. |
| DescribeDnsGtmAvailableAlertGroup | DescribeDnsGtmAvailableAlertGroup | Queries the available alert groups of a Global Traffic Manager (GTM) instance. |
| DescribeDnsGtmInstance | DescribeDnsGtmInstance | Queries detailed information about a Global Traffic Manager (GTM) instance. |
| DescribeGtmInstance | DescribeGtmInstance | Queries the details about a Global Traffic Manager (GTM) instance. |
| DescribeDnsGtmInstances | DescribeDnsGtmInstances | Queries a list of instances. |
| DescribeGtmInstances | DescribeGtmInstances | Queries the Global Traffic Manager (GTM) instances under your account. |
| DescribeDnsGtmInstanceStatus | DescribeDnsGtmInstanceStatus (new) | Queries the status of a Global Traffic Manager (GTM) instance. |
| DescribeGtmInstanceStatus | DescribeGtmInstanceStatus | Queries the status of a Global Traffic Manager (GTM) instance. |
| DescribeDnsGtmLogs | DescribeDnsGtmLogs (new) | Queries operation logs of a Global Traffic Manager (GTM) instance. |
| DescribeGtmAvailableAlertGroup | DescribeGtmAvailableAlertGroup | You can call this operation to query the available alert groups for a Global Traffic Manager (GTM) instance. |
| DescribeGtmLogs | DescribeGtmLogs | You can call this operation to query logs of a Global Traffic Manager (GTM) instance. |
| DescribeGtmInstanceSystemCname | DescribeGtmInstanceSystemCname | You can call this operation to query the CNAME record assigned by the system. |
| DescribeDnsGtmInstanceSystemCname | DescribeDnsGtmInstanceSystemCname (new) | Queries the CNAME domain name assigned by the system for a Global Traffic Manager (GTM) instance. |
| CopyGtmConfig | CopyGtmConfig | Copies the configurations of a Global Traffic Manager (GTM) instance. |
address pool
| API | Title | Description |
|---|---|---|
| AddGtmAddressPool | AddGtmAddressPool | Creates an address pool. |
| AddDnsGtmAddressPool | AddDnsGtmAddressPool | Creates an address pool. |
| DeleteDnsGtmAddressPool | DeleteDnsGtmAddressPool (new) | Deletes an address pool from a Global Traffic Manager (GTM) instance. |
| DeleteGtmAddressPool | DeleteGtmAddressPool | You can call this operation to delete an address pool of a Global Traffic Manager (GTM). |
| UpdateDnsGtmAddressPool | UpdateDnsGtmAddressPool | Modifies an address pool. |
| UpdateGtmAddressPool | UpdateGtmAddressPool | You can call this operation to modify an address pool of a Global Traffic Manager (GTM) instance. |
| DescribeDnsGtmInstanceAddressPool | DescribeDnsGtmInstanceAddressPool | Queries detailed information about an address pool of a Global Traffic Manager (GTM) instance. |
| DescribeDnsGtmInstanceAddressPools | DescribeDnsGtmInstanceAddressPools (new) | Queries the address pools of a Global Traffic Manager (GTM) instance. |
| DescribeDnsGtmAddressPoolAvailableConfig | DescribeDnsGtmAddressPoolAvailableConfig (new) | Queries the available configurations of an address pool of a Global Traffic Manager (GTM) instance. |
| DescribeGtmInstanceAddressPool | DescribeGtmInstanceAddressPool | You can call this operation to query the details about an address pool of a Global Traffic Manager (GTM) instance. |
| DescribeGtmInstanceAddressPools | DescribeGtmInstanceAddressPools | You can call this operation to query the address pools of a Global Traffic Manager (GTM) instance. |
Health Check
| API | Title | Description |
|---|---|---|
| AddDnsGtmMonitor | AddDnsGtmMonitor | Creates a health check task. |
| AddGtmMonitor | AddGtmMonitor | Creates a health check task. |
| UpdateDnsGtmMonitor | UpdateDnsGtmMonitor | Modifies a health check task. |
| UpdateGtmMonitor | UpdateGtmMonitor | Modifies the health check configuration for an address pool of a Global Traffic Manager (GTM) instance. |
| SetDnsGtmMonitorStatus | SetDnsGtmMonitorStatus | Specifies the health check status of an address pool. |
| SetGtmMonitorStatus | SetGtmMonitorStatus | You can call this operation to enable health check for an address pool of a Global Traffic Manager (GTM) instance. |
| DescribeGtmMonitorAvailableConfig | DescribeGtmMonitorAvailableConfig | Queries available monitored nodes. |
| DescribeGtmMonitorConfig | DescribeGtmMonitorConfig | Queries the health check configuration of an address pool of a Global Traffic Manager (GTM) instance. |
| DescribeDnsGtmMonitorAvailableConfig | DescribeDnsGtmMonitorAvailableConfig | Queries the configuration items that can be set for a health check task. |
| DescribeDnsGtmMonitorConfig | DescribeDnsGtmMonitorConfig | Queries the health check configuration of an address pool. |
Access Policy
| API | Title | Description |
|---|---|---|
| AddDnsGtmAccessStrategy | AddDnsGtmAccessStrategy | Creates an access policy. |
| AddGtmAccessStrategy | AddGtmAccessStrategy | You can call this operation to create an access policy for a Global Traffic Manager (GTM) instance. |
| DeleteDnsGtmAccessStrategy | DeleteDnsGtmAccessStrategy (new) | Deletes an access policy from a Global Traffic Manager (GTM) instance. |
| DeleteGtmAccessStrategy | DeleteGtmAccessStrategy | You can call this operation to delete an access policy of a Global Traffic Manager (GTM) instance. |
| UpdateGtmAccessStrategy | UpdateGtmAccessStrategy | You can call this operation to modify the access policy of a Global Traffic Manager (GTM) instance. |
| SetDnsGtmAccessMode | SetDnsGtmAccessMode | Modifies an access policy. |
| DescribeDnsGtmAccessStrategies | DescribeDnsGtmAccessStrategies (new) | Queries access policies of a Global Traffic Manager (GTM) instance. |
| DescribeDnsGtmAccessStrategy | DescribeDnsGtmAccessStrategy (new) | Queries detailed information about an access policy of a Global Traffic Manager (GTM) instance. |
| DescribeDnsGtmAccessStrategyAvailableConfig | DescribeDnsGtmAccessStrategyAvailableConfig (new) | Queries the available configurations of an access policy of a Global Traffic Manager (GTM) instance. |
| DescribeGtmAccessStrategies | DescribeGtmAccessStrategies | You can call this operation to query the access policies of a Global Traffic Manager (GTM) instance. |
| DescribeGtmAccessStrategy | DescribeGtmAccessStrategy | You can call this operation to query the details about an access policy of a Global Traffic Manager (GTM) instance based on the policy ID. |
| DescribeGtmAccessStrategyAvailableConfig | DescribeGtmAccessStrategyAvailableConfig | Queries the configuration items that can be set for an access policy. |
| SwitchDnsGtmInstanceStrategyMode | SwitchDnsGtmInstanceStrategyMode | Changes the access policy type for a Global Traffic Manager (GTM) instance. |
DoH Domain Names
| API | Title | Description |
|---|---|---|
| DescribeDohAccountStatistics | DescribeDohAccountStatistics | |
| DescribeDohDomainStatistics | DescribeDohDomainStatistics | |
| DescribeDohDomainStatisticsSummary | DescribeDohDomainStatisticsSummary | |
| DescribeDohSubDomainStatistics | DescribeDohSubDomainStatistics | |
| DescribeDohSubDomainStatisticsSummary | DescribeDohSubDomainStatisticsSummary | |
| DescribeDohUserInfo | DescribeDohUserInfo | Queries the numbers of accessed domains and subdomains by using DNS over HTTPS (DoH). |
disaster tolerance
| API | Title | Description |
|---|---|---|
| AddGtmRecoveryPlan | AddGtmRecoveryPlan | Creates a disaster recovery plan. |
| DeleteGtmRecoveryPlan | DeleteGtmRecoveryPlan | You can call this operation to delete a disaster recovery plan for a Global Traffic Manager (GTM) instance. |
| UpdateGtmRecoveryPlan | UpdateGtmRecoveryPlan | Modifies a disaster recovery plan. |
| DescribeGtmRecoveryPlan | DescribeGtmRecoveryPlan | Queries the details of a disaster recovery plan. |
| DescribeGtmRecoveryPlanAvailableConfig | DescribeGtmRecoveryPlanAvailableConfig | Queries the configuration items that can be set for a disaster recovery plan. |
| DescribeGtmRecoveryPlans | DescribeGtmRecoveryPlans | Queries the disaster recovery plans for a Global Traffic Manager (GTM) instance. |
| ExecuteGtmRecoveryPlan | ExecuteGtmRecoveryPlan | Executes a disaster recovery plan. |
| PreviewGtmRecoveryPlan | PreviewGtmRecoveryPlan | You can call this operation to preview a disaster recovery plan of a Global Traffic Manager (GTM) instance. |
| RollbackGtmRecoveryPlan | RollbackGtmRecoveryPlan | Rolls back a disaster recovery plan. |
Other
| API | Title | Description |
|---|---|---|
| DescribeRecordResolveStatisticsSummary | DescribeRecordResolveStatisticsSummary | Queries the number of resolution requests for all subdomain names of a specified domain name. |
| DescribeDomainResolveStatisticsSummary | DescribeDomainResolveStatisticsSummary | Queries the resolution requests of all paid domain names within your account. |