Before You Start

Updated on 2025-07-29 GMT+08:00

View PDF

This document describes how to use APIs to perform operations on GeminiDB instances, such as creating, deleting, and querying the instances. For details about all supported operations, see API Overview.

Before calling the APIs, ensure that you are familiar with GeminiDB concepts. For details, see Service Overview.

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.

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 assign user permissions. The domain 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.
IAM 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, 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 contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are connected using high-speed optical fibers to support 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 domains in the region associated with the project. If you need more refined access control, create subprojects under a default project and purchase resources in the subprojects. Then you can assign users the permissions required to access only the resources in specific subprojects.

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