Help Center/ Domain Name Service/ API Reference/ API Overview
Updated on 2024-08-30 GMT+08:00
View PDF

API 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 provides an overview of the DNS APIs.

Table 1 API overview

Category

Description

Public Zone Management

Create, delete, modify, and query public zones.

Private Zone Management

Create, delete, modify, and query private zones.

Record Set Management

Create, delete, modify, and query record sets in public and private zones.

Multi-line Record Set Management

Create, delete, modify, and query record sets of different resolution lines in public 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.

Line Group Management

Create, delete, modify, and query line groups.

Custom Line Management

Create, delete, update, and delete custom lines.

Name Server Management

Query name servers.

Quota Management

Query DNS resource quotas.

Public Zone Management

Create, query, delete, and modify public zones.

Table 2 Public zone management APIs

API

Description

Creating a Public Zone

Create a public zone.

Querying a Public Zone

Query a public zone.

Querying Public Zones

Query public zones in list.

Querying Name Servers in a Public Zone

Query name servers in a public zone.

Deleting a Public Zone

Delete a public zone.

Modifying a Public Zone

Modify a public zone.

Setting the Status of a Public Zone

Set the status of a public zone.

Private Zone Management

Create, query, delete, and modify private zones.

Table 3 Private zone management APIs

API

Description

Creating a Private Zone

Create a private zone.

Associating a VPC with a Private Zone

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 the Name Server 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.

Record Set Management

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 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.

Multi-line Record Set Management

Create, query, delete, and modify record sets with multiple resolution lines.

Table 5 Multi-line record set management APIs

API

Description

Creating a Record Set

Create a record set.

Batch Deleting Record Sets in a Zone

Batch delete record sets in a zone.

Batch Modifying Record Sets

Batch modify record sets.

Querying a Record Set

Query a record set. This API applies only to public DNS servers.

Querying Record Sets

Query record sets in list.

Batch Creating Record Sets for Lines

Batch create record sets. This API applies only to public DNS servers.

Querying Record Sets in a Zone

Query all record sets in a specified zone.

Deleting a Record Set

Delete a record set.

Modifying a Record Set

Modify a record set.

Setting Record Set Status

Set the status of a record set.

PTR Record Management

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

Table 6 PTR record management APIs

API

Description

Creating a PTR Record for an EIP

Configure a PTR record for an EIP.

Querying PTR Records of an EIP

Query the PTR record of an EIP.

Querying PTR Records

Query PTR records of EIPs.

Restoring the PTR Record of the EIP to the Default Value

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

Modifying the PTR Record of an EIP

Modify the PTR record for an EIP.

Tag Management

Add, delete, and query resource tags.

Table 7 Tag management APIs

API

Description

Adding a Tag to a Specific Resource

Add tags to a specified resource. You can add up to 10 tags to a 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.

Line Group Management

Table 8 Line group management APIs

API

Description

Creating a Line Group

Create a line group.

Querying Line Groups

Query line groups.

Querying a Line Group

Query a line group.

Updating a Line Group

Update a line group.

Deleting a Line Group

Delete a line group.

Custom Line Management

Create, delete, update, and query custom lines.

Table 9 Custom line management APIs

API

Description

Creating a Custom Line

Create a custom line.

Querying a Custom Line

Query custom lines.

Deleting a Custom Line

Delete a custom line.

Updating a Custom Line

Update a custom line.

Name Server Management

Query name servers.

Table 10 Name server management API

API

Description

Querying Name Servers

List the name servers.

Quota Management

Query DNS resource quotas.

Table 11 Quota management API

API

Description

Querying Resource Quotas

Query DNS resource quotas.