Updated on 2025-12-30 GMT+08:00

Overview

The DNS service provides RESTful APIs.

By calling these APIs, you can use all DNS functions, including creating, querying, modifying, and deleting public zones, private zones, and record sets.

Table 1 lists DNS APIs.

Table 1 DNS APIs

Category

Description

Version Management

Query version information of all DNS APIs or a specified API.

Public Zone Management

  • Create, query, modify, and delete a public zone.
  • Query the public zone list, query the name server of a public zone, and set the public zone status.
  • Create, query, and verify a public zone reclamation request, and query the public zone reclamation result.
  • Create an authorization for a public subdomain, query the authorization task, and verify the authorization.

Private Zone Management

  • Create, modify, query, and delete a private zone.
  • Query the private zone list and query the name server of a private zone.
  • Associate a VPC with a private zone and disassociate a VPC from a private zone.
  • Set the recursive resolution proxy for the subdomain of a private zone.

Record Set Management (v2.1)

  • Create, query, modify, and delete a record set.
  • Query the record sets of a zone, query the record sets of a tenant, and set the record set status.
  • Query the lines of a public zone, query the preset resolution lines, and batch create record sets.
  • Query and delete the task for batch creating record sets.
  • Batch create record sets with the same name and type, but different routing lines.
  • Modify and delete record sets in batches.

Record Set Management (v2)

  • Create, query, modify, and delete a record set.
  • Query the record sets of a zone and query the record sets of a tenant.

PTR Record Management (v2.1)

  • Create, query, and modify the PTR record for an EIP.
  • Query the PTR record list and restore PTR records to their default values.

PTR Record Management (v2)

  • Create, query, and modify the PTR record for an EIP.
  • Query the PTR record list and restore PTR records to their default values.

Batch Operation Management

  • Batch delete zones, record sets, and PTR records.
  • Batch set the statuses of zones and record sets.
  • Batch create public zones.
  • Batch create, delete, and modify record sets of public zones.
  • Transfer public zones in batches, query the list of batch operation tasks, and query a batch operation task.

DNSSEC Management

Enable, disable, and query DNSSEC.

Public Zone Check

Query public zone check results, query email record sets in a public zone, query website record sets in a public zone, and query the DNS server addresses of a public zone.

Custom Line Management

  • Create, query, modify, and delete a custom line.
  • Create, query, modify, and delete a line group, and query the line group list.

Resolver Management

  • Create, query, modify, and delete an endpoint.
  • Query the endpoint list, bind IP addresses to an endpoint, query the IP addresses bound to an endpoint, unbind IP addresses from an endpoint, and query endpoint VPCs.
  • Create, query, and delete an endpoint rule.
  • Query the endpoint rule list, associate a VPC with an endpoint rule, and disassociate a VPC from an endpoint rule.

Access Log Management

  • Create, query, and delete a resolver access logging configuration.
  • Query the list of resolver access logging configurations.
  • Associate a resolver access logging configuration with a VPC and disassociate a resolver access logging configuration from a VPC.

Tag Management

Add a tag for a specified instance, delete a resource tag, batch add or delete tags for a specified instance, query tags of a specified instance, query all tags of a specified instance type, and query resource instances using tags.

Name Server Management

Query name servers.

Quota Management

Query DNS resource quotas.

Version Management

Table 2 Version management APIs

API

Description

Obtaining API Versions

Query the versions of all DNS APIs.

Querying a Specified API Version

Query the version of a specified DNS API.

Public Zone Management

Table 3 Public zone management APIs

API

Description

Creating a Public Zone

Create a public zone.

Querying the Public Zones

Query public zones.

Querying a Public Zone

Query a public zone.

Querying Name Servers in a Public Zone

Query name servers for a public zone.

Modifying a Public Zone

Modify a public zone.

Deleting a Public Zone

Delete a public zone.

Setting the Status of a Public Zone

Set the status of a public zone.

Creating a Request for Reclaiming a Public Zone

Create a public zone reclamation request.

Querying the Request for Reclaiming a Public Zone

