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.
Category |
Description |
---|---|
Version Management |
Query version information of all DNS APIs or a specified API. |
Public Zone Management |
Create, delete, modify, and query public zones, set the status of a public zone, and query name servers in a public zone. |
Private Zone Management |
Create, delete, modify, and query private zones, set the status of a private zone, query name servers in a private zone, and associate a VPC to or disassociate a VPC from a private zone. |
Record Set Management (New Version) |
Create, delete, modify, and query record sets, set the record set status, and query public zone lines. |
Record Set Management (To Be Deprecated) |
Create, delete, modify, and query record sets. |
PTR Record Management (New Version) |
Create, delete, modify, and query PTR records of EIPs. |
PTR Record Management (To Be Deprecated) |
Create, delete, modify, and query PTR records that map EIPs to domain names. |
Batch Operations |
Batch delete record sets in a zone, batch modify record sets, batch create record sets with lines, batch delete zones, batch delete record sets, batch delete PTR records, batch set zone status, and batch set record set status. |
Tag Management |
Create, delete, modify, and query tags for specified DNS resources. You can also create or delete tags in batches for specified DNS resources. |
Custom Line Management |
Create, delete, update, and query custom lines. |
Line Group Management |
Create, delete, modify, and query line groups. |
Name Server Management |
Query name servers. |
Quota Management |
Query DNS resource quotas. |
DNSSEC Management |
Enable, disable, and query DNSSEC. |
Endpoint Management |
Create, delete, modify, and query endpoints. |
Endpoint Rule Management |
Create, delete, modify, and query endpoint rules. |
Version Management
Query DNS API versions.
API |
Description |
---|---|
Query the versions of all DNS APIs. |
|
Query the version of a specified DNS API. |
Public Zone Management
Create, delete, modify, and query public zones, set the status of a public zone, and query name servers in a public zone.
API |
Description |
---|---|
Create a public zone. |
|
Query public zones. |
|
Query a public zone. |
|
Query name servers in a public zone. |
|
Modify a public zone. |
|
Delete a public zone. |
|
Set the status of a public zone. |
Private Zone Management
Create, delete, modify, and query private zones, set the status of a private zone, query name servers in a private zone, and associate a VPC to or disassociate a VPC from a private zone.
API |
Description |
---|---|
Create a private zone. |
|
Query private zones. |
|
Query a private zone. |
|
Query name servers in a private zone. |
|
Modify a private zone. |
|
Delete a private zone. |
|
Associate a VPC with a private zone. |
|
Disassociate a VPC from 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)
Create, delete, modify, and query record sets, set the record set status, and query public zone lines.
API |
Description |
---|---|
Create a record set. |
|
Query record sets in a zone. |
|
Query record sets. |
|
Query a record set. |
|
Modify a record set. |
|
Delete a record set. |
|
Set the record set status. |
|
Query public zone lines. |
Record Set Management (v2)
Create, delete, modify, and query record sets.
API |
Description |
---|---|
Create a record set. |
|
Query record sets in a zone. |
|
Query record sets. |
|
Query a record set. |
|
Modify a record set. |
|
Delete a record set. |
PTR Record Management (v2.1)
Create, delete, modify, and query PTR records of EIPs.
API |
Description |
---|---|
Create a PTR record for an EIP. |
|
Query PTR records of EIPs. |
|
Query the PTR record of an EIP. |
|
Modify the PTR record for an EIP. |
|
Restore the PTR record of an EIP to the default value. |
PTR Record Management (v2)
Create, delete, modify, and query PTR records of EIPs.
API |
Description |
---|---|
Create a PTR record for an EIP. |
|
Query PTR records of an EIP. |
|
Query a PTR record of an EIP. |
|
Modify the PTR record for an EIP. |
|
Restore the PTR record of an EIP to the default value. |
Batch Operations
Batch delete record sets in a zone, batch modify record sets, batch create record sets with lines, batch delete zones, batch delete record sets, batch delete PTR records, batch set zone status, and batch set record set status.
API |
Description |
---|---|
Create record sets with lines in batches. |
|
Modify record sets in batches. |
|
Delete record sets in a zone in batches. |
|
Batch set zone status. |
|
Batch set the status of record sets. |
|
Delete zones in batches. |
|
Delete record sets in batches. |
|
Delete PTR records. |
Tag Management
Create, delete, modify, and query tags for specified DNS resources. You can also create or delete tags in batches for specified DNS resources.
API |
Description |
---|---|
Add tags to a specified resource. You can add up to 10 tags to a resource. |
|
Delete a resource tag. |
|
Add or delete tags for a specified resource in batches. |
|
Query tags of a specified resource. |
|
Query all tags of a resource type. |
|
Query DNS resources by tag. Resources are sorted by creation time in descending order. |
Custom Line Management
Create, delete, update, and query custom lines.
API |
Description |
---|---|
Create a custom line. |
|
Query custom lines. |
|
Update a custom line. |
|
Delete a custom line. |
Line Group Management
Create, delete, update, and query line groups.
API |
Description |
---|---|
Create a line group. |
|
Query line groups. |
|
Query a line group. |
|
Update a line group. |
|
Delete a line group. |
Name Server Management
Query name servers.
API |
Description |
---|---|
List the name servers. |
Quota Management
Query DNS resource quotas.
API |
Description |
---|---|
Query DNS resource quotas. |
DNSSEC
Enable, disable, and query DNSSEC.
API |
Description |
---|---|
Enable DNSSEC for a public zone. |
|
Disable DNSSEC for a public zone. |
|
Query DNSSEC for a public zone. |
Endpoint Management
Create, delete, modify, and update endpoints.
API |
Description |
---|---|
Create an endpoint. |
|
Query endpoints. |
|
Query an endpoint. |
|
Modify an endpoint. |
|
Delete an endpoint. |
|
Bind an IP address to an endpoint. |
|
Query IP addresses. |
|
Unbind an IP address from an endpoint. |
|
Query VPCs of an endpoint. |
Endpoint Rule Management
Create, delete, modify, and update endpoint rules.
API |
Description |
---|---|
Create an endpoint rule. |
|
Query endpoint rules. |
|
Query an endpoint rule. |
|
Modify an endpoint rule. |
|
Delete an endpoint rule. |
|
Associate a VPC with an endpoint rule. |
|
Disassociate an endpoint rule from a VPC. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot