API Overview

Updated on 2022-01-25 GMT+08:00

View PDF

The DNS service provides RESTful APIs.

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

Table 1 provides an overview of the DNS APIs.

**Table 1** API overview
Category	Description
Version Management	Query version information of all DNS APIs or a specified API.
Private Zone Management	Create, delete, modify, and query private zones.
Record Set Management	Create, delete, modify, and query record sets in private zones.
PTR Record Management	Create, delete, modify, and query PTR records that map EIPs to domain names.
Tag Management	Create, delete, modify, and query tags for specified DNS resources.

Query DNS API versions.

**Table 2** Version management APIs
API	Description
Listing All DNS API Versions	Query the versions of all DNS APIs.
Querying the DNS API Version	Queries the version of a specified DNS API.

Create, query, delete, and modify private zones.

**Table 3** Private zone management APIs
API	Description
Creating a Private Zone	Query a private zone.
Associating a Private Zone with a VPC	Associate a private zone with a VPC.
Disassociating a VPC from a Private Zone	Disassociate a VPC from a private zone.
Querying a Private Zone	Query a private zone.
Querying Private Zones	Query private zones.
Querying Name Servers in a Private Zone	Query name servers in a private zone.
Deleting a Private Zone	Delete a private zone.
Modifying a Private Zone	Modify a private zone.

Create, query, delete, and modify record sets.

**Table 4** Record set management APIs
API	Description
Creating a Record Set	Create a record set.
Querying a Record Set	Query a record set.
Querying All Record Sets	Query record sets.
Querying Record Sets in a Zone	Query record sets in a specified zone.
Deleting a Record Set	Delete a record set.
Modifying a Record Set	Modify a record set.

Set, query, modify, and unset PTR records for EIPs.

**Table 5** PTR record management APIs
API	Description
Creating a PTR Record	Configure a PTR record for an EIP.
Querying a PTR Record	Query the PTR record of an EIP.
Querying All PTR Records	Query PTR records of EIPs.
Unsetting a PTR Record	Unset the PTR record to the default value.
Modifying a PTR Record	Modify the PTR record for an EIP.

Add, delete, and query resource tags.

**Table 6** Tag management APIs
API	Description
Adding Resource Tags	Add tags to a specified resource. You can add a maximum of 10 tags to a resource.
Deleting a Resource Tag	Delete a resource tag.
Adding or Deleting Resource Tags in Batches	Add or delete tags for a specified resource in batches.
Querying Tags of a Resource	Query tags of a specified resource.
Querying Tags of a Specified Resource Type	Query all tags of a resource type.
Querying Resources by Tag	Query DNS resources by tag. Resources are sorted by creation time in descending order.