Help Center/ Domain Name Service/ API Reference/ Before You Start
Updated on 2024-12-20 GMT+08:00
View PDF
Share

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.

API Calling

DNS supports REST APIs that can be called over HTTPS. For details, 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.

Notes and Constraints

  • The number of DNS resources you can create is determined by quota. To view or increase the quota, see Quota Adjustment.
  • For more constraints, see specific API description.

Concepts

  • Domain

    A domain is created upon successful registration with Huawei Cloud. The 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 account is a payment entity, which should not be used directly to perform routine management. To ensure account security, create Identity and Access Management (IAM) users and grant them permissions for routine management.

  • User

    An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).

    The account name, IAM username, and password will be required for API authentication.

  • Region

    Regions are divided based on geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.

    For details, see Region and AZ.

  • 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

    There is a default project automatically configured for each region. Default projects physically isolate resources (including compute, storage, and network resources) across regions. If you grant users permissions by project, the users can access all resources in the corresponding projects. 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.