Before You Start

Welcome to Domain Name Service API Reference. Domain Name Service (DNS) is highly available and scalable authoritative domain resolution service that translates domain names like www.example.com into IP addresses like 192.1.2.3 required for network connection. The DNS service allows users to visit your websites or web applications with domain names.

This document describes how to use APIs to perform operations such as creating, deleting, querying, or modifying DNS resources. For details about all supported operations, see API Overview.

Before you access DNS by calling APIs, get yourself familiar with DNS concepts. For details, see "Service Overview" in the Domain Name Service User Guide.

API Calling

DNS supports REST APIs that can be called over HTTPS. For details about API calling, see Calling APIs.

Endpoints

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of DNS, see Regions and Endpoints.

Concepts

Domain
A domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The domain should not be used directly to perform routine management. To ensure domain security, create Identity and Access Management (IAM) users and grant them permissions for routine management.
User
A user is created using a domain to use cloud services. Each user has its own identity credentials (password and access keys).

API authentication requires information such as the domain name, username, and password.
Region
A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.
AZ
An AZ comprises of one or more physical data centers equipped with independent ventilation, fire, water, and electricity facilities. Computing, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow you to build cross-AZ high-availability systems.
Project
A project corresponds to a region. Default projects are defined to group and physically isolate resources (including computing, storage, and network resources) across regions. Users can be granted permissions in a default project to access all resources under their domains in the region associated with the project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.

Figure 1 Project isolating model
Enterprise Project
Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from enterprise projects.

For details about enterprise projects and about how to obtain enterprise project IDs, see Enterprise Management User Guide.