Help Center/ Data Admin Service/ API Reference/ Before You Start
Updated on 2025-05-19 GMT+08:00
View PDF
Share

Before You Start

Overview

This document describes how to use APIs to perform operations on DAS, such as querying metadata locks and creating database users. For details about all supported operations, see API Overview.

Before calling DAS APIs, you need to understand concepts related to DAS. For more information, see Service Overview.

Calling Method

DAS supports Representational State Transfer (REST) APIs. You can call APIs over HTTPS. For details about calling methods, see Calling APIs.

You can add das:*:* or the DAS FullAccess system policy to call APIs.

Endpoint

An endpoint receives API calls and sends responses. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.

Constraints

For details, see the description of each API.

Concepts

  • Account

    An account is created upon successful registration with the cloud platform. The account 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 and should not be used directly to perform routine management. For security purposes, create 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).

  • 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. By creating cloud resources in different regions, you can design applications to better meet customer requirements and comply with local laws and regulations.

  • AZ

    An AZ comprises one or multiple 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 users 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 compute, storage, and network resources) between different regions. Users can be granted permissions in a default project to access all resources under their accounts 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 isolation
    • Enterprise project

      Enterprise projects group and manage resources across regions. Resources in enterprise projects are logically isolated from each other. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from the enterprise project.

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