2024-03-29
diff --git a/docs/dws/api-ref/dws_02_0033.html b/docs/dws/api-ref/dws_02_0033.html deleted file mode 100644 index eb29f1d11..000000000 --- a/docs/dws/api-ref/dws_02_0033.html +++ /dev/null @@ -1,13 +0,0 @@ - - -Overview
-Welcome to GaussDB(DWS). GaussDB(DWS) is a fully-managed and enterprise-level cloud data warehouse service. It is O&M-free, compatible with the PostgreSQL ecosystem, and supports online cluster scale-out and efficient loading of multiple data sources. GaussDB(DWS) helps enterprises efficiently analyze and monetize massive data online.
-This document describes how to use application programming interfaces (APIs) to create, query, and delete GaussDB(DWS) clusters, tags, and snapshots. For details about all supported operations, see API Overview.
-Before calling an API, get familiar with related concepts of GaussDB(DWS). For details, see "Service Overview" in the Data Warehouse Service User Guide.
-You can grant users permissions by using roles and policies. Roles are provided by IAM to define service-based permissions depending on users' job responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
Policy-based authorization is useful if you want to allow or deny the access to an API.
An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query the GaussDB(DWS) cluster list using an API, the user must have been granted permissions that allow the dws:openAPICluster:list action.
-Supported Actions
DWS provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Actions supported by policies are specific to APIs. The following are common concepts related to policies:
+An account has full permissions to access all APIs, but each IAM user needs to be granted the necessary permissions before they can begin using the APIs. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query the GaussDB(DWS) cluster list using an API, the user must have been granted permissions that allow the dws:openAPICluster:list action.
+Supported Actions
GaussDB(DWS) provides system-defined policies that can be directly used in IAM. Database administrators can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Actions supported by policies are specific to APIs. The following are common concepts related to policies:
- Permissions: Allow or deny operations on specified resources under specific conditions.
- APIs: RESTful APIs that can be called in a custom policy.
- Actions: Added to a custom policy to control permissions for specific operations.
- IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management.
The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.
Before You Start
- --
-
- Overview
-
- - API Calling
-
- - Endpoints
-
- - Basic Concepts
-
-
Overview
Welcome to GaussDB(DWS). GaussDB(DWS) is a fully-managed and enterprise-level cloud data warehouse service. It is O&M-free, compatible with the PostgreSQL ecosystem, and supports online cluster scale-out and efficient loading of multiple data sources. It helps enterprises efficiently analyze and monetize massive amounts of data online.
+This guide explains how to use APIs to manage GaussDB(DWS) clusters, including creating, querying, and deleting tags and snapshots. For details about all supported operations, see API Overview.
+Before calling an API, get familiar with related concepts of GaussDB(DWS). For details, see "Service Overview" in the Data Warehouse Service User Guide.
+GaussDB(DWS) supports Representational State Transfer (REST) APIs, allowing you to call APIs using 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 all services, see "Regions and Endpoints".
+Basic Concepts
- Account
An account has full access permissions for all the resources and cloud services under it. It can reset user passwords and grant users permissions. For security purposes, create IAM users and assign them permissions for routine management.
+ - User
An IAM user is created by an account to use cloud services. Each IAM user has its own identity credentials (password or access keys).
+The account name, username, and password will be required for API authentication.
+ - Region
A region is a geographic area where 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 better meet customer requirements and comply with local laws and regulations.
+ - AZ
An AZ contains one or more physical data centers. Each AZ has independent power and network devices. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected 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 accounts in the region associated with the project. For more refined access control, create subprojects under a project and apply for resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
+Figure 1 Project isolating model+
- Enterprise project
Enterprise projects group and logically isolate resources. An enterprise project can contain resources from different regions, and resources can be transferred between enterprise projects.
+
API Calling
-GaussDB(DWS) supports representational state transfer (REST) APIs, allowing you to call APIs using 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 all services, see the Regions and Endpoints section.
-Basic Concepts
-- Account
This account has full access to all cloud services and resources associated with it. It can be used to reset user passwords and grant user permissions. The domain should not be used directly to perform routine management. For security purposes, create users and grant them permissions for routine management.
- - Users
An IAM user is created using an account for cloud services. Each IAM user has its own identity credentials (password and access keys).
-The account name, username, and password are required for API authentication.
- - 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 power and network devices. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.
- - Item
Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each service region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and apply for resources in the subprojects. IAM users can then be assigned permissions to access only specific resources in the subprojects.
-Figure 1 Project isolating model-
- 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 enterprise projects.
-