Query a public zone reclamation request.

Verifying the Public Zone Reclaiming Result

Verify the public zone reclamation result.

Querying the Public Zone Reclaiming Result

Query the public zone reclamation result.

Creating an Authorization Task for a Public Subdomain

Create an authorization task for a public subdomain.

Querying the Authorization Task of a Public Subdomain

Querying the authorization task of a public subdomain.

Verifying the Authorization Status of a Public Subdomain

Verify the authorization status of a public subdomain.

Private Zone Management

Table 4 Private zone management APIs

API

Description

Creating a Private Zone

Create a private zone.

Querying the Private Zones

Query private zones.

Querying a Private Zone

Query a private zone.

Querying Name Servers in a Private Zone

Query name servers for a private zone.

Modifying a Private Zone

Modify a private zone.

Deleting a Private Zone

Delete a private zone.

Associating a VPC with a Private Zone

Associate a VPC with a private zone.

Disassociating a VPC from a Private Zone

Disassociate a VPC from a private zone.

Setting the Status of a Private Zone

Set the status of a private zone.

Setting a Recursive Resolution Proxy for Subdomains in a Private Zone

Set a recursive resolution proxy for subdomains in a private zone.

Record Set Management (v2.1)

Table 5 Record set management APIs

API

Description

Creating a Record Set

Create a record set.

Querying Record Sets in a Zone

Query record sets in a zone.

Querying Record Sets

Query record sets.

Querying a Record Set

Query a record set.

Modifying a Record Set

Modify a record set.

Deleting a Record Set

Delete a record set.

Setting the Record Set Status

Set the record set status.

Querying Public Zone Lines

Query public zone lines.

Querying Preset Resolution Lines

Query preset resolution lines.

Batch Creating Record Sets

Batch create record sets

Querying the Task for Batch Creating Record Sets

Query the task for batch creating record sets.

Deleting the Task for Batch Creating Record Sets

Delete the task for batch creating record sets.

Batch Creating Record Sets with the Same Name and Type, But Different Routing Lines

Batch create record sets with the same name and type, but different routing lines.

Modifying Record Sets

Modify record sets in batches.

Deleting Record Sets in a Zone in Batches

Delete record sets from a zone in batches.

Record Set Management (v2)

Create, delete, modify, and query record sets.

Table 6 Record set management APIs

API

Description

Creating a Record Set

Create a record set.

Querying Record Sets in a Zone

Query record sets in a zone.

Querying Record Sets

Query record sets.

Querying a Record Set

Query a record set.

Modifying a Record Set

Modify a record set.

Deleting a Record Set

Delete a record set.

PTR Record Management (v2.1)

Table 7 PTR record management APIs

API

Description

Creating a PTR Record for an EIP

Create a PTR record for an EIP.

Querying PTR Records of an EIP

Query PTR records of EIPs.

Querying a PTR Record of an EIP

Query the PTR record of an EIP.

Modifying a PTR Record for an EIP

Modify the PTR record for an EIP.

Restoring the PTR Record of an EIP to the Default Value

Restore the PTR record of an EIP to the default value.

PTR Record Management (v2)

Table 8 PTR record management APIs

API

Description

Creating a PTR Record for an EIP

Create a PTR record for an EIP.

Querying PTR Records of an EIP

Query PTR records of an EIP.

Querying a PTR Record of an EIP

Query a PTR record of an EIP.

Modifying a PTR Record for an EIP

Modify the PTR record for an EIP.

Restoring the PTR Record of an EIP to the Default Value

Restore the PTR record of an EIP to the default value.

Batch Operation Management

Table 9 Batch operation management APIs

API

Description

Batch Deleting Zones

Delete zones in batches.

Batch Deleting Record Sets

Delete record sets in batches.

Deleting PTR Records

Delete PTR records.

Batch Setting Zone Status

Batch set zone status.

Batch Setting the Status of Record Sets

Batch set the statuses of record sets.

Creating Public Zones in Batches

Create public zones in batches.

Creating Record Sets for Public Zones in Batches

Create record sets for public zones in batches.

Creating Record Sets for Public Zones in Batches

Create record sets for public zones in batches.

Deleting Record Sets from Public Zones in Batches

Delete record sets from public zones in batches.

Modifying Record Sets of Public Zones in Batches

Modify record sets of public zones in batches.

Transferring Public Zones in Batches

Transfer public zones in batches.

Querying the Batch Operation Task List

Query the batch operation task list.

Querying the Batch Operation Task

Query a batch operation task.

DNSSEC Management

Table 10 DNSSEC management APIs

API

Description

Enabling DNSSEC

Enable DNSSEC for a public zone.

Disabling DNSSEC

Disable DNSSEC for a public zone.

Querying DNSSEC

Query DNSSEC for a public zone.

Public Zone Check

Table 11 Public zone check APIs

API

Description

Querying Domain Name Check Results of a Public Zone

Query domain name check results of a public zone.

Querying Email Record Sets in a Public Zone

Query email record sets in a public zone.

Querying Website Record Sets in a Public Zone

Query website record sets in a public zone.

Querying DNS Server Addresses of a Public Zone

Query DNS server addresses of a public zone.

Custom Line Management

Table 12 Custom line management APIs

API

Description

Creating a Custom Line

Create a custom line.

Querying a Custom Line

Query custom lines.

Modifying a Custom Line

Update a custom line.

Deleting a Custom Line

Delete a custom line.

Creating a Line Group

Create a line group.

Querying Line Groups

Query line groups.

Querying a Line Group

Query a line group.

Modifying a Line Group

Update a line group.

Deleting a Line Group

Delete a line group.

Resolver Management

Table 13 Resolver management APIs

API

Description

Creating an Endpoint

Create an endpoint.

Querying Endpoints

Query endpoints.

Querying an Endpoint

Query an endpoint.

Modifying an Endpoint

Modify an endpoint.

Deleting an Endpoint

Delete an endpoint.

Binding an IP Address to an Endpoint

Bind an IP address to an endpoint.

Querying IP Addresses

Query IP addresses.

Unbinding an IP Address from an Endpoint

Unbind an IP address from an endpoint.

Querying VPCs of an Endpoint

Query VPCs of an endpoint.

Creating an Endpoint Rule

Create an endpoint rule.

Querying Endpoint Rules

Query endpoint rules.

Querying an Endpoint Rule

Query an endpoint rule.

Modifying an Endpoint Rule

Modify an endpoint rule.

Deleting an Endpoint Rule

Delete an endpoint rule.

Associating a VPC with an Endpoint Rule

Associate a VPC with an endpoint rule.

Disassociating an Endpoint Rule from a VPC

Disassociate an endpoint rule from a VPC.

Access Log Management

Table 14 Access log management APIs

API

Description

Creating a Resolver Access Logging Configuration

Create a resolver access logging configuration.

Querying the List of Resolver Access Logging Configurations

Query the list of resolver access logging configurations.

Querying a Resolver Access Logging Configuration

Query a resolver access logging configuration.

Deleting a Resolver Access Logging Configuration

Delete a resolver access logging configuration.

Associating a Resolver Access Logging Configuration with a VPC

Associate a resolver access logging configuration with a VPC.

Disassociating a Resolver Access Logging Configuration from the VPC

Disassociate a resolver access logging configuration from a VPC.

Tag Management

Table 15 Tag management APIs

API

Description

Adding a Tag to a Specific Resource

Add tags to a specified resource.

Deleting a Resource Tag

Delete a resource tag.

Batch Adding or Deleting Tags for a Specific Instance

Add or delete tags for a specified resource in batches.

Querying Tags of a Specific Instance

Query tags of a specified resource.

Querying All Tags of a Specific Resource

Query all tags of a resource type.

Querying Resources Using Tags

Query DNS resources by tag.

Resources are sorted by creation time in descending order.

Name Server Management

Table 16 Name server management API

API

Description

Querying Name Servers

List the name servers.

Quota Management

Table 17 Quota management API

API

Description

Querying Resource Quotas

Query DNS resource quotas.