A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain a cluster ID, perform the following operations:
-- Log in to the GaussDB(DWS) console.
- In the navigation pane on the left, click Clusters.
- In the cluster list, find the target cluster and click the cluster name. The Basic Information page is displayed.
- View the cluster ID.Figure 1 Viewing the cluster ID-
A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain the cluster ID, perform the following steps:
+Obtaining Cluster ID Using APIs
You can obtain the cluster ID by calling the API for creating a cluster.
+The API used to obtain a cluster ID is GET https://{Endpoint}/v1.0/{project_id}/clusters. Endpoint indicates the IAM endpoint, which can be obtained from the Regions and Endpoints. For details about Project ID, see Obtaining Project ID. For details about interface authentication, see Authentication.
+The following is an example response. The value of id under the specified clusters is the cluster ID.
+{
+ "clusters" : [ {
+ "id" : "7d85f602-a948-4a30-afd4-e84f47471c15",
+ "name" : "dws-1",
+ "status" : "AVAILABLE",
+ "version" : "1.2.0",
+ "updated" : "2016-02-10T14:28:14Z",
+ "created" : "2016-02-10T14:26:14Z",
+ "port" : 8000,
+ "endpoints" : [ {
+ "connect_info" : "192.168.0.12:8000",
+ "jdbc_url" : "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+ } ],
+ "nodes" : [ {
+ "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
+ "status" : "200"
+ }, {
+ "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
+ "status" : "200"
+ }, {
+ "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
+ "status" : "200"
+ } ],
+ "tags" : [ {
+ "key" : "key1",
+ "value" : "value1"
+ }, {
+ "key" : "key2",
+ "value" : "value2"
+ } ],
+ "user_name" : "dbadmin",
+ "number_of_node" : 3,
+ "recent_event" : 6,
+ "availability_zone" : "eu-de-01",
+ "enterprise_project_id" : "0",
+ "node_type" : "dws.d1.xlarge.ultrahigh",
+ "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
+ "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
+ "public_ip" : {
+ "public_bind_type" : "auto_assign",
+ "eip_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
+ },
+ "public_endpoints" : [ {
+ "public_connect_info" :"192.168.0.12:8000",
+ "jdbc_url" : "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+ } ],
+ "action_progress" : {
+ "SNAPSHOTTING" : "20%"
+ },
+ "sub_status" : "READONLY",
+ "task_status" : "SNAPSHOTTING",
+ "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b"
+ } ]
+}
+Obtaining Cluster ID from DWS Console
- Log in to the DWS console.
- In the navigation pane on the left, click Clusters.
- In the cluster list, find the target cluster and click the cluster name. The Cluster Information page is displayed.
- In the Basic Information area, view the cluster ID, as shown in the following figure.Figure 1 Viewing the cluster ID+
Obtaining a Project ID
-Obtaining a Project ID by Calling the API
You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.
-The API used to obtain a project ID is GET https://{Endpoint}/v3/projects/. {Endpoint} indicates the IAM endpoint and can be obtained from "Regions and Endpoints". For details about API authentication, see Authentication.
-The following is an example response. The value of id of projects indicates the project ID.
-{
+Obtaining Project ID
+Obtaining the Project ID by Calling the API
You can obtain the Project ID by calling the IAM API used to query project information based on the specified criteria.
+The API used to obtain a Project ID is GET https://{Endpoint}/v3/projects/. {Endpoint} indicates the IAM endpoint and can be obtained from "Regions and Endpoints". For details about API authentication, see Authentication.
+The following is an example response. id in projects indicates the Project ID.
+{
"projects": [
{
"domain_id": "65382450e8f64ac0870cd180d14e684b",
@@ -28,10 +28,10 @@
}
}
-Obtaining a Project ID from the Console
A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:
-- Log in to the management console.
- Click the username and select My Credential from the drop-down list.
On the My Credential page, view the project ID in the project list.
+Obtaining the Project ID from the Console
A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:
+- Log in to the management console.
- Click the username and select My Credential from the drop-down list.
On the My Credential page, view the Project ID in the project list.
-Figure 1 Viewing project IDs
+Figure 1 Viewing project IDs
diff --git a/docs/dws/api-ref/dws_02_0017.html b/docs/dws/api-ref/dws_02_0017.html
index 7adb8a1ed..7e40903bf 100644
--- a/docs/dws/api-ref/dws_02_0017.html
+++ b/docs/dws/api-ref/dws_02_0017.html
@@ -1,24 +1,61 @@
-
+
Cluster Management
-
+
+
-- Creating a Cluster
+ - Querying Flavor Information
-- Querying the Cluster List
+ - Querying the Cluster List (V2)
-- Querying Cluster Details
+ - Querying the Enterprise Project Information of a Cluster
-- Querying the Supported Node Types
+ - Querying the Cluster List
-- Deleting a Cluster
+ - Querying Cluster Details
-- Restarting a Cluster
+ - Creating a Cluster
-- Scaling Out a Cluster
+ - Performing a Check Before Cluster Creation
-- Resetting a Password
+ - Creating a Cluster (V2)
+
+- Restarting a Cluster
+
+- Resetting a Password
+
+- Modifying the Security Group of a Cluster
+
+- Performing a Switchback
+
+- Canceling Read-only Status of a Cluster
+
+- Querying Ring Node Information in the Cluster Topology
+
+- Stopping a Cluster
+
+- Starting a Cluster
+
+- Changing Cluster Time Zone
+
+- Deleting a Cluster
+
+- Deleting a Cluster (V2)
+
+- Querying the DSS Storage Pool List
+
+- Querying Flavor Details of a Cluster
+
+- Modifying Cluster Description
+
+- Querying an Instance
+
+- Querying Resource Statistics
+
+- Querying Disk Usage
+
+- Changing a Cluster Name
diff --git a/docs/dws/api-ref/dws_02_0018.html b/docs/dws/api-ref/dws_02_0018.html
deleted file mode 100644
index 9bd2a6559..000000000
--- a/docs/dws/api-ref/dws_02_0018.html
+++ /dev/null
@@ -1,536 +0,0 @@
-
-
-Querying the Cluster List
-Function
This API is used to query and display the cluster list.
-
-URI
GET /v1.0/{project_id}/clusters
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
-
-
-
-Request Parameters
None
-
-Response Parameters
-Table 2 Response body parameters Parameter
-Type
-Description
-clusters
-Array of ClusterInfo objects
-List of cluster objects
-count
-Integer
-Total number of cluster objects
-
-
-
-Table 3 ClusterInfo Parameter
-Type
-Description
-id
-String
-Cluster ID
-name
-String
-Cluster name
-status
-String
-Cluster status. The value can be one of the following:
-- CREATING
- AVAILABLE
- UNAVAILABLE
- CREATION FAILED
-version
-String
-Data warehouse version
-updated
-String
-Last modification time of a cluster. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ
-created
-String
-Cluster creation time. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ
-port
-Integer
-Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.
-endpoints
-Array of Endpoints objects
-Private network connection information about the cluster.
-nodes
-Array of Nodes objects
-Cluster instance
-tags
-Array of Tags object
-Tags in a cluster
-user_name
-String
-Administrator username
-number_of_node
-Integer
-Number of cluster nodes. For a cluster, the value ranges from 3 to 256. For a hybrid data warehouse (standalone), the value is 1.
-recent_event
-Integer
-Number of events
-availability_zone
-String
-AZ
-enterprise_project_id
-String
-Enterprise project ID. The value 0 indicates the ID of the default enterprise project.
-node_type
-String
-Node type
-vpc_id
-String
-Specifies the VPC ID.
-subnet_id
-String
-Subnet ID
-public_ip
-PublicIp object
-Public IP address. If the parameter is not specified, public connection is not used by default.
-public_endpoints
-Array of PublicEndpoints objects
-Public network connection information about the cluster. If the parameter is not specified, the public network connection information is not used by default.
-action_progress
-Map<String,String>
-Task information, consisting of a key and a value. The key indicates an ongoing task, and the value indicates the progress of the ongoing task.
-- Valid key values include:
- GROWING
- RESTORING
- SNAPSHOTTING
- REPAIRING
- CREATING
- - The value indicates the task progress.
-The following is an example:
-"action_progress":
-{"SNAPSHOTTING":"16%"}
-sub_status
-String
-Sub-status of clusters in the AVAILABLE state. The value can be one of the following:
-- NORMAL
- READONLY
- REDISTRIBUTING
- REDISTRIBUTION-FAILURE
- UNBALANCED
- UNBALANCED | READONLY
- DEGRADED
- DEGRADED | READONLY
- DEGRADED | UNBALANCED
- UNBALANCED | REDISTRIBUTING
- UNBALANCED | REDISTRIBUTION-FAILURE
- READONLY | REDISTRIBUTION-FAILURE
- UNBALANCED | READONLY | REDISTRIBUTION-FAILURE
- DEGRADED | REDISTRIBUTION-FAILURE
- DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE
- DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE
- DEGRADED | UNBALANCED | READONLY
-task_status
-String
-Cluster management task. The value can be one of the following:
-- RESTORING
- SNAPSHOTTING
- GROWING
- REBOOTING
- SETTING_CONFIGURATION
- CONFIGURING_EXT_DATASOURCE
- DELETING_EXT_DATASOURCE
- REBOOT_FAILURE: Restart failed
- RESIZE_FAILURE
-security_group_id
-String
-Security group ID
-failed_reasons
-FailedReason object
-Cause of failure. If the parameter is left empty, the cluster is in the normal state.
-
-
-
-
-Table 4 Endpoints Parameter
-Mandatory
-Type
-Description
-connect_info
-Yes
-String
-Private network connection information
-jdbc_url
-Yes
-String
-JDBC URL on the private network. The following is the default format:
-jdbc:postgresql://< connect_info>/<YOUR_DATABASE_name>
-
-
-
-Table 5 Nodes Parameter
-Type
-Description
-id
-String
-Cluster instance ID
-status
-String
-Cluster instance status
-
-
-
-Table 6 Tags Parameter
-Type
-Description
-value
-String
-Value. A value can contain a maximum of 43 Unicode characters, which can be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/
-key
-String
-Key. A key can contain a maximum of 36 Unicode characters, which cannot be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It can contain only letters, digits, hyphens (-), and underscores (_).
-
-
-
-Table 7 PublicIp Parameter
-Mandatory
-Type
-Description
-public_bind_type
-Yes
-String
-Binding type of an EIP. The value can be one of the following:
-- auto_assign
- not_use
- bind_existing
-eip_id
-No
-String
-EIP ID
-
-
-
-
-
-
-
-Example Request
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters
-
-Response example
{
- "clusters": [
- {
- "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
- "name": "dws-1",
- "status": "AVAILABLE",
- "version": "1.2.0",
- "updated": "2016-02-10T14:28:14Z",
- "created": "2016-02-10T14:26:14Z",
- "port": 8000,
- "endpoints": [{
- "connect_info": "192.168.0.12:8000",
- "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
- }] ,
- "nodes" : [ {
- "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
- "status" : "200"
- }, {
- "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
- "status" : "200"
- }, {
- "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
- "status" : "200"
- } ],
- "tags":[ {
- "key": "key1",
- "value": "value1"
- },
- {
- "key": "key2",
- "value": "value2"
- }],
- "user_name": "dbadmin",
- "number_of_node": 3,
- "recent_event": 6,
- "availability_zone": "eu-de-01",
- "enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada",
- "node_type": "dws.d1.xlarge.ultrahigh",
- "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
- "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
- "public_ip": {
- "public_bind_type": "auto_assign",
- "eip_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
- },
- "public_endpoints": [{
- "public_connect_info": "10.0.0.8:8000",
- "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
- }],
- "action_progress": {"SNAPSHOTTING": "20%"},
- "sub_status": "READONLY",
- "task_status": "SNAPSHOTTING",
- "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b"
- }],
- "count":"2"
-}
-
-Status Code
-Status Code
-Description
-200
-The cluster list is queried.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Cluster Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0019.html b/docs/dws/api-ref/dws_02_0019.html
deleted file mode 100644
index 733765d10..000000000
--- a/docs/dws/api-ref/dws_02_0019.html
+++ /dev/null
@@ -1,717 +0,0 @@
-
-
-Querying Cluster Details
-Function
This API is used to query cluster details.
-
-URI
GET /v1.0/{project_id}/clusters/{cluster_id}
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
-cluster_id
-Yes
-String
-Cluster ID. For details about how to obtain the ID, see Obtaining the Cluster ID.
-
-
-
-Request Parameters
None
-
-Response Parameters
-Table 2 Response body parameters Parameter
-Type
-Description
-cluster
-ClusterDetail object
-Cluster object
-
-
-
-Table 3 ClusterDetail Parameter
-Type
-Description
-id
-String
-Cluster ID
-name
-String
-Cluster name
-status
-String
-Cluster status. The value can be one of the following:
-- CREATING
- AVAILABLE
- UNAVAILABLE
- CREATION FAILED
-version
-String
-Data warehouse version
-updated
-String
-Last modification time of a cluster. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ
-created
-String
-Cluster creation time. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ
-port
-Integer
-Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.
-endpoints
-Array of Endpoints objects
-Private network connection information about the cluster.
-nodes
-Array of Nodes objects
-Cluster instance
-tags
-Array of Tags objects
-Cluster label
-user_name
-String
-Username of the administrator
-number_of_node
-Integer
-Number of cluster nodes. For a cluster, the value ranges from 3 to 256. For a hybrid data warehouse (standalone), the value is 1.
-recent_event
-Integer
-Number of events
-availability_zone
-String
-AZ
-enterprise_project_id
-String
-Enterprise project ID. The value 0 indicates the ID of the default enterprise project.
-node_type
-String
-Node type .
-vpc_id
-String
-VPC ID
-subnet_id
-String
-Subnet ID
-public_ip
-PublicIp object
-Public IP address. If the parameter is not specified, public connection is not used by default.
-public_endpoints
-Array of PublicEndpoints objects
-Public network connection information about the cluster. If the parameter is not specified, the public network connection information is not used by default.
-action_progress
-Map<String,String>
-The key indicates an ongoing task. The value can be one of the following:
-- GROWING
- RESTORING
- SNAPSHOTTING
- REPAIRING
- CREATING
-The value indicates the task progress.
-sub_status
-String
-Sub-status of clusters in the AVAILABLE state. The value can be one of the following:
-- NORMAL
- READONLY
- REDISTRIBUTING
- REDISTRIBUTION-FAILURE
- UNBALANCED
- UNBALANCED | READONLY
- DEGRADED
- DEGRADED | READONLY
- DEGRADED | UNBALANCED
- UNBALANCED | REDISTRIBUTING
- UNBALANCED | REDISTRIBUTION-FAILURE
- READONLY | REDISTRIBUTION-FAILURE
- UNBALANCED | READONLY | REDISTRIBUTION-FAILURE
- DEGRADED | REDISTRIBUTION-FAILURE
- DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE
- DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE
- DEGRADED | UNBALANCED | READONLY
-task_status
-String
-Cluster management task. The value can be one of the following:
-- RESTORING
- SNAPSHOTTING
- GROWING
- REBOOTING
- SETTING_CONFIGURATION
- CONFIGURING_EXT_DATASOURCE
- DELETING_EXT_DATASOURCE
- REBOOT_FAILURE
- RESIZE_FAILURE
-parameter_group
-ParameterGroup object
-Parameter group details
-node_type_id
-String
-Node type ID
-security_group_id
-String
-Security group ID
-private_ip
-Array of strings
-List of private network IP addresses
-maintain_window
-MaintainWindow object
-Cluster maintenance window
-resize_info
-ResizeInfo object
-Cluster scale-out details
-failed_reasons
-FailedReason object
-Cause of failure. If the parameter is left empty, the cluster is in the normal state.
-
-
-
-Table 4 Endpoints Parameter
-Mandatory
-Type
-Description
-connect_info
-Yes
-String
-Private network connection information
-jdbc_url
-Yes
-String
-JDBC URL on the private network. The following is the default format:
-jdbc:postgresql://< connect_info>/<YOUR_DATABASE_name>
-
-
-
-Table 5 Nodes Parameter
-Type
-Description
-id
-String
-Cluster instance ID
-status
-String
-Cluster instance status
-
-
-
-Table 6 Tags Parameter
-Type
-Description
-key
-String
-Key. A key can contain a maximum of 36 Unicode characters, which cannot be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/
-value
-String
-Value. A value can contain a maximum of 43 Unicode characters, which can be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It can contain only letters, digits, hyphens (-), and underscores (_).
-
-
-
-
-Table 7 PublicIp Parameter
-Mandatory
-Type
-Description
-public_bind_type
-Yes
-String
-Binding type of an EIP. The value can be one of the following:
-- auto_assign
- not_use
- bind_existing
-eip_id
-No
-String
-EIP ID
-
-
-
-Table 8 PublicEndpoints Parameter
-Mandatory
-Type
-Description
-public_connect_info
-No
-String
-Public network connection information
-jdbc_url
-No
-String
-JDBC URL of the public network. The following is the default format:
-jdbc:postgresql://< public_connect_info>/<YOUR_DATABASE_name>
-
-
-
-Table 9 ParameterGroup Parameter
-Mandatory
-Type
-Description
-id
-Yes
-String
-Parameter group ID
-name
-Yes
-String
-Parameter group name
-status
-Yes
-String
-Cluster parameter status. The value can be one of the following:
-- In-Sync: synchronized
- Applying: in application
- Pending-Reboot: restart for the modification to take effect
- Sync-Failure: application failure
-
-
-
-Table 10 MaintainWindow Parameter
-Mandatory
-Type
-Description
-day
-No
-String
-Maintenance time in each week in the unit of day. The value can be one of the following:
-- Mon
- Tue
- Wed
- Thu
- Fri
- Sat
- Sun
-start_time
-No
-String
-Maintenance start time in HH:mm format. The time zone is GMT+0.
-end_time
-No
-String
-Maintenance end time in HH:mm format. The time zone is GMT+0.
-
-
-
-Table 11 ResizeInfo Parameter
-Type
-Description
-target_node_num
-Integer
-Number of nodes after the scale-out
-origin_node_num
-Integer
-Number of nodes before the scale-out
-resize_status
-String
-Scale-out status. The value can be one of the following:
-- GROWING
- RESIZE_FAILURE
-start_time
-String
-Scale-out start time. Format: ISO8601:YYYY-MM-DDThh:mm:ss
-
-
-
-
-
-Example Request
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7
-
-Response example
{
- "cluster": {
- "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
- "name": "dws-1",
- "status": "AVAILABLE",
- "version": "1.2.0",
- "updated": "2018-02-10T14:28:14Z",
- "created": "2018-02-10T14:28:14Z",
- "port": 8000,
- "endpoints": [{
- "connect_info": "192.168.0.10:8000",
- "jdbc_url": "jdbc:postgresql://192.168.0.10:8000/<YOUR_DATABASE_name>"
- }],
- "nodes" : [ {
- "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
- "status" : "200"
- }, {
- "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
- "status" : "200"
- }, {
- "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
- "status" : "200"
- } ],
- "tags":[ {
- "key": "key1",
- "value": "value1"
- },
- {
- "key": "key2",
- "value": "value2"
- } ],
- "user_name": "dbadmin",
- "number_of_node": 3,
- "recent_event": 6,
- "availability_zone": "eu-de-01",
- "enterprise_project_id": "6a6a18fe-417a-4188-9214-75fd08c22065",
- "node_type": "dws.m1.xlarge.ultrahigh",
- "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
- "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
- "public_ip": {
- "public_bind_type": "auto_assign",
- "eip_id": "85b20d7e-9etypeb2a-98f3-3c8843ea3574"
- },
- "public_endpoints": [ {
- "public_connect_info": "10.0.0.8:8000",
- "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
- } ],
- "action_progress": {"SNAPSHOTTING": "20%"},
- "sub_status": "READONLY",
- "task_status": "SNAPSHOTTING",
- "parameter_group": {
- "id": "157e9cc4-64a8-11e8-adc0-fa7ae01bbebc",
- "name": "Default-Parameter-Group-dws ",
- "status": "In-Sync"
- },
- "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
- "private_ip":["192.168.0.12","192.168.0.66"],
- "maintain_window": {
- "day": "Wed",
- "start_time": "22:00",
- "end_time": "02:00"
- },
- "resize_info" : {
- "target_node_num": "6",
- "origin_node_num": "3",
- "resize_status": "GROWING",
- "start_time": "2018-02-14T14:28:14Z"
- }
- }
-}
-
-Status Code
-Status Code
-Description
-200
-Cluster details have been queried successfully.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Cluster Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0020.html b/docs/dws/api-ref/dws_02_0020.html
deleted file mode 100644
index e109b3d70..000000000
--- a/docs/dws/api-ref/dws_02_0020.html
+++ /dev/null
@@ -1,378 +0,0 @@
-
-
-Creating a Cluster
-Function
This API is used to create clusters.
-The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.
-This API is an asynchronous API. It takes 10 to 15 minutes to create a cluster.
-
-URI
POST /v1.0/{project_id}/clusters
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
-
-
-
-
-Request Parameters
-Table 2 Request body parameters Parameter
-Mandatory
-Type
-Description
-cluster
-Yes
-CreateClusterInfo object
-Cluster object
-
-
-
-Table 3 CreateClusterInfo Parameter
-Mandatory
-Type
-Description
-node_type
-Yes
-String
-Node type
-number_of_node
-Yes
-Integer
-Number of cluster nodes. For a cluster, the value ranges from 3 to 256. For a hybrid data warehouse (standalone), the value is 1.
-subnet_id
-Yes
-String
-Subnet ID, which is used for configuring cluster network.
-security_group_id
-Yes
-String
-ID of a security group, which is used for configuring cluster network.
-vpc_id
-Yes
-String
-VPC ID, which is used for configuring cluster network.
-availability_zone
-No
-String
-AZ of a cluster
-port
-No
-Integer
-Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.
-name
-Yes
-String
-Cluster name, which must be unique. The cluster name must contain 4 to 64 characters, which must start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.
-user_name
-Yes
-String
-Administrator username for logging in to a GaussDB(DWS) cluster. The administrator username must:
-- Consist of lowercase letters, digits, or underscores.
- Start with a lowercase letter or an underscore.
- Contain 1 to 63 characters.
- Cannot be a keyword of the GaussDB(DWS) database.
-user_pwd
-Yes
-String
-Administrator password for logging in to a GaussDB(DWS) cluster
-- Contains 12 to 32 characters.
- Contains at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters (~!?, .:;-_(){}[]/<>@# %^&*+|\=).
- Cannot be the same as the username or the username written in reverse order.
-public_ip
-No
-PublicIp object
-Public IP address. If the parameter is not specified, public connection is not used by default.
-number_of_cn
-No
-Integer
-Number of deployed CNs. The value ranges from 2 to the number of cluster nodes. The maximum value is 20 and the default value is 3.
-tags
-No
-Tags object
-Label.
-enterprise_project_id
-No
-String
-Enterprise project. The default enterprise project ID is 0.
-
-
-
-Table 4 PublicIp Parameter
-Mandatory
-Type
-Description
-public_bind_type
-Yes
-String
-Binding type of an EIP. The value can be one of the following:
-- auto_assign
- not_use
- bind_existing
-eip_id
-No
-String
-EIP ID
-
-
-
-Table 5 Tags Parameter
-Mandatory
-Type
-Description
-key
-Yes
-String
-Key. A tag key can contain a maximum of 128 Unicode characters, which cannot be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/
-value
-Yes
-String
-Value. A tag value can contain a maximum of 255 Unicode characters, which can be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/
-
-
-
-Response Parameters
-Table 6 Response body parameters Parameter
-Type
-Description
-cluster
-Cluster object
-Cluster object
-
-
-
-
-
-Example Request
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters
-
-{
-"cluster": {
- "node_type": "dws.m1.xlarge.ultrahigh",
- "number_of_node": 3,
- "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
- "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
- "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
- "availability_zone": "eu-de-01",
- "port": 8000,
- "name": "dws-1",
- "user_name": "dbadmin",
- "user_pwd": "Password!",
- "public_ip": {
- "public_bind_type": "auto_assign",
- "eip_id": ""
- },
- "enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada" }
-}
-
-Example Responses
{
- "cluster": {
- "id": "7d85f602-a948-4a30-afd4-e84f47471c15"
- }
-}
-
-Status Code
-Status Code
-Description
-200
-The cluster has been successfully created.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Cluster Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0021.html b/docs/dws/api-ref/dws_02_0021.html
deleted file mode 100644
index 09b9d5e65..000000000
--- a/docs/dws/api-ref/dws_02_0021.html
+++ /dev/null
@@ -1,126 +0,0 @@
-
-
-Deleting a Cluster
-Function
This API is used to delete clusters. All resources of the deleted cluster, including customer data, will be released. For data security, create a snapshot for the cluster that you want to delete before deleting the cluster.
-
-URI
DELETE /v1.0/{project_id}/clusters/{cluster_id}
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
-cluster_id
-Yes
-String
-ID of the cluster to be deleted. For details about how to obtain the ID, see Obtaining the Cluster ID.
-
-
-
-Request Parameters
-Table 2 Request body parameters Parameter
-Mandatory
-Type
-Description
-keep_last_manual_snapshot
-Yes
-Integer
-Keeps the latest manual snapshot.
-
-
-
-Response Parameters
None
-
-Example Request
DELETE https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
-
-{
- "keep_last_manual_snapshot" : 0
-}
-
-Example Responses
None
-
-Status Code
-Status Code
-Description
-202
-The cluster has been terminated.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Cluster Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0022.html b/docs/dws/api-ref/dws_02_0022.html
deleted file mode 100644
index 0d4265621..000000000
--- a/docs/dws/api-ref/dws_02_0022.html
+++ /dev/null
@@ -1,425 +0,0 @@
-
-
-Querying the Supported Node Types
-Function
This API is used to query the node types supported by GaussDB(DWS).
-
-URI
GET /v2/{project_id}/node-types
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
-
-
-
-Request Parameters
None
-
-Response Parameters
-Table 2 Response body parameters Parameter
-Type
-Description
-node_types
-Array of NodeTypes objects
-List of node type objects
-count
-Integer
-Total number of node types.
-
-
-
-Table 3 NodeTypes Parameter
-Type
-Description
-spec_name
-String
-Name of a node type
-detail
-Array of Detail objects
-Node type details
-id
-String
-Node type ID
-datastore_type
-String
-Product type
-
-available_zones
-Array of NodeTypeAvailableZones objects
-Supported AZs and their statuses
-ram
-Integer
-Memory size
-vcpus
-Integer
-Number of CPUs
-datastores
-Array of NodeTypeDatastores objects
-Kernel version information
-volume
-VolumeResp object
-For a fixed storage flavor, the value is the storage of its typical configuration. For an elastic storage flavor, the value null.
-elastic_volume_specs
-Array of NodeTypeElasticVolumeSpecs objects
-If the specification is elastic, this attribute indicates the typical specification, including the storage type, minimum capacity, maximum capacity, and step. If the specification is fixed, this attribute is null.
-
-
-
-Table 4 Detail Parameter
-Type
-Description
-type
-String
-Attribute type
-value
-String
-Attribute value
-unit
-String
-Attribute unit
-
-
-
-Table 5 NodeTypeAvailableZones Parameter
-Type
-Description
-code
-String
-AZ ID
-status
-String
-Availability status of a node type.
-
-
-
-
-Table 6 NodeTypeDatastores Parameter
-Type
-Description
-version
-String
-OS kernel version
-attachments
-Attachments object
-Additional information about the kernel version
-
-
-
-Table 7 attachments Parameter
-Type
-Description
-min_cn
-String
-Minimum CNs allowed by the kernel version
-max_cn
-String
-Maximum CNs allowed by the kernel version
-
-
-
-
-
-
-
-Example Request
GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/node-types
-
-Response Example
{
- "node_types" : [ {
- "spec_name" : "dws.d2.xlarge",
- "id" : "ebe532d6-665f-40e6-a4d4-3c51545b6a67",
- "datastore_type" : "dws",
- "available_zones" : [ {
- "code" : "az1",
- "status" : "normal"
- } ],
- "ram" : 32,
- "vcpus" : 4,
- "datastores" : [ {
- "version" : "8.1.3.200",
- "attachments" : {
- "min_cn" : 2,
- "max_cn" : 20
- }
- } ],
- "volume" : {
- "type" : "SSD",
- "size" : 160
- },
- "elastic_volume_specs" : [ {
- "type" : "SSD",
- "step" : 100,
- "min_size" : 100,
- "max_size" : 32000
- } ],
- "detail" : [ {
- "type" : "vCPU",
- "value" : "4"
- }, {
- "value" : "1675",
- "type" : "LOCAL_DISK",
- "unit" : "GB"
- }, {
- "type" : "mem",
- "value" : "32",
- "unit" : "GB"
- } ]
- } ],
- "count" : 1
-}
-
-Status Code
-Status Code
-Description
-200
-The node type is queried successfully.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Cluster Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0023.html b/docs/dws/api-ref/dws_02_0023.html
index 74c06a401..0599b36a5 100644
--- a/docs/dws/api-ref/dws_02_0023.html
+++ b/docs/dws/api-ref/dws_02_0023.html
@@ -1,19 +1,37 @@
-
+
-Snapshot Management APIs
-A GaussDB(DWS) snapshot is a complete backup of a cluster. Snapshots are stored in the storage space of Object Storage Service (OBS). A snapshot can be used to restore a cluster to a newly created one that has the same flavor. Currently, you can only restore a cluster to a new one.
+Snapshot Management
+
-- Creating a Snapshot
+ - Querying Snapshot Statistics
-- Querying the Snapshot List
+ - Checking the Name of the Table to Be Restored
-- Querying Snapshot Details
+ - Restoring a Table
-- Deleting a Manual Snapshot
+ - Creating a Snapshot
-- Restoring a Cluster
+ - Querying the Snapshot List
+
+- Querying the Cluster Snapshot List
+
+- Querying a Snapshot Policy
+
+- Querying Snapshot Details
+
+- Deleting a Snapshot Policy
+
+- Deleting a Snapshot
+
+- Restoring a Cluster
+
+- Querying Flavors by Snapshot ID
+
+- Copying a Snapshot
+
+- Adding a Snapshot Policy
diff --git a/docs/dws/api-ref/dws_02_0024.html b/docs/dws/api-ref/dws_02_0024.html
deleted file mode 100644
index 1069feff4..000000000
--- a/docs/dws/api-ref/dws_02_0024.html
+++ /dev/null
@@ -1,219 +0,0 @@
-
-
-Querying the Snapshot List
-Function
This API is used to query the snapshot list.
-
-URI
GET /v1.0/{project_id}/snapshots
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
-
-
-
-Request Parameters
None
-
-Response Parameters
-Table 2 Response body parameters Parameter
-Type
-Description
-snapshots
-Array of Snapshots objects
-List of snapshot objects
-count
-Integer
-Total number of snapshot objects
-
-
-
-Table 3 Snapshots Parameter
-Type
-Description
-id
-String
-Snapshot ID
-name
-String
-Snapshot name
-description
-String
-Snapshot description
-started
-String
-Time when a snapshot starts to be created. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ
-finished
-String
-Time when a snapshot is complete. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ
-size
-Double
-Snapshot size, in GB
-status
-String
-Snapshot status:
-- CREATING
- AVAILABLE
- UNAVAILABLE
-type
-String
-Snapshot type. It can be:
-- MANUAL
- AUTOMATED
-cluster_id
-String
-ID of the cluster for which snapshots are created. For details about how to obtain the ID, see Obtaining the Cluster ID.
-
-
-
-Example Request
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots
-
-Response Example
{
- "snapshots": [
- {
- "id": "2a4d0f86-67cd-408a-8b66-017454fb7793",
- "name": "snapshot-1",
- "description": "",
- "started": "2016-08-23T03:59:23Z",
- "finished": "2016-08-23T04:01:40Z",
- "size": 500,
- "status": "AVAILABLE",
- "type": "MANUAL",
- "cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
- },
- {
- "id": "4af11460-06ec-48a4-b3ad-0e3bbdcd8ab1",
- "name": "snapshot-2",
- "description": "",
- "started": "2016-08-23T18:20:00Z",
- "finished": "2016-08-23T18:22:12Z",
- "size": 500,
- "status": "AVAILABLE",
- "type": "MANUAL",
- "cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
- }
- ],
- "count":2
-}
-
-Status Code
-Status Code
-Description
-200
-The snapshot list is queried.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Snapshot Management APIs
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0025.html b/docs/dws/api-ref/dws_02_0025.html
deleted file mode 100644
index 6c2de08fd..000000000
--- a/docs/dws/api-ref/dws_02_0025.html
+++ /dev/null
@@ -1,404 +0,0 @@
-
-
-Querying Snapshot Details
-Function
This API is used to query snapshot details by using the snapshot ID.
-
-URI
GET /v1.0/{project_id}/snapshots/{snapshot_id}
-
-Table 1 URI parameter description Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
-snapshot_id
-Yes
-String
-Snapshot ID
-
-
-
-Request Parameters
None
-
-Response Parameters
-Table 2 Response body parameters Parameter
-Type
-Description
-snapshot
-SnapshotDetail object
-Snapshot object
-
-
-
-Table 3 SnapshotDetail Parameter
-Type
-Description
-id
-String
-Snapshot ID
-name
-String
-Snapshot name
-description
-String
-Snapshot description
-started
-String
-Time when a snapshot starts to be created. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ
-finished
-String
-Time when a snapshot is complete. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ
-size
-Double
-Snapshot size, in GB
-status
-String
-Snapshot status:
-- CREATING
- AVAILABLE
- UNAVAILABLE
-type
-String
-Snapshot type. It can be:
-- MANUAL
- AUTOMATED
-cluster_id
-String
-ID of the cluster for which snapshots are created.
-cluster_name
-String
-Name of the cluster for which the snapshot is created
-backup_key
-String
-Key generated during backup
-prior_backup_key
-String
-Backup key of the previous snapshot used by the incremental backup The value FULL indicates a full snapshot.
-base_backup_key
-String
-Backup key of a full snapshot
-backup_device
-String
-Backup media
-total_backup_size
-Long
-Accumulated size of a snapshot, from the full backup to the incremental backup. Unit: KB
-base_backup_name
-String
-Name of a full snapshot
-support_inplace_restore
-Boolean
-Whether data can be restored to the original cluster
-fine_grained_backup
-Boolean
-Whether the backup is a fine-grained backup
-fine_grained_backup_detail
-FineGrainedSnapshotDetail object
-Fine-grained backup information
-guest_agent_version
-String
-GuestAgent version
-cluster_status
-String
-Cluster status
-
-bak_expected_start_time
-String
-Estimated snapshot start time
-bak_keep_day
-Integer
-Backup retention days
-bak_period
-String
-Cluster policy
-db_user
-String
-Backup user
-datastore
-DataStore object
-Database version
-progress
-String
-Backup progress
-backup_level
-String
-Backup level
-- cluster
- schema
-
-
-
-
-
-
-
-Request Message
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/b5c45780-1006-49e3-b2d5-b3229975bbc7
-
-Response Message
{
- "snapshot": {
- "id": "2a4d0f86-67cd-408a-8b66-017454fb7793",
- "name": "snapshot-1",
- "description": "snapshot description",
- "started": "2016-08-23T03:59:23Z",
- "finished": "2016-08-23T04:01:40Z",
- "size": 500,
- "status": "AVAILABLE",
- "type": "MANUAL",
- "cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
- }
-}
-
-Status Code
-Status Code
-Description
-200
-The snapshot details are queried.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Snapshot Management APIs
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0026.html b/docs/dws/api-ref/dws_02_0026.html
index cdc29df44..c7d576ffb 100644
--- a/docs/dws/api-ref/dws_02_0026.html
+++ b/docs/dws/api-ref/dws_02_0026.html
@@ -1,203 +1,56 @@
-
+
-Creating a Snapshot
-Function
This API is used to create snapshots for a specified cluster.
-
-URI
POST /v1.0/{project_id}/snapshots
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
-
-
-
-Request Parameters
-Table 2 Request body parameters Parameter
-Mandatory
-Type
-Description
-snapshot
-Yes
-Snapshot object
-Snapshot object
-
-
-
-Table 3 Snapshot Parameter
-Mandatory
-Type
-Description
-name
-Yes
-String
-Snapshot name, which must be unique and start with a letter. It consists of 4 to 64 characters, which are case-insensitive and contain letters, digits, hyphens (-), and underscores (_) only.
-cluster_id
-Yes
-String
-ID of the cluster for which you want to create a snapshot. For details about how to obtain the ID, see Obtaining the Cluster ID.
-description
-No
-String
-Snapshot description. If no value is specified, the description is empty. Enter a maximum of 256 characters. The following special characters are not allowed: !<>'=&"
-
-
-
-Response Parameters
-Table 4 Response body parameters Parameter
-Type
-Description
-snapshot
-SnapshotResp object
-Snapshot object
-
-
-
-
-
-Example Request
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots
-
-{
- "snapshot" : {
- "name" : "snapshot-3",
- "cluster_id" : "44b277eb-39be-4921-be31-3d61b43651d7",
- "description" : "Snapshot-3 description"
- }
-}
-
-Example Response
{
- "snapshot": {
- "id": "2a4d0f86-67cd-408a-8b66-017454fb7793"
- }
-}
-
-Status Code
-Status Code
-Description
-200
-The snapshot is created.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
+Node Change
+
+
+- Expanding Disk Capacity
+
+- Querying the Disk Capacity Expansion Range
+
+- Querying the List of Target Flavors That a Cluster Can Be Changed To
+
+- Querying CN Nodes of a Cluster
+
+- Adding CN Nodes in Batches
+
+- Deleting CN Nodes in Batches
+
+- Scaling Out a Cluster
+
+- Performing a Scale-Out Check
+
+- Scaling Out a Cluster with Idle Nodes
+
+- Querying the Node List
+
+- Deleting Idle Nodes
+
+- Performing a Redistribution Task
+
+- Querying Redistribution Details
+
+- Modifying Redistribution Configurations
+
+- Changing the Priority of a Redistribution Table
+
+- Querying the Schema Information of the Table to Be Redistributed
+
+- Suspending Redistribution
+
+- Querying the Number of Nodes to Be Removed from a Cluster for Better Performance
+
+- Resuming Redistribution
+
+- Performing a Scale-in Check
+
+- Scaling In a Cluster
+
+
+
-Parent topic: Snapshot Management APIs
+Parent topic: API Description
diff --git a/docs/dws/api-ref/dws_02_0027.html b/docs/dws/api-ref/dws_02_0027.html
deleted file mode 100644
index 7b5c077ef..000000000
--- a/docs/dws/api-ref/dws_02_0027.html
+++ /dev/null
@@ -1,100 +0,0 @@
-
-
-Deleting a Manual Snapshot
-Function
This API is used to delete a specified manual snapshot.
-
-URI
DELETE /v1.0/{project_id}/snapshots/{snapshot_id}
-
-Table 1 URI parameter description Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
-snapshot_id
-Yes
-String
-Snapshot ID
-
-
-
-Request Parameters
None
-
-Response Parameters
None
-
-Example Requests
DELETE https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
-
-Example Response
None
-
-Status Code
-Status Code
-Description
-202
-The snapshot is deleted.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Snapshot Management APIs
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0030.html b/docs/dws/api-ref/dws_02_0030.html
index 3c1e2db83..a057c5e23 100644
--- a/docs/dws/api-ref/dws_02_0030.html
+++ b/docs/dws/api-ref/dws_02_0030.html
@@ -1,1196 +1,1196 @@
-
+
Error Code
-No data is returned if an API fails to be called. You can locate the cause of error according to the error code of each API. When the calling fails, HTTP status code 4xx or 5xx is returned. The returned message body contains the specific error code and error information. If you fail to locate the cause of error, contact the database customer service and technical support and provide the error code so that we can help you solve the problem as soon as possible.
+No data is returned if an API fails to be called. You can locate the cause of error according to the error code of each API. When the calling fails, HTTP status code 4xx or 5xx is returned. The returned message body contains the specific error code and error information. If you fail to locate the cause of error, contact the database customer service and technical support and provide the error code so that we can help you solve the problem as soon as possible.
-Table 1 Error code Status Code
+Table 1 Error code Status Code
Error Code
+Error Code
Error Information
+Error Information
Description
+Description
Solution
+Solution
400
+400
DWS.5001
+DWS.5001
Invalid instance name.
+Invalid instance name.
Invalid instance name.
+Invalid instance name.
Enter a valid instance name according to the instance name description and try again later.
+Enter a valid instance name according to the instance name description and try again later.
400
+400
DWS.5002
+DWS.5002
Invalid database type.
+Invalid database type.
Invalid database type.
+Invalid database type.
Enter a valid database type according to the database parameter description and try again later.
+Enter a valid database type according to the database parameter description and try again later.
400
+400
DWS.5003
+DWS.5003
Invalid database version.
+Invalid database version.
Invalid database version.
+Invalid database version.
Enter a valid database version according to the database parameter description and try again later.
+Enter a valid database version according to the database parameter description and try again later.
400
+400
DWS.5004
+DWS.5004
Empty datastore field.
+Empty datastore field.
Empty datastore field.
+Empty datastore field.
Enter the correct datastore according to the actual situation and try again later.
+Enter the correct datastore according to the actual situation and try again later.
400
+400
DWS.5005
+DWS.5005
Database type or version not supported.
+Database type or version not supported.
Database type or version not supported.
+Database type or version not supported.
Enter a valid database type and version according to the database parameter description and try again later.
+Enter a valid database type and version according to the database parameter description and try again later.
400
+400
DWS.5006
+DWS.5006
Invalid specifications.
+Invalid specifications.
Invalid specifications.
+Invalid specifications.
Select the correct flavor and try again later.
+Select the correct flavor and try again later.
400
+400
DWS.5010
+DWS.5010
Invalid region.
+Invalid region.
Invalid region.
+Invalid region.
Select a valid region and try again.
+Select a valid region and try again.
400
+400
DWS.5011
+DWS.5011
Invalid AZ.
+Invalid AZ.
Invalid AZ.
+Invalid AZ.
Select a valid AZ and try again.
+Select a valid AZ and try again.
400
+400
DWS.5012
+DWS.5012
The region or AZ does not exist.
+The region or AZ does not exist.
The region or AZ does not exist.
+The region or AZ does not exist.
Enter a correct region or AZ and try again later.
+Enter a correct region or AZ and try again later.
400
+400
DWS.5013
+DWS.5013
Invalid password of database root.
+Invalid password of database root.
Invalid password of database root.
+Invalid password of database root.
Enter a valid password according to the password description.
+Enter a valid password according to the password description.
400
+400
DWS.5014
+DWS.5014
Invalid VPC ID.
+Invalid VPC ID.
Invalid VPC ID.
+Invalid VPC ID.
Enter a valid ID according to the description of parameter vpc_id.
+Enter a valid ID according to the description of parameter vpc_id.
400
+400
DWS.5015
+DWS.5015
Invalid subnet ID.
+Invalid subnet ID.
Invalid subnet ID.
+Invalid subnet ID.
Enter a valid ID according to the description of parameter subnet_id.
+Enter a valid ID according to the description of parameter subnet_id.
400
+400
DWS.5016
+DWS.5016
Invalid security group ID.
+Invalid security group ID.
Invalid security group ID.
+Invalid security group ID.
Enter a valid ID according to the description of the security group ID parameter.
+Enter a valid ID according to the description of the security group ID parameter.
400
+400
DWS.5017
+DWS.5017
Invalid retention period of automated backups.
+Invalid retention period of automated backups.
Invalid retention period of automated backups.
+Invalid retention period of automated backups.
Enter a proper retention period and try again later.
+Enter a proper retention period and try again later.
400
+400
DWS.5018
+DWS.5018
Invalid automated backup period.
+Invalid automated backup period.
Invalid automated backup period.
+Invalid automated backup period.
Enter a proper automated backup period and try again later.
+Enter a proper automated backup period and try again later.
404
+404
DWS.5021
+DWS.5021
The VPC does not exist or does not belong to the user.
+The VPC does not exist or does not belong to the user.
The VPC does not exist or does not belong to the user.
+The VPC does not exist or does not belong to the user.
Enter a correct VPC and try again later.
+Enter a correct VPC and try again later.
404
+404
DWS.5022
+DWS.5022
The subnet does not exist or does not belong to the VPC.
+The subnet does not exist or does not belong to the VPC.
The subnet does not exist or does not belong to the VPC.
+The subnet does not exist or does not belong to the VPC.
Enter a correct subnet and try again later.
+Enter a correct subnet and try again later.
404
+404
DWS.5023
+DWS.5023
The security group does not exist or does not belong to the VPC.
+The security group does not exist or does not belong to the VPC.
The security group does not exist or does not belong to the VPC.
+The security group does not exist or does not belong to the VPC.
Enter a correct security group and try again later.
+Enter a correct security group and try again later.
400
+400
DWS.5027
+DWS.5027
Invalid AZ.
+Invalid AZ.
Invalid AZ.
+Invalid AZ.
Enter a correct AZ and try again later.
+Enter a correct AZ and try again later.
400
+400
DWS.5033
+DWS.5033
The volume size is not a multiple of 10.
+The volume size is not a multiple of 10.
The volume size is not a multiple of 10.
+The volume size is not a multiple of 10.
Enter a valid size and try again.
+Enter a valid size and try again.
400
+400
DWS.5034
+DWS.5034
Flavors do not match.
+Flavors do not match.
Flavors do not match.
+Flavors do not match.
Select a correct flavor and try again.
+Select a correct flavor and try again.
403
+403
DWS.5036
+DWS.5036
Datastore does not exist or does not have sufficient permissions.
+Datastore does not exist or does not have sufficient permissions.
Datastore does not exist or does not have sufficient permissions.
+Datastore does not exist or does not have sufficient permissions.
Enter a correct Datastore and try again.
+Enter a correct Datastore and try again.
400
+400
DWS.5037
+DWS.5037
The parameter does not exist.
+The parameter does not exist.
The parameter does not exist.
+The parameter does not exist.
Enter the correct parameter group and try again.
+Enter a valid parameter and try again.
400
+400
DWS.5038
+DWS.5038
The parameter value is out of range.
+The parameter value is out of range.
The parameter value is out of range.
+The parameter value is out of range.
Enter a valid parameter and try again.
+Enter a valid parameter and try again.
400
+400
DWS.5039
+DWS.5039
Duplicate parameters.
+Duplicate parameters.
Duplicate parameters.
+Duplicate parameters.
Enter a valid parameter and try again.
+Enter a valid parameter and try again.
400
+400
DWS.5045
+DWS.5045
The current tenant is not allowed to perform this operation.
+The current tenant is not allowed to perform this operation.
The current tenant is not allowed to perform this operation.
+The current tenant is not allowed to perform this operation.
Ensure that the current tenant is the same as the tenant to which the cluster belongs and try again.
+Ensure that the current tenant is the same as the tenant to which the cluster belongs and try again.
400
+400
DWS.5046
+DWS.5046
nics is left black.
+nics is left black.
nics is left black.
+nics is left black.
Enter a correct nics and try again.
+Enter a correct nics and try again.
400
+400
DWS.5047
+DWS.5047
Invalid instance quantity.
+Invalid instance quantity.
Invalid instance quantity.
+Invalid instance quantity.
Enter a correct instance quantity.
+Enter a correct instance quantity.
400
+400
DWS.5048
+DWS.5048
Invalid extended parameter.
+Invalid extended parameter.
Invalid extended parameter.
+Invalid extended parameter.
Enter a valid extended parameter according to the corresponding description of the extended parameter.
+Enter a valid extended parameter according to the corresponding description of the extended parameter.
409
+409
DWS.5050
+DWS.5050
The cluster name already exists.
+The cluster name already exists.
The cluster name already exists.
+The cluster name already exists.
Enter a correct cluster name and try again later.
+Enter a correct cluster name and try again later.
400
+400
DWS.5051
+DWS.5051
Invalid IP address.
+Invalid IP address.
Invalid IP address.
+Invalid IP address.
Enter a valid IP address and try again.
+Enter a valid IP address and try again.
400
+400
DWS.5052
+DWS.5052
Invalid value of the AZ.
+Invalid value of the AZ.
Invalid value of the AZ.
+Invalid value of the AZ.
Enter a correct AZ and try again later.
+Enter a correct AZ and try again later.
400
+400
DWS.5053
+DWS.5053
The value of locality between instances is invalid.
+The value of locality between instances is invalid.
The value of locality between instances is invalid.
+The value of locality between instances is invalid.
Enter a correct locality value and try again later.
+Enter a correct locality value and try again later.
400
+400
DWS.5054
+DWS.5054
The parameter group ID is invalid.
+The parameter group ID is invalid.
The parameter group ID is invalid.
+The parameter group ID is invalid.
Enter a correct parameter group ID and try again later.
+Enter a correct parameter group ID and try again later.
400
+400
DWS.5056
+DWS.5056
Invalid string length.
+Invalid string length.
Invalid string length.
+Invalid string length.
Enter a valid string and try again.
+Enter a valid string and try again.
400
+400
DWS.5057
+DWS.5057
The cluster name pattern is invalid.
+The cluster name pattern is invalid.
The cluster name pattern is invalid.
+The cluster name pattern is invalid.
Enter a valid cluster name according to the cluster name description.
+Enter a valid cluster name according to the cluster name description.
400
+400
DWS.5059
+DWS.5059
Database username contains invalid characters.
+Database username contains invalid characters.
Database username contains invalid characters.
+Database username contains invalid characters.
Enter a valid database username according to the database username description.
+Enter a valid database username according to the database username description.
400
+400
DWS.5060
+DWS.5060
Integer type is of wrong range.
+Integer type is of wrong range.
Integer type is of wrong range.
+Integer type is of wrong range.
Enter a valid Integer type and try again later.
+Enter a valid Integer type and try again later.
400
+400
DWS.5061
+DWS.5061
The volume type is illegal.
+The volume type is illegal.
The volume type is illegal.
+The volume type is illegal.
Enter a valid volume type and try again later.
+Enter a valid volume type and try again later.
400
+400
DWS.5062
+DWS.5062
The volume tag is illegal.
+The volume tag is illegal.
The volume tag is illegal.
+The volume tag is illegal.
Enter a valid volume tag and try again later.
+Enter a valid volume tag and try again later.
400
+400
DWS.5063
+DWS.5063
Invalid Specific field.
+Invalid Specific field.
Invalid Specific field.
+Invalid Specific field.
Enter a correct Specific value and try again later.
+Enter a correct Specific value and try again later.
400
+400
DWS.5064
+DWS.5064
Invalid UUID.
+Invalid UUID.
Invalid UUID.
+Invalid UUID.
Enter a valid UUID and try again.
+Enter a valid UUID and try again.
400
+400
DWS.5065
+DWS.5065
Invalid format.
+Invalid format.
Invalid format.
+Invalid format.
Use a valid format and try again.
+Use a valid format and try again.
400
+400
DWS.5070
+DWS.5070
Flavor ref is invalid in xml.
+Flavor ref is invalid in xml.
Flavor ref is invalid in xml.
+Flavor ref is invalid in xml.
Enter correct flavor ref and try again later.
+Enter correct flavor ref and try again later.
400
+400
DWS.5071
+DWS.5071
The volume type is invalid in XML.
+The volume type is invalid in XML.
The volume type is invalid in XML.
+The volume type is invalid in XML.
Enter a correct disk type and try again later.
+Enter a correct disk type and try again later.
400
+400
DWS.5078
+DWS.5078
Invalid disk size.
+Invalid disk size.
Invalid disk size.
+Invalid disk size.
Enter a valid disk size and try again later.
+Enter a valid disk size and try again later.
400
+400
DWS.5079
+DWS.5079
The backup period is not permitted.
+The backup period is not permitted.
The backup period is not permitted.
+The backup period is not permitted.
Enter a proper backup period and try again later.
+Enter a proper backup period and try again later.
400
+400
DWS.5080
+DWS.5080
The backup retention period is not permitted.
+The backup retention period is not permitted.
The backup retention period is not permitted.
+The backup retention period is not permitted.
Enter a proper backup retention duration and try again later.
+Enter a proper backup retention duration and try again later.
400
+400
DWS.5081
+DWS.5081
The instance disk type is not allowed.
+The instance disk type is not allowed.
The instance disk type is not allowed.
+The instance disk type is not allowed.
Select a valid instance type and try again.
+Select a valid instance type and try again.
400
+400
DWS.5082
+DWS.5082
The database user name is not supported.
+The database user name is not supported.
The database user name is not supported.
+The database user name is not supported.
Enter a valid database username according to the database username description.
+Enter a valid database username according to the database username description.
400
+400
DWS.5083
+DWS.5083
Invalid affinity in the XML configuration.
+Invalid affinity in the XML configuration.
Invalid affinity in the XML configuration.
+Invalid affinity in the XML configuration.
Enter a valid affinity value and try again.
+Enter a valid affinity value and try again.
400
+400
DWS.5084
+DWS.5084
Incorrect volume configuration in the XML file.
+Incorrect volume configuration in the XML file.
Incorrect volume configuration in the XML file.
+Incorrect volume configuration in the XML file.
Enter a correct volume value and try again later.
+Enter a correct volume value and try again later.
400
+400
DWS.5086
+DWS.5086
The same instance type does not meet flavor consistency requirements.
+The same instance type does not meet flavor consistency requirements.
The same instance type does not meet flavor consistency requirements.
+The same instance type does not meet flavor consistency requirements.
Enter the correct flavor and try again later.
+Enter the correct flavor and try again later.
400
+400
DWS.5087
+DWS.5087
The same instance type does not meet disk consistency requirements.
+The same instance type does not meet disk consistency requirements.
The same instance type does not meet disk consistency requirements.
+The same instance type does not meet disk consistency requirements.
Enter a correct disk and try again later.
+Enter a correct disk and try again later.
400
+400
DWS.5089
+DWS.5089
Unsupported type.
+Unsupported type.
Unsupported type.
+Unsupported type.
Enter a supported type and try again.
+Enter a supported type and try again.
400
+400
DWS.5091
+DWS.5091
The number of nodes has reached the maximum.
+The number of nodes has reached the maximum.
The number of nodes has reached the maximum.
+The number of nodes has reached the maximum.
Enter a valid node quantity and try again.
+Enter a valid node quantity and try again.
400
+400
DWS.5093
+DWS.5093
Flavor information is invalid.
+Flavor information is invalid.
Flavor information is invalid.
+Flavor information is invalid.
Enter valid flavor information and try again later.
+Enter valid flavor information and try again later.
400
+400
DWS.5095
+DWS.5095
The current instance type does not support this operation.
+The current instance type does not support this operation.
The current instance type does not support this operation.
+The current instance type does not support this operation.
Select a correct instance type and try again.
+Select a correct instance type and try again.
400
+400
DWS.5096
+DWS.5096
Invalid disk quantity.
+Invalid disk quantity.
Invalid disk quantity.
+Invalid disk quantity.
Enter valid disk quantity and try again later.
+Enter valid disk quantity and try again later.
400
+400
DWS.5097
+DWS.5097
Region or AZ does not exist.
+Region or AZ does not exist.
Region or AZ does not exist.
+Region or AZ does not exist.
Enter a correct region or AZ and try again later.
+Enter a correct region or AZ and try again later.
400
+400
DWS.5098
+DWS.5098
Invalid EIP binding type.
+Invalid EIP binding type.
Invalid EIP binding type.
+Invalid EIP binding type.
Enter a correct EIP binding type and try again later.
+Enter a correct EIP binding type and try again later.
400
+400
DWS.5104
+DWS.5104
The subnet of an instance must be unique.
+The subnet of an instance must be unique.
The subnet of an instance must be unique.
+The subnet of an instance must be unique.
Ensure that the subnet of the instance is unique and try again.
+Ensure that the subnet of the instance is unique and try again.
400
+400
DWS.5106
+DWS.5106
Invalid instance type.
+Invalid instance type.
Invalid instance type.
+Invalid instance type.
Enter a valid instance type and try again later.
+Enter a valid instance type and try again later.
400
+400
DWS.5107
+DWS.5107
Invalid cluster mode.
+Invalid cluster mode.
Invalid cluster mode.
+Invalid cluster mode.
Enter a valid disk mode and try again later.
+Enter a valid disk mode and try again later.
400
+400
DWS.5111
+DWS.5111
The backup file ID does not exist.
+The backup file ID does not exist.
The backup file ID does not exist.
+The backup file ID does not exist.
Enter a correct backup file ID and try again later.
+Enter a correct backup file ID and try again later.
400
+400
DWS.5130
+DWS.5130
Invalid agency name.
+Invalid agency name.
Invalid agency name.
+Invalid agency name.
Enter a valid agency name and then try again.
+Enter a valid agency name and then try again.
400
+400
DWS.5133
+DWS.5133
Invalid EIP ID.
+Invalid EIP ID.
Invalid EIP ID.
+Invalid EIP ID.
Enter a valid EIP ID and try again.
+Enter a valid EIP ID and try again.
400
+400
DWS.5135
+DWS.5135
The EIP does not exist.
+The EIP does not exist.
The EIP does not exist.
+The EIP does not exist.
Enter a valid EIP and try again.
+Enter a valid EIP and try again.
400
+400
DWS.5144
+DWS.5144
Invalid password of the cluster administrator.
+Invalid password of the cluster administrator.
Invalid password of the cluster administrator.
+Invalid password of the cluster administrator.
Enter a valid cluster administrator password according to the description of the cluster administrator's password.
+Enter a valid cluster administrator password according to the description of the cluster administrator's password.
400
+400
DWS.5145
+DWS.5145
The cluster administrator password cannot contain the username, or the username spelled backwards.
+The cluster administrator password cannot contain the username, or the username spelled backwards.
The cluster administrator password cannot contain the username, or the username spelled backwards.
+The cluster administrator password cannot contain the username, or the username spelled backwards.
Enter a valid cluster administrator password as prompted and try again later.
+Enter a valid cluster administrator password as prompted and try again later.
400
+400
DWS.5146
+DWS.5146
The ECS group parameter is missing.
+The ECS group parameter is missing.
The ECS group parameters are missing.
+The ECS group parameters are missing.
Enter a valid parameter and try again.
+Enter a valid parameter and try again.
400
+400
DWS.5147
+DWS.5147
Invalid ECS group parameter.
+Invalid ECS group parameter.
Invalid ECS group parameter.
+Invalid ECS group parameter.
Enter a valid parameter and try again.
+Enter a valid parameter and try again.
400
+400
DWS.5148
+DWS.5148
The number of ECS groups has reached the upper limit.
+The number of ECS groups has reached the upper limit.
The number of ECS groups has reached the upper limit.
+The number of ECS groups has reached the upper limit.
Enter a valid ECS group quantity and try again.
+Enter a valid ECS group quantity and try again.
400
+400
DWS.5149
+DWS.5149
The snapshot ID is invalid.
+The snapshot ID is invalid.
The snapshot ID is invalid.
+The snapshot ID is invalid.
Enter a valid snapshot ID according to the snapshot ID description.
+Enter a valid snapshot ID according to the snapshot ID description.
400
+400
DWS.5165
+DWS.5165
Invalid null content in the data file.
+Invalid null content in the data file.
Invalid null content in the data file.
+Invalid null content in the data file.
Enter the correct control content and try again later.
+Enter the correct control content and try again later.
400
+400
DWS.5166
+DWS.5166
Invalid noescaping parameter in text format
+Invalid noescaping parameter in text format
Invalid noescaping parameter in text format
+Invalid noescaping parameter in text format
Enter the correct noescaping parameter and try again later.
+Enter the correct noescaping parameter and try again later.
400
+400
DWS.5167
+DWS.5167
Invalid header parameter in the data file. The supported values are true/on and false/off.
+Invalid header parameter in the data file. The supported values are true/on and false/off.
Invalid header parameter in the data file. The supported values are true/on and false/off.
+Invalid header parameter in the data file. The supported values are true/on and false/off.
Enter the correct header parameter and try again later.
+Enter the correct header parameter and try again later.
400
+400
DWS.5168
+DWS.5168
Invalid fill_missing_fields parameter in the data file. The supported values are true/on and false/off.
+Invalid fill_missing_fields parameter in the data file. The supported values are true/on and false/off.
Invalid fill_missing_fields parameter in the data file. The supported values are true/on and false/off.
+Invalid fill_missing_fields parameter in the data file. The supported values are true/on and false/off.
Enter the correct fill_missing_fields parameter and try again later.
+Enter the correct fill_missing_fields parameter and try again later.
400
+400
DWS.5169
+DWS.5169
Invalid ignore_extra_data parameter in the data file. The supported values are true/on and false/off.
+Invalid ignore_extra_data parameter in the data file. The supported values are true/on and false/off.
Invalid ignore_extra_data parameter in the data file. The supported values are true/on and false/off.
+Invalid ignore_extra_data parameter in the data file. The supported values are true/on and false/off.
Enter the correct ignore_extra_data parameter and try again later.
+Enter the correct ignore_extra_data parameter and try again later.
400
+400
DWS.5170
+DWS.5170
Invalid number of incorrect data formats during data import.
+Invalid number of incorrect data formats during data import.
Invalid number of incorrect data formats during data import.
+Invalid number of incorrect data formats during data import.
Enter the correct number of incorrect data formats and try again later.
+Enter the correct number of incorrect data formats and try again later.
400
+400
DWS.5171
+DWS.5171
Invalid username or password for logging in to the database.
+Invalid username or password for logging in to the database.
Invalid username or password for logging in to the database.
+Invalid username or password for logging in to the database.
Enter the correct username or password and try again later.
+Enter the correct username or password and try again later.
400
+400
DWS.5172
+DWS.5172
The database does not exist.
+The database does not exist.
The database does not exist.
+The database does not exist.
Enter the correct database name and try again later.
+Enter the correct database name and try again later.
400
+400
DWS.5173
+DWS.5173
The schema where the database table resides does not exist.
+The schema where the database table resides does not exist.
The schema where the database table resides does not exist.
+The schema where the database table resides does not exist.
Enter a correct schema and try again later.
+Enter a correct schema and try again later.
400
+400
DWS.5174
+DWS.5174
The database table does not exist.
+The database table does not exist.
The database table does not exist.
+The database table does not exist.
Enter the correct database table and try again later.
+Enter the correct database table and try again later.
400
+400
DWS.5175
+DWS.5175
The database username cannot be blank.
+The database username cannot be blank.
The database username cannot be blank.
+The database username cannot be blank.
Enter the username and try again later.
+Enter the username and try again later.
400
+400
DWS.5176
+DWS.5176
The password corresponding to the database username cannot be blank.
+The password corresponding to the database username cannot be blank.
The password corresponding to the database username cannot be blank.
+The password corresponding to the database username cannot be blank.
Enter the password and try again later.
+Enter the password and try again later.
400
+400
DWS.5177
+DWS.5177
Name of the database where the table to which data is loaded is located cannot be blank.
+Name of the database where the table to which data is loaded is located cannot be blank.
Name of the database where the table to which data is loaded is located cannot be blank.
+Name of the database where the table to which data is loaded is located cannot be blank.
Enter the database name and try again later.
+Enter the database name and try again later.
400
+400
DWS.5178
+DWS.5178
Schema where the table to which data is loaded is located cannot be blank.
+Schema where the table to which data is loaded is located cannot be blank.
Schema where the table to which data is loaded is located cannot be blank.
+Schema where the table to which data is loaded is located cannot be blank.
Enter the schema and try again later.
+Enter the schema and try again later.
400
+400
DWS.5179
+DWS.5179
Database table to which data is loaded cannot be blank.
+Database table to which data is loaded cannot be blank.
Database table to which data is loaded cannot be blank.
+Database table to which data is loaded cannot be blank.
Enter the database table and try again later.
+Enter the database table and try again later.
400
+400
DWS.5180
+DWS.5180
Invalid path for OBS file loading.
+Invalid path for OBS file loading.
Invalid path for OBS file loading.
+Invalid path for OBS file loading.
Enter a correct OBS loading path and try again later.
+Enter a correct OBS loading path and try again later.
400
+400
DWS.5181
+DWS.5181
Failed to load data. The error information is #failedReason#.
+Failed to load data. The error information is #failedReason#.
Failed to load data. The error information is #failedReason#.
+Failed to load data. The error information is #failedReason#.
Rectify the fault according to the error information and try again later.
+Rectify the fault according to the error information and try again later.
400
+400
DWS.5182
+DWS.5182
The current job is stopped.
+The current job is stopped.
The current job is stopped.
+The current job is stopped.
Select a loading job and cancel it.
+Select a loading job and cancel it.
400
+400
DWS.5183
+DWS.5183
The current job has been canceled.
+The current job has been canceled.
The current job has been canceled.
+The current job has been canceled.
Select a loading job and cancel it.
+Select a loading job and cancel it.
400
+400
DWS.5184
+DWS.5184
Invalid format of the data source file. The supported file formats are CSV and TEXT.
+Invalid format of the data source file. The supported file formats are CSV and TEXT.
Invalid format of the data source file. The supported file formats are CSV and TEXT.
+Invalid format of the data source file. The supported file formats are CSV and TEXT.
Enter a correct data source file format and try again later. The supported file formats are CSV and TEXT.
+Enter a correct data source file format and try again later. The supported file formats are CSV and TEXT.
400
+400
DWS.5185
+DWS.5185
Invalid encoding format of the data file. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.
+Invalid encoding format of the data file. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.
Invalid encoding format of the data file. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.
+Invalid encoding format of the data file. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.
Enter a correct encoding format and try again later. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.
+Enter a correct encoding format and try again later. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.
400
+400
DWS.5186
+DWS.5186
Invalid field delimiter of row data in a data source file.
+Invalid field delimiter of row data in a data source file.
Invalid field delimiter of row data in a data source file.
+Invalid field delimiter of row data in a data source file.
Enter a correct field delimiter and try again later.
+Enter a correct field delimiter and try again later.
400
+400
DWS.5187
+DWS.5187
Invalid quote character for a CSV file.
+Invalid quote character for a CSV file.
Invalid quote character for a CSV file.
+Invalid quote character for a CSV file.
Enter a correct quote character and try again later.
+Enter a correct quote character and try again later.
400
+400
DWS.5189
+DWS.5189
Failed to obtain the AK/SK.
+Failed to obtain the AK/SK.
Failed to obtain the AK/SK.
+Failed to obtain the AK/SK.
Contact the database customer service or try again later.
+Contact the database customer service or try again later.
400
+400
DWS.5191
+DWS.5191
The tag does not exist.
+The tag does not exist.
The tag does not exist.
+The tag does not exist.
Enter the correct tag and try again later.
+Enter the correct tag and try again later.
400
+400
DWS.5194
+DWS.5194
The number of tags exceeds the maximum value.
+The number of tags exceeds the maximum value.
The number of tags exceeds the maximum value.
+The number of tags exceeds the maximum value.
Verify the number of tags for the resource and try again later.
+Verify the number of tags for the resource and try again later.
400
+400
DWS.5197
+DWS.5197
The tag is invalid.
+The tag is invalid.
The tag is invalid.
+The tag is invalid.
Enter the correct tag and try again later.
+Enter the correct tag and try again later.
400
+400
DWS.5198
+DWS.5198
Invalid username.
+Invalid username.
Invalid username.
+Invalid username.
Enter a correct username and try again.
+Enter a correct username and try again.
400
+400
DWS.5199
+DWS.5199
Invalid password.
+Invalid password.
Invalid password.
+Invalid password.
Enter a valid password and try again.
+Enter a valid password and try again.
400
+400
DWS.5200
+DWS.5200
The flavor has been sold out. Switch to another AZ or region.
-
+The flavor has been sold out. Switch to another AZ or region.
+
The flavor has been sold out. Switch to another AZ or region.
+The flavor has been sold out. Switch to another AZ or region.
Create a cluster of another flavor or switch to another AZ or region.
+Create a cluster of another flavor or switch to another AZ or region.
400
+400
DWS.5202
+DWS.5202
The subnet ID cannot be left blank.
+The subnet ID cannot be left blank.
The subnet ID cannot be left blank.
+The subnet ID cannot be left blank.
Enter a correct subnet ID and try again later.
+Enter a correct subnet ID and try again later.
400
+400
DWS.5203
+DWS.5203
The security group ID cannot be left blank.
+The security group ID cannot be left blank.
The security group ID cannot be left blank.
+The security group ID cannot be left blank.
Enter a valid security group ID and try again later.
+Enter a valid security group ID and try again later.
400
+400
DWS.5206
+DWS.5206
Databases of this version do not support the function.
+Databases of this version do not support the function.
Databases of this version do not support the function.
+Databases of this version do not support the function.
Ensure that the API parameters match the cluster version. If the parameters do not match the version, correct the parameters and try again.
+Ensure that the API parameters match the cluster version. If the parameters do not match the version, correct the parameters and try again.
Change History
-Date
+Date
Description
+Description
2025-07-18
+2025-12-19
This issue is the twentieth official release for cluster version 9.1.0.211.
-Modified the URIs of the tag management APIs. Modified the following sections:
-
+This issue is the twenty-second official release for cluster version 9.1.0.211.
+Added the following section:
+
2025-04-03
+2025-09-18
This issue is the nineteenth official release for cluster version 9.1.0.211.
+This issue is the twenty-first official release for cluster version 9.1.0.211.
2024-09-30
+2025-07-18
This issue is the eighteenth official release for the 8.2.1.220 cluster.
+This issue is the twentieth official release for cluster version 9.1.0.211.
+Modified the URIs of the tag management APIs. Modified the following sections:
+
2024-03-29
+2025-04-03
This issue is the seventeenth official release for the 8.1.3.325 cluster.
+This issue is the nineteenth official release for cluster version 9.1.0.211.
2023-09-26
+2024-09-30
This issue is the sixteenth official release.
-Modified the following sections:
-
+This issue is the eighteenth official release for cluster version 8.2.1.220.
2022-11-03
+2024-03-29
This issue is the fifteenth official release.
-Modified the following sections:
-
-
+This issue is the seventeenth official release for cluster version 8.1.3.325.
2021-04-17
+2023-09-26
This issue is the fourteenth official release.
-Modified the following sections:
-
+This issue is the sixteenth official release.
+Modified the following sections:
+
2020-11-03
+2022-11-03
This issue is the thirteenth official release.
-Modified the following sections:
-
-
+This issue is the fifteenth official release.
+Modified the following sections:
+
+
2020-04-17
+2021-04-17
This issue is the twelfth official release.
-Modified the following sections:
-
+This issue is the fourteenth official release.
+Modified the following sections:
+
2019-03-30
+2020-11-03
This issue is the eleventh official release. It incorporates the following changes:
-Modified the following sections:
-
+This issue is the thirteenth official release.
+Modified the following sections:
+
+
2019-01-29
+2020-04-17
This issue is the tenth official release.
-Modified the following sections:
-- Added the parameter group information in the response message of the API for querying cluster details.
+
This issue is the twelfth official release.
+Modified the following sections:
+
+
2019-03-30
+This issue is the eleventh official release.
+Modified the following sections:
+
+2019-01-29
+This issue is the tenth official release.
+Modified the following sections:
+- Added the parameter group information in the response message of the API for querying cluster details.
2018-10-24
+2018-10-24
This issue is the ninth official release.
-Modified the following sections:
-- Getting Started: Modifications are as follows:
- API for Querying the Cluster List: Added parameters public_endpoints and endpoints to the response.
- API for Querying Cluster Details: Modified the parameter sequence in the response, added parameters tags and maintain_window, and changed the number of addresses in parameter endpoints to two.
- - Querying the Snapshot List: Deleted the tag parameter from the response and changed the number of addresses in parameter endpoints to two in the response.
- Querying Cluster Details: Added the tag parameter to the response.
+This issue is the ninth official release.
+Modified the following sections:
+- Getting Started: Modifications are as follows:
- API for Querying the Cluster List: Added parameters public_endpoints and endpoints to the response.
- API for Querying Cluster Details: Modified the parameter sequence in the response, added parameters tags and maintain_window, and changed the number of addresses in parameter endpoints to two.
+ - Querying the Snapshot List: Deleted the tag parameter from the response and changed the number of addresses in parameter endpoints to two in the response.
- Querying Cluster Details: Added the tag parameter to the response.
2018-09-05
+2018-09-05
This issue is the eighth official release.
-Modified the following sections:
-- Querying the Snapshot List: Modified the URI.
- Querying Snapshot Details: Modified the URI.
+This issue is the eighth official release.
+Modified the following sections:
+- Querying the Snapshot List: Modified the URI.
- Querying Snapshot Details: Modified the URI.
2018-06-21
+2018-06-21
This issue is the seventh official release.
-Added the following sections:
-- Restoring a Cluster: Added the API for restoring clusters.
-Modified the following sections:
-- Querying the Cluster List: Added some request parameters.
- Querying Cluster Details: Added some request parameters.
- Error Code: Added error code related to tags.
+This issue is the seventh official release.
+Added the following section:
+- Restoring a Cluster: Added the API for restoring clusters.
+Modified the following sections:
+- Querying the Cluster List: Added some request parameters.
- Querying Cluster Details: Added some request parameters
- Error Code: Added error code related to tags.
2018-02-12
+2018-02-12
This issue is the sixth official release.
-Added the following content:
-
-Modified the following sections:
-Error Code: Added solutions for the error code.
-Deleted the following content:
-AK/SK-based Authentication
+This issue is the sixth official release.
+Added the following sections:
+
+Modified the following sections:
+Error Code: Added solutions for the error code.
+Deleted the following content:
+AK/SK Authentication
2017-12-08
+2017-12-08
This issue is the fifth official release.
-Modified the following section:
-
+This issue is the fifth official release.
+Modified the following section:
+
2017-11-01
+2017-11-01
This issue is the fourth official release.
-Modified the following section:
-
+This is the fourth official release.
+Modified the following sections:
+
2017-09-30
+2017-09-30
This issue is the third official release.
-Modified the following content:
-- Common request header fields
- Error Code
+This issue is the third official release.
+Modified the following content:
+- Common request headers
- Error Code
2017-08-30
+2017-08-30
This issue is the second official release.
-Modified the following sections:
-
+This is the second official release.
+Modified the following sections:
+
2017-08-07
+2017-08-07
This issue is the first official release.
+This issue is the first official release.
Restoring a Cluster
-Function
This API is used to restore clusters using the snapshot.
-
-URI
POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
-snapshot_id
-Yes
-String
-ID of the snapshot to be restored
-
-
-
-Request Parameters
-Table 2 Request body parameters Parameter
-Mandatory
-Type
-Description
-restore
-Yes
-Restore object
-Object to be restored
-
-
-
-Table 3 Restore Parameter
-Mandatory
-Type
-Description
-name
-Yes
-String
-Cluster name, which must be unique. The cluster name must contain 4 to 64 characters, which must start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.
-subnet_id
-No
-String
-Subnet ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.
-security_group_id
-No
-String
-Security group ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.
-vpc_id
-No
-String
-VPC ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.
-availability_zone
-No
-String
-AZ of a cluster. The default value is the same as that of the original cluster.
-port
-No
-Integer
-Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.
-public_ip
-No
-PublicIp object
-Public IP address. If the parameter is not specified, public connection is not used by default.
-enterprise_project_id
-No
-String
-Enterprise project. The default enterprise project ID is 0.
-
-
-
-
-
-Response Parameters
-Table 5 Response body parameters Parameter
-Type
-Description
-cluster
-Cluster object
-Cluster object
-
-
-
-
-
-Example Request
POST
-https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/actions
-{"restore": {
- "name": "dws-1",
- "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
- "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
- "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
- "availability_zone": "eu-de-01",
- "port": 8000,
- "public_ip": {
- "public_bind_type": "auto_assign",
- "eip_id": ""
- },
- "enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada"
- }
-}
-
-Example Responses
{
- "cluster": {
- "id": "7d85f602-a948-4a30-afd4-e84f47471c15"
- }
-}
-
-Status Code
-Status Code
-Description
-200
-The cluster is restored.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Snapshot Management APIs
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0034.html b/docs/dws/api-ref/dws_02_0034.html
index 29172583d..5fdf02ee7 100644
--- a/docs/dws/api-ref/dws_02_0034.html
+++ b/docs/dws/api-ref/dws_02_0034.html
@@ -1,105 +1,276 @@
-
+
API Overview
-You can use the following GaussDB(DWS) functions with the APIs.
+DWS provides in-house APIs. The following table lists the key functions of DWS APIs. For details about other APIs, see the corresponding sections.
-Function
+Table 1 APIs Function
API
+API
Description
+Description
Cluster management
+Cluster management
+
-Creates a cluster.
+Performs a check before cluster creation.
+
-Queries and displays the cluster list.
+Creates a cluster.
+
-Queries cluster details.
+Queries and displays the cluster list.
+
-Queries all node types supported by GaussDB(DWS).
+Queries cluster details.
+
-Deletes a cluster.
+Queries all node types supported by DWS.
+
-Restarts a cluster.
+Deletes a cluster.
+
-Scales out a cluster.
+Restarts a cluster.
+
-Resets the cluster administrator password.
+Scales out a cluster.
Snapshot management
+
-
-
-Creates snapshots for a specified cluster.
+Resets the cluster administrator password.
+
-Queries the snapshot list.
+Queries DSS storage pools available to a tenant.
+
-Queries the snapshot details using the snapshot ID.
+Cancels the read-only status on the management console.
+
-Deletes a snapshot.
+Queries information about CNs in a specified cluster.
+
-Restores a cluster using a snapshot.
+Adds CNs in batches to a specified cluster.
Tag management
+
-
-
-Query all tag of a project.
+Deletes CNs from a specified cluster.
+ Snapshot management
Queries tags of a cluster.
+
+
+Creates snapshots for a specified cluster.
+
-Batch adds tags to a cluster in batches.
+Queries the snapshot list.
+
-Deletes tags from a cluster in batches.
+Queries the snapshot details using the snapshot ID.
+
+
+Deletes a snapshot.
+
+
+Deletes a snapshot policy.
+
+
+Restores a cluster using a snapshot.
+
+
+Replicates an automated snapshot.
+
+
+Sets a snapshot policy.
+Incident management
+
+
+
+Queries the event list.
+
+
+Queries subscribed events.
+
+
+Adds a subscribed event.
+
+
+Updates a subscribed event.
+
+
+Deletes a subscribed event.
+Audit logs
+
+
+Queries audit logs.
+Alarm management
+
+
+Queries the alarm details list.
+
+
+Queries alarm statistics.
+
+
+Queries subscribed alarms.
+
+
+Creates an alarm subscription.
+
+
+Updates a subscribed alarm.
+
+
+Deletes a subscribed alarm.
+AZ
+
+
+Queries the AZs available for a tenant to create a cluster.
+Connection management
+
+
+
+
+
+
+
+
+
+Applies for a domain name for a specified cluster.
+
+
+Changes the domain name of a specified cluster.
+
+
+Deletes the domain name of a specified cluster.
+
+
+Queries the list of ELBs that can be associated with a cluster.
+
+
+Binds an ELB to a cluster.
+
+
+Unbinds an ELB from a cluster.
+
+
+Binds an EIP to a cluster.
+
+
+Unbound an EIP from a cluster.
+Tag management
+
+
+
+
+
+Queries project tags.
+
+
+Queries tags of a specified cluster.
+
+
+Batch adds tags to a specified cluster.
+
+
+Batch deletes tags from a specified cluster.
Getting Started
-This section describes how to use GaussDB(DWS) APIs to manage clusters. The procedure of the management clusters is as follows:
-- Call the API in Authentication to obtain the user token, which will be put into the request header for authentication in a subsequent request.
- Call the API in Querying the Supported Node Types to obtain the supported node types.
- Call the API in Creating a Cluster to create a cluster.
- Call the API in Querying the Cluster List to obtain the cluster information.
- Call the API in Querying Cluster Details to view cluster details.
- Call the API in Creating a Snapshot to create a snapshot.
- Call the API in Querying the Snapshot List to check whether the snapshot is successfully created.
- Call the API in Restoring a Cluster to restore a cluster using its snapshot.
- Call the API in Deleting a Manual Snapshot to delete an unwanted snapshot.
- Call the API in Deleting a Cluster to delete a finished or unwanted cluster.
-Prerequisites
- You have created a VPC, subnet, and security group and obtained their IDs. For details, see Creating a VPC.
- You have obtained the endpoints of IAM and GaussDB(DWS). For details, see "Regions and Endpoints".
- You have obtained the project ID. For details, see Obtaining a Project ID.
+This section describes how to use DWS APIs to manage clusters. The procedure of the management clusters is as follows:
+- Call the API in Authentication to obtain the user token, which will be put into the request header for authentication in a subsequent request.
- Call the API in Querying Flavor Information to obtain the supported node types.
- Call the API in Creating a Cluster to create a cluster.
- Call the API in Querying the Cluster List to obtain the cluster information.
- Call the API in Querying Cluster Details to view the cluster details.
- Call the API in Creating a Snapshot to create a snapshot.
- Call the API in Querying the Snapshot List to check whether the snapshot is created successfully.
- Call the API in Restoring a Cluster to restore a cluster using its snapshot.
- Call the API in Deleting a Snapshot to delete an unwanted snapshot.
- Call the API in Deleting a Cluster to delete a finished or unwanted cluster.
+Prerequisites
- You have created a VPC, subnet, and security group and obtained their IDs. For details, see Creating a VPC.
- You have obtained the endpoints of IAM and DWS. For details, see "Regions and Endpoints".
- You have obtained the Project ID. For details, see Obtaining Project ID.
-Managing a Cluster
The following values are examples (replace them based on the actual situation).
-- IAM endpoint: iam_endpoint
- GaussDB(DWS) endpoint: dws_endpoint
- VPC ID: 219ab8a0-1272-4049-a383-8ad0b770fa11
- Subnet ID: d23ef2e9-8b90-49b3-bc4a-fd7d6bea6bec
- Security group ID: 12e3c23a-8710-4b75-95e4-5c8d7f68ef3c
- Project ID: 9bc552e6-19af-4326-800d-281a92984636
-Perform the following operations to manage the cluster.
-- Before calling other APIs, call the API in Authentication to obtain the token and set it as an environment variable.
curl -H "Content-type:application/json" https://{iam_endpoint}/v3/auth/tokens -X POST -d '{
+Managing a Cluster
The following values are examples (replace them based on the actual situation).
+- IAM endpoint: iam_endpoint
- DWS endpoint: dws_endpoint
- VPC ID: 219ab8a0-1272-4049-a383-8ad0b770fa11
- Subnet ID: d23ef2e9-8b90-49b3-bc4a-fd7d6bea6bec
- Security group ID: 12e3c23a-8710-4b75-95e4-5c8d7f68ef3c
- Project ID: 9bc552e6-19af-4326-800d-281a92984636
+Perform the following operations to manage the cluster.
+- Before calling other APIs, call the API in Authentication to obtain the token and set it as an environment variable.
curl -H "Content-type:application/json" https://{iam_endpoint}/v3/auth/tokens -X POST -d '{
"auth": {
"identity": {
"methods": [
@@ -16,11 +16,11 @@
],
"password": {
"user": {
- "name": "testname",
+ "name": "testname",
"domain": {
- "name": "testname"
+ "name": "testname"
},
- "password": "Passw0rd"
+ "password": "Passw0rd"
}
}
},
@@ -31,14 +31,14 @@
}
}
}' -v -k
-- Obtain the value of X-Subject-Token from the response header as follows. X-Subject-Token indicates the token.
X-Subject-Token:MIidkgYJKoZIhvcNAQcCoIidgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
- - Run the following command to set the token as an environment variable:
export Token={X-Subject-Token}
-X-Subject-Token is the token obtained in the preceding step.export Token=MIidkgYJKoZIhvcNAQcCoIidgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
+- Obtain the value of X-Subject-Token from the response header as follows. X-Subject-Token indicates the token.
X-Subject-Token:MIidkgYJKoZIhvcNAQcCoIidgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
+ - Run the following command to set the token as an environment variable:
export Token={X-Subject-Token}
+X-Subject-Token is the token obtained in the preceding step.export Token=MIidkgYJKoZIhvcNAQcCoIidgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
-- Call the API in Querying the Supported Node Types to obtain the supported node types.
curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/node_types -v -k
-The request response is as follows:
-status CODE 200
+
- Call the API in Querying Flavor Information to obtain the supported node types.
curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/node_types -v -k
+The request response is as follows:
+status CODE 200
{
"node_types": [
{
@@ -83,26 +83,26 @@
}
]
}
- - Call the API in Creating a Cluster to create a cluster.
The examples for configuring the cluster are as follows:
-- Cluster name: dws-demo
- Administrator username: dbadmin
- Administrator password: Dws2017demo!
- Port: 8000
- Node type: dws.d1.xlarge
- Number of nodes: 3
- Elastic IP (EIP): auto_assign
-curl -X POST -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
+ - Call the API in Creating a Cluster to create a cluster.
The examples for configuring the cluster are as follows:
+- Cluster name: dws-demo
- Administrator username: dbadmin
- Administrator password: passw0rd
- Port: 8000
- Node type: dws.d1.xlarge
- Number of nodes: 3
- Elastic IP (EIP): auto_assign
+curl -X POST -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
"node_type": "dws.d1.xlarge",
"number_of_node": 3,
- "subnet_id": "d23ef2e9-8b90-49b3-bc4a-fd7d6bea6bec",
- "security_group_id": "12e3c23a-8710-4b75-95e4-5c8d7f68ef3c",
- "vpc_id": "219ab8a0-1272-4049-a383-8ad0b770fa11",
+ "subnet_id": "d23ef2e9-8b90-49b3-bc4a-fd7d6bea6bec",
+ "security_group_id": "12e3c23a-8710-4b75-95e4-5c8d7f68ef3c",
+ "vpc_id": "219ab8a0-1272-4049-a383-8ad0b770fa11",
"port": 8000,
"name": "dws-demo",
"user_name": "dbadmin",
- "user_pwd": "Dws2017demo!",
+ "user_pwd": "passw0rd",
"public_ip": {
"public_bind_type": "auto_assign"
}
-}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters -v -k
-If status code 200 is returned, the request for creating a cluster is successfully sent.
- - Call the API in Querying the Cluster List to obtain the cluster information.
curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters -k –v
-The request response is as follows:
-{
+}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters -v -k
+If status code 200 is returned, the request for creating a cluster is successfully sent.
+ - Call the API in Querying the Cluster List to obtain the cluster information.
curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters -k –v
+The request response is as follows:
+{
"clusters": [
{
"id": "7ba031f6-81f4-4670-ad20-c490b91877e5",
@@ -127,17 +127,17 @@
"public_endpoints": [
{
"public_connect_info": "10.0.0.8:8000",
- "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
+ "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
}
],
"endpoints": [
{
"connect_info": "192.168.0.10:8000",
- "jdbc_url": "jdbc:postgresql://192.168.0.10:8000/<YOUR_DATABASE_name>"
+ "jdbc_url": "jdbc:postgresql://192.168.0.10:8000/<YOUR_DATABASE_name>"
},
{
"connect_info": "192.168.0.12:8000",
- "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+ "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
}
] ,
"updated": "2018-01-15T12:50:06",
@@ -146,11 +146,11 @@
}
]
}
-- If status is CREATING, the cluster is being created. If status is AVAILABLE, the cluster is successfully created.
- The UUID of cluster dws-demo is 7ba031f6-81f4-4670-ad20-c490b91877e5. Record the UUID for subsequent use.
- - Call the API in Querying Cluster Details to view cluster details.
curl -X GET -H "Content-type:application/json" -H "X-Auth-Token:$Token"
- https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters/7ba031f6-81f4-4670-ad20-c490b91877e5 -k -v
-The request response is as follows:
-{
+- If status is CREATING, the cluster is being created. If status is AVAILABLE, the cluster is successfully created.
- The UUID of cluster dws-demo is 7ba031f6-81f4-4670-ad20-c490b91877e5. Record the UUID for subsequent use.
+ - Call the API in Querying Cluster Details to view the cluster details.
curl -X GET -H "Content-type:application/json" -H "X-Auth-Token:$Token"
+ https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters/7ba031f6-81f4-4670-ad20-c490b91877e5 -k -v
+The request response is as follows:
+{
"cluster": {
"id": "7ba031f6-81f4-4670-ad20-c490b91877e5",
"status": "AVAILABLE",
@@ -176,24 +176,24 @@
"public_endpoints": [
{
"public_connect_info": "10.0.0.8:8000",
- "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
+ "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
}
],
"endpoints": [
{
"connect_info": "192.168.0.10:8000",
- "jdbc_url": "jdbc:postgresql://192.168.0.10:8000/<YOUR_DATABASE_name>"
+ "jdbc_url": "jdbc:postgresql://192.168.0.10:8000/<YOUR_DATABASE_name>"
},
{
"connect_info": "192.168.0.12:8000",
- "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+ "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
}
],
"version": "1.1.0",
"maintain_window": {
"day": "Wed",
- "start_time": "22:00",
- "end_time": "02:00"
+ "start_time": "18:00",
+ "end_time": "22:00"
},
"recent_event": 1,
"tags": null,
@@ -202,25 +202,25 @@
}
}
}
-public_endpoints and endpoints can be queried from the response. After the cluster is successfully created, you can use public_endpoints or endpoints to access the cluster from an external source.
- - Call the API in Creating a Snapshot to create a snapshot.Create snapshot snapshotForDemoCluster for cluster dws-demo.
curl -X POST -H "Content-type:application/json" -H "X-Auth-Token:$Token" -d '{
+public_endpoints and endpoints can be queried from the response. After the cluster is successfully created, you can use public_endpoints or endpoints to access the cluster from an external source.
+- Call the API in Creating a Snapshot to create a snapshot.Create snapshot snapshotForDemoCluster for cluster dws-demo.
curl -X POST -H "Content-type:application/json" -H "X-Auth-Token:$Token" -d '{
"snapshot": {
"name": "snapshotForDemoCluster",
"cluster_id": "7ba031f6-81f4-4670-ad20-c490b91877e5",
"description": "Snapshot description"
}
-}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots -k -v
+}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots -k -v
-The request response is as follows:
-{
+The request response is as follows:
+{
"snapshot": {
"id": "2a4d0f86-67cd-408a-8b66-017454fb7793"
}
}
-If status code 200 is returned, the request for creating a snapshot is successfully sent. Record id so that the ID can be used when you query the snapshot details later.
- - Call the API in Querying the Snapshot List to check whether the snapshot is successfully created.
curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793 -k -v
-If the snapshot status in the response is AVAILABLE, the snapshot is successfully created. If the snapshot status is CREATING, the snapshot is being created.
-{
+If status code 200 is returned, the request for creating a snapshot is successfully sent. Record id so that the ID can be used when you query the snapshot details later.
+ - Call the API in Querying the Snapshot List to check whether the snapshot is created successfully.
curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793 -k -v
+If the snapshot status in the response is AVAILABLE, the snapshot is successfully created. If the snapshot status is CREATING, the snapshot is being created.
+{
"snapshot": {
"id": "2a4d0f86-67cd-408a-8b66-017454fb7793",
"name": "snapshotForDemoCluster",
@@ -233,19 +233,19 @@
"cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
}
}
- - Call the API in Restoring a Cluster to restore a cluster using its snapshot.Restore snapshot snapshotForDemoCluster to new cluster dws-restore.
curl -X POST -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
+- Call the API in Restoring a Cluster to restore a cluster using its snapshot.Restore snapshot snapshotForDemoCluster to new cluster dws-restore.
curl -X POST -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
"restore": {
"name": "dws-restore"
}
-}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793/actions -v -k
+}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793/actions -v -k
-If status code 200 is returned, the cluster is successfully restored. You can check the cluster restoration status by performing operations in Querying Snapshot Details.
- - Call the API in Deleting a Manual Snapshot to delete an unwanted snapshot.
curl -X DELETE -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793 -v -k
-If status code 202 is returned, the snapshot is successfully deleted.
- - Call the API in Deleting a Cluster to delete an unwanted cluster.
curl -X DELETE -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
+If status code 200 is returned, the cluster is successfully restored. You can check the cluster restoration status by performing operations in Querying Snapshot Details.
+ - Call the API in Deleting a Snapshot to delete an unwanted snapshot.
curl -X DELETE -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793 -v -k
+If status code 202 is returned, the snapshot is successfully deleted.
+ - Call the API in Deleting a Cluster to delete a finished or unwanted cluster.
curl -X DELETE -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
"keep_last_manual_snapshot":0
-}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters/7ba031f6-81f4-4670-ad20-c490b91877e5 -v -k
-If status code 202 is returned, the cluster is successfully deleted.
+}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters/7ba031f6-81f4-4670-ad20-c490b91877e5 -v -k
+If status code 202 is returned, the cluster is successfully deleted.
diff --git a/docs/dws/api-ref/dws_02_0037.html b/docs/dws/api-ref/dws_02_0037.html
index ac88a8ee8..50a5747ac 100644
--- a/docs/dws/api-ref/dws_02_0037.html
+++ b/docs/dws/api-ref/dws_02_0037.html
@@ -1,15 +1,35 @@
-
+
API Description
-
+
diff --git a/docs/dws/api-ref/dws_02_0038.html b/docs/dws/api-ref/dws_02_0038.html
index 07d82ac33..919a8887b 100644
--- a/docs/dws/api-ref/dws_02_0038.html
+++ b/docs/dws/api-ref/dws_02_0038.html
@@ -1,313 +1,313 @@
-
+
Status Code
-Table 1 describes the status code.
+Table 1 describes the status code.
-Table 1 Status code Status Code
+Table 1 Status code Status Code
Code
+Code
Description
+Description
100
+100
Continue
+Continue
The client continues sending the request.
-This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server.
+The client continues sending the request.
+This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server.
101
+101
Switching Protocols
+Switching Protocols
Switching protocols. The target protocol must be more advanced than the source protocol.
-For example, the current HTTP protocol is switched to a later version.
+Switching protocols. The target protocol must be more advanced than the source protocol.
+For example, the current HTTP protocol is switched to a later version.
201
+201
Created
+Created
The request for creating a resource has been fulfilled.
+The request for creating a resource has been fulfilled.
202
+202
Accepted
+Accepted
The request has been accepted, but the processing has not been completed.
+The request has been accepted, but the processing has not been completed.
203
+203
Non-Authoritative Information
+Non-Authoritative Information
The server successfully processed the request, but is returning information that may be from another source.
+The server successfully processed the request, but is returning information that may be from another source.
204
+204
NoContent
+NoContent
The server has successfully processed the request, but has not returned any content.
-The status code is returned in response to an HTTP OPTIONS request.
+The server has successfully processed the request, but has not returned any content.
+The status code is returned in response to an HTTP OPTIONS request.
205
+205
Reset Content
+Reset Content
The server has fulfilled the request, but the requester is required to reset the content.
+The server has fulfilled the request, but the requester is required to reset the content.
206
+206
Partial Content
+Partial Content
The server has processed certain GET requests.
+The server has processed certain GET requests.
300
+300
Multiple Choices
+Multiple Choices
There are multiple options for the location of the requested resource. The response contains a list of resource characteristics and addresses from which the user or user agent (such as a browser) can choose the most appropriate one.
+There are multiple options for the location of the requested resource. The response contains a list of resource characteristics and addresses from which the user or user agent (such as a browser) can choose the most appropriate one.
301
+301
Moved Permanently
+Moved Permanently
The requested resource has been assigned a new permanent URI, and the new URI is contained in the response.
+The requested resource has been assigned a new permanent URI, and the new URI is contained in the response.
302
+302
Found
+Found
The requested resource resides temporarily under a different URI.
+The requested resource resides temporarily under a different URI.
303
+303
See Other
+See Other
Retrieve a location.
-The response to the request can be found under a different URI and should be retrieved using a GET or POST method.
+Retrieve a location.
+The response to the request can be found under a different URI and should be retrieved using a GET or POST method.
304
+304
Not Modified
+Not Modified
The requested resource has not been modified. When the server returns this status code, it does not return any resources.
+The requested resource has not been modified. When the server returns this status code, it does not return any resources.
305
+305
Use Proxy
+Use Proxy
The requested resource must be accessed through a proxy.
+The requested resource must be accessed through a proxy.
306
+306
Unused
+Unused
The HTTP status code is no longer used.
+The HTTP status code is no longer used.
400
+400
BadRequest
+BadRequest
Invalid request.
-The client should not repeat the request without modifications.
+Invalid request.
+The client should not repeat the request without modifications.
401
+401
Unauthorized
+Unauthorized
The status code is returned after the client provides the authentication information, indicating that the authentication information is incorrect or invalid.
+The status code is returned after the client provides the authentication information, indicating that the authentication information is incorrect or invalid.
402
+402
Payment Required
+Payment Required
This status code is reserved for future use.
+This status code is reserved for future use.
403
+403
Forbidden
+Forbidden
The server understood the request, but is refusing to fulfill it.
-The client should not repeat the request without modifications.
+The server understood the request, but is refusing to fulfill it.
+The client should not repeat the request without modifications.
404
+404
NotFound
+NotFound
The requested resource cannot be found.
-The client should not repeat the request without modifications.
+The requested resource cannot be found.
+The client should not repeat the request without modifications.
405
+405
MethodNotAllowed
+MethodNotAllowed
The method specified in the request is not supported for the requested resource.
-The client should not repeat the request without modifications.
+The method specified in the request is not supported for the requested resource.
+The client should not repeat the request without modifications.
406
+406
Not Acceptable
+Not Acceptable
The server cannot fulfill the request according to the content characteristics of the request.
+The server cannot fulfill the request according to the content characteristics of the request.
407
+407
Proxy Authentication Required
+Proxy Authentication Required
This status code is similar to 401, but indicates that the client must first authenticate itself with the proxy.
+This status code is similar to 401, but indicates that the client must first authenticate itself with the proxy.
408
+408
Request Time-out
+Request Time-out
The request timed out.
-The client may repeat the request without modifications at any later time.
+The request timed out.
+The client may repeat the request without modifications at any later time.
409
+409
Conflict
+Conflict
The request could not be completed due to a conflict with the current state of the resource.
-This status code indicates that the resource that the client attempts to create already exits, or the request fails to be processed because of the update of the conflict request.
+The request could not be completed due to a conflict with the current state of the resource.
+This status code indicates that the resource that the client attempts to create already exits, or the request fails to be processed because of the update of the conflict request.
410
+410
Gone
+Gone
The requested resource is no longer available.
-The status code indicates that the requested resource has been deleted permanently.
+The requested resource is no longer available.
+The status code indicates that the requested resource has been deleted permanently.
411
+411
Length Required
+Length Required
The server refuses to process the request without a defined Content-Length.
+The server refuses to process the request without a defined Content-Length.
412
+412
Precondition Failed
+Precondition Failed
The server does not meet one of the preconditions that the requester puts on the request.
+The server does not meet one of the preconditions that the requester puts on the request.
413
+413
Request Entity Too Large
+Request Entity Too Large
The request is larger than that a server is able to process. The server may close the connection to prevent the client from continuing the request. If the server cannot process the request temporarily, the response will contain a Retry-After header field.
+The request is larger than that a server is able to process. The server may close the connection to prevent the client from continuing the request. If the server cannot process the request temporarily, the response will contain a Retry-After header field.
414
+414
Request-URI Too Large
+Request-URI Too Large
The URI provided was too long for the server to process.
+The URI provided was too long for the server to process.
415
+415
Unsupported Media type
+Unsupported Media type
The server is unable to process the media format in the request.
+The server is unable to process the media format in the request.
416
+416
Requested range not satisfiable
+Requested range not satisfiable
The requested range is invalid.
+The requested range is invalid.
417
+417
Expectation Failed
+Expectation Failed
The server fails to meet the requirements of the Expect request-header field.
+The server fails to meet the requirements of the Expect request-header field.
422
+422
UnprocessableEntity
+UnprocessableEntity
The request is well-formed but is unable to be processed due to semantic errors.
+The request is well-formed but is unable to be processed due to semantic errors.
429
+429
TooManyRequests
+TooManyRequests
The client has sent more requests than its rate limit is allowed within a given amount of time, or the server has received more requests than it is able to process within a given amount of time. In this case, it is advisable for the client to re-initiate requests after the time specified in the Retry-After header of the response expires.
+The client has sent more requests than its rate limit is allowed within a given amount of time, or the server has received more requests than it is able to process within a given amount of time. In this case, it is advisable for the client to re-initiate requests after the time specified in the Retry-After header of the response expires.
500
+500
InternalServerError
+InternalServerError
The server is able to receive the request but it could not understand the request.
+The server is able to receive the request but it could not understand the request.
501
+501
Not Implemented
+Not Implemented
The server does not support the requested function.
+The server does not support the requested function.
502
+502
Bad Gateway
+Bad Gateway
The server is acting as a gateway or proxy and receives an invalid request from a remote server.
+The server is acting as a gateway or proxy and receives an invalid request from a remote server.
503
+503
ServiceUnavailable
+ServiceUnavailable
The requested service is invalid.
-The client should not repeat the request without modifications.
+The requested service is invalid.
+The client should not repeat the request without modifications.
504
+504
ServerTimeout
+ServerTimeout
The request cannot be fulfilled within a given time. This status code is returned to the client only when the Timeout parameter is specified in the request.
+The request cannot be fulfilled within a given time. This status code is returned to the client only when the Timeout parameter is specified in the request.
505
+505
HTTP Version not supported
+HTTP Version not supported
The server does not support the HTTP protocol version used in the request.
+The server does not support the HTTP protocol version used in the request.
Creating a VPC
-Background
Before creating a cluster, you need to create a VPC to provide a secure and isolated network environment for using GaussDB(DWS).
-If you have already created a VPC, you do not need to create it again.
-
For details about how to create a VPC, see Creating a VPC in the Virtual Private Cloud User Guide.
+Background
Before creating a cluster, you need to create a VPC to provide a secure and isolated network environment for using DWS.
+If you have already created a VPC, you do not need to create it again.
+ For details about how to create a VPC, see Creating a VPC in the Virtual Private Cloud User Guide.
-Procedure
- Log in to the management console.
- Under Network, click Virtual Private Cloud.
- On the Virtual Private Cloud page, click Create VPC to create a VPC.
- Obtain the VPC and subnet ID for subsequent use in Creating a Cluster.
- On the Virtual Private Cloud page, choose Access Control > Security Groups in the navigation tree on the left, and click Create Security Group to create a security group.
- Obtain the security group ID for subsequent use in Creating a Cluster.
+Procedure
- Log in to the DWS console.
- Under Network, click Virtual Private Cloud.
- On the Virtual Private Cloud page, click Create VPC to create a VPC.
- Obtain the VPC and subnet ID for subsequent use in Creating a Cluster.
- On the Virtual Private Cloud page, choose Access Control > Security Groups in the navigation tree on the left, and click Create Security Group to create a security group.
- Obtain the security group ID for subsequent use in Creating a Cluster.
diff --git a/docs/dws/api-ref/dws_02_0045.html b/docs/dws/api-ref/dws_02_0045.html
deleted file mode 100644
index 02baf9320..000000000
--- a/docs/dws/api-ref/dws_02_0045.html
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-Tag Management
-
-
-
-
-- Tagging
-
-- Querying Tags in a Project
-
-- Querying Cluster Tags
-
-- Adding Tags in Batches
-
-- Deleting Tags in Batches
-
-
-
-
-Parent topic: API Description
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0047.html b/docs/dws/api-ref/dws_02_0047.html
deleted file mode 100644
index 0db607d22..000000000
--- a/docs/dws/api-ref/dws_02_0047.html
+++ /dev/null
@@ -1,184 +0,0 @@
-
-
-Adding Tags in Batches
-Function
This API is used to add tags to a cluster in batches.
-
-URI
POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-create
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Definition
-Project ID. To obtain the value, see Obtaining a Project ID.
-Constraints
-N/A
-Range
-N/A
-Default Value
-N/A
-cluster_id
-Yes
-String
-Definition
-Cluster ID. To obtain the value, see Obtaining the Cluster ID.
-Constraints
-N/A
-Range
-N/A
-Default Value
-N/A
-
-
-
-Request Parameters
-Table 2 Request body parameters Parameter
-Mandatory
-Type
-Description
-tags
-Yes
-Array of BatchCreateResourceTag objects
-Tag list.
-
-
-
-
-
-Response Parameters
Status code: 200
-Tags are added in batches.
-None
-
-Example Request
Add tags whose key is key and value is value in batches.
-POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/tags/batch-create
-
-{
- "tags" : [ {
- "key" : "key",
- "value" : "value"
- } ]
-}
-
-Example Responses
None
-
-Status Code
-Status Code
-Description
-200
-Tags are added in batches.
-400
-Request error.
-401
-Authorization failed.
-403
-No operation permission.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Tag Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0048.html b/docs/dws/api-ref/dws_02_0048.html
deleted file mode 100644
index 23f2ce396..000000000
--- a/docs/dws/api-ref/dws_02_0048.html
+++ /dev/null
@@ -1,191 +0,0 @@
-
-
-Deleting Tags in Batches
-Function
This API is used to delete tags from a cluster in batches.
-
-URI
POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-delete
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Definition
-Project ID. To obtain the value, see Obtaining a Project ID.
-Constraints
-N/A
-Range
-N/A
-Default Value
-N/A
-cluster_id
-Yes
-String
-Definition
-Cluster ID. To obtain the value, see Obtaining the Cluster ID.
-Constraints
-N/A
-Range
-N/A
-Default Value
-N/A
-
-
-
-Request Parameters
-Table 2 Request body parameters Parameter
-Mandatory
-Type
-Description
-tags
-Yes
-Array of BatchDeleteResourceTag objects
-Definition
-Tag list.
-Constraints
-N/A
-Range
-N/A
-Default Value
-N/A
-
-
-
-
-
-Response Parameters
Status code: 200
-Tags are deleted in batches.
-None
-
-Example Request
Delete tags whose key is key and value is value in batches.
-POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/tags/batch-delete
-
-{
- "tags" : [ {
- "key" : "key",
- "value" : "value"
- } ]
-}
-
-Example Responses
None
-
-Status Code
-Status Code
-Description
-200
-Tags are deleted in batches.
-400
-Request error.
-401
-Authorization failed.
-403
-No operation permission.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Tag Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0049.html b/docs/dws/api-ref/dws_02_0049.html
deleted file mode 100644
index a02affb2e..000000000
--- a/docs/dws/api-ref/dws_02_0049.html
+++ /dev/null
@@ -1,175 +0,0 @@
-
-
-Querying Cluster Tags
-Function
This API is used to query the tags of a cluster.
-
-URI
GET /v1.0/{project_id}/clusters/{cluster_id}/tags
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Definition
-Project ID. To obtain the value, see Obtaining a Project ID.
-Constraints
-N/A
-Range
-N/A
-Default Value
-N/A
-cluster_id
-Yes
-String
-Definition
-Cluster ID. To obtain the value, see Obtaining the Cluster ID.
-Constraints
-N/A
-Range
-N/A
-Default Value
-N/A
-
-
-
-Request Parameters
None
-
-Response Parameters
Status code: 200
-
-Table 2 Response body parameters Parameter
-Type
-Description
-tags
-Array of ResourceTag objects
-Definition
-Tag list.
-Range
-N/A
-
-
-
-
-
-Example Request
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags
-
-Example Responses
Status code: 200
-The cluster tags are queried successfully.
-{
- "tags" : [ {
- "key" : "key",
- "value" : "value"
- } ]
-}
-
-Status Code
-Status Code
-Description
-200
-The cluster tags are queried successfully.
-400
-Request error.
-401
-Authorization failed.
-403
-No operation permission.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Tag Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0050.html b/docs/dws/api-ref/dws_02_0050.html
deleted file mode 100644
index 8148be431..000000000
--- a/docs/dws/api-ref/dws_02_0050.html
+++ /dev/null
@@ -1,159 +0,0 @@
-
-
-Querying Tags in a Project
-Function
This API is used to query the tags of a project.
-
-URI
GET /v1.0/{project_id}/tags
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Definition
-Project ID. To obtain the value, see Obtaining a Project ID.
-Constraints
-N/A
-Range
-N/A
-Default Value
-N/A
-
-
-
-Request Parameters
None
-
-Response Parameters
Status code: 200
-
-Table 2 Response body parameters Parameter
-Type
-Description
-tags
-Array of ProjectTag objects
-Definition
-Tag object.
-Range
-N/A
-
-
-
-
-
-Example Request
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/tags
-
-Example Responses
Status code: 200
-The project tags are queried successfully.
-{
- "tags" : [ {
- "key" : "key",
- "values" : [ "value-1", "value-2" ]
- } ]
-}
-
-Status Code
-Status Code
-Description
-200
-The project tags are queried successfully.
-400
-Request error.
-401
-Authorization failed.
-403
-No operation permission.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Tag Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0052.html b/docs/dws/api-ref/dws_02_0052.html
deleted file mode 100644
index 7acb0a047..000000000
--- a/docs/dws/api-ref/dws_02_0052.html
+++ /dev/null
@@ -1,126 +0,0 @@
-
-
-Restarting a Cluster
-Function
This API is used to restart clusters.
-
-URI
POST /v1.0/{project_id}/clusters/{cluster_id}/restart
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
-cluster_id
-Yes
-String
-ID of the cluster to be restarted. For details about how to obtain the ID, see Obtaining the Cluster ID.
-
-
-
-Request Parameters
-Table 2 Request body parameters Parameter
-Mandatory
-Type
-Description
-restart
-Yes
-Object
-Restart flag
-
-
-
-Response Parameters
None
-
-Example Request
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/restart
-
-{
- "restart" : { }
-}
-
-Example Response
None
-
-Status Code
-Status Code
-Description
-200
-The cluster is restarted.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Cluster Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0053.html b/docs/dws/api-ref/dws_02_0053.html
deleted file mode 100644
index 03c55c7f5..000000000
--- a/docs/dws/api-ref/dws_02_0053.html
+++ /dev/null
@@ -1,152 +0,0 @@
-
-
-Scaling Out a Cluster
-Function
This API is used to scale out a cluster.
-
-URI
POST /v1.0/{project_id}/clusters/{cluster_id}/resize
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
-cluster_id
-Yes
-String
-ID of the cluster to be scaled out. For details about how to obtain the ID, see Obtaining the Cluster ID.
-
-
-
-Request Parameters
-Table 2 Request body parameters Parameter
-Mandatory
-Type
-Description
-scale_out
-No
-ScaleOut object
-Object to be scaled out
-
-
-
-
-
-Response Parameters
None
-
-Example Request
An example of the scale_out API is as follows:POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/resize
-
-{
- "scale_out" : {
- "count" : 3
- }
-}
-
-
-Response Message
None
-
-Status Code
-Status Code
-Description
-200
-The cluster is scaled out successfully.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Cluster Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0054.html b/docs/dws/api-ref/dws_02_0054.html
deleted file mode 100644
index 33405ef26..000000000
--- a/docs/dws/api-ref/dws_02_0054.html
+++ /dev/null
@@ -1,128 +0,0 @@
-
-
-Resetting a Password
-Function
This API is used to reset the password of cluster administrator.
-
-URI
POST /v1.0/{project_id}/clusters/{cluster_id}/reset-password
-
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
-cluster_id
-Yes
-String
-ID of the cluster whose password is to be reset. For details about how to obtain the ID, see Obtaining the Cluster ID.
-
-
-
-Request Parameters
-Table 2 Request body parameters Parameter
-Mandatory
-Type
-Description
-new_password
-Yes
-String
-New administrator password for logging in to a data warehouse cluster
-A password must conform to the following rules:
-- Contains 12 to 32 characters.
- Cannot be the same as the username or the username written in reverse order.
- Contains at least three types of the following:
- Lowercase letters
- Uppercase letters
- Digits
- Special characters: ~!?,.:;-_'"(){}[]/<>@#%^&*+|\=
-
-- Cannot be the same as previous passwords.
- Cannot be a weak password.
-
-
-
-Example Request
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/reset-password
-
-{
- "new_password" : "NewPassword!"
-}
-
-Response Example
None
-
-Status Code
-Status Code
-Description
-200
-The password is reset.
-400
-Request error.
-401
-Authentication failed.
-403
-You do not have required permissions.
-404
-No resources found.
-500
-Internal service error.
-503
-Service unavailable.
-
-
-
-
-
-
-Parent topic: Cluster Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0055.html b/docs/dws/api-ref/dws_02_0055.html
deleted file mode 100644
index a4ccd664b..000000000
--- a/docs/dws/api-ref/dws_02_0055.html
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-Tagging
-A tag is a key-value pair customized by users and used to classify and search for cloud resources.
-A tag consists of a tag key and a tag value.
-- A tag key can contain multiple tag values.
- A cloud resource cannot have duplicate tag keys.
-On GaussDB(DWS), only cluster resources support the tag function.
-
-
-
-Parent topic: Tag Management
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0056.html b/docs/dws/api-ref/dws_02_0056.html
deleted file mode 100644
index 33d86aec3..000000000
--- a/docs/dws/api-ref/dws_02_0056.html
+++ /dev/null
@@ -1,284 +0,0 @@
-
-
-Permissions Policies and Supported Actions
-This section describes fine-grained permissions management for your GaussDB(DWS) service using IAM. You can skip this section if your cloud account already satisfies your needs.
-By default, new IAM users do not have permissions assigned. You need to add the users to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.
-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 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.
-
-
-GaussDB(DWS) supports the following actions that can be defined in custom policies:
-
-
-Managing Clusters
-Permissions
-APIs
-Actions
-IAM Project
-
-Enterprise Project
-
-Creating clusters
-POST /v1.0/{project_id}/clusters
-dws:openAPICluster:create
-√
-√
-Querying the cluster list
-GET /v1.0/{project_id}/clusters
-dws:openAPICluster:list
-√
-√
-Querying cluster details
-GET /v1.0/{project_id}/clusters/{cluster_id}
-dws:openAPICluster:getDetail
-√
-√
-Querying the node type
-GET /v2/{project_id}/node-types
-dws:openAPIFlavors:get
-√
-√
-Deleting clusters
-DELETE /v1.0/{project_id}/clusters/{cluster_id}
-dws:openAPICluster:delete
-√
-√
-Restarting clusters
-POST /v1.0/{project_id}/clusters/{cluster_id}/restart
-dws:openAPICluster:restart
-√
-√
-Scales out a cluster.
-POST /v1.0/{project_id}/clusters/{cluster_id}/resize
-dws:cluster:scaleOutOrOpenAPIResize
-√
-√
-Resetting the cluster's administrator password
-POST /v1.0/{project_id}/clusters/{cluster_id}/reset-password
-dws:openAPICluster:resetPassword
-√
-√
-
-
-
-Managing Snapshots
-Permissions
-APIs
-Actions
-IAM Project
-
-Enterprise Project
-
-Creating snapshots
-POST /v1.0/{project_id}/snapshots
-dws:openAPISnapshot:create
-√
-√
-Querying the snapshot list
-GET /v1.0/{project_id}/snapshots
-dws:openAPISnapshot:list
-√
-√
-Querying snapshot details
-GET /v1.0/{project_id}/snapshots/{snapshot_id}
-dws:openAPISnapshot:detail
-√
-√
-Deleting snapshots
-DELETE /v1.0/{project_id}/snapshots/{snapshot_id}
-dws:openAPISnapshot:delete
-√
-√
-Restoring clusters
-POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions
-dws:openAPISnapshot:restore
-√
-√
-
-
-
-Managing Tags
-Permissions
-APIs
-Actions
-IAM Project
-
-Enterprise Project
-
-Adding a resource tag
-POST /v1.0/{project_id}/clusters/{resource_id}/tags
-dws:openAPITag:add
-√
-√
-Adding and deleting resource tags in batches
-POST /v1.0/{project_id}/clusters/{resource_id}/tags/action
-dws:openAPITag:update
-√
-√
-Querying resources by tag
-POST /v1.0/{project_id}/clusters/resource_instances/action
-dws:openAPITag:getResourceByTag
-√
-√
-Querying resource tags
-GET /v1.0/{project_id}/clusters/{resource_id}/tags
-dws:openAPITag:getResourceTag
-√
-√
-Querying tags in a specified project
-GET /v1.0/{project_id}/clusters/tags
-dws:openAPITag:list
-√
-√
-Deleting a tag
-DELETE /v1.0/{project_id}/clusters/{resource_id}/tags/{key}
-dws:openAPITag:delete
-√
-√
-
-
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0057.html b/docs/dws/api-ref/dws_02_0057.html
index 677b41c1f..3492961a6 100644
--- a/docs/dws/api-ref/dws_02_0057.html
+++ b/docs/dws/api-ref/dws_02_0057.html
@@ -1,21 +1,21 @@
-
+
Before You Start
-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.
+Overview
Welcome to DWS. 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.
+This guide explains how to use APIs to manage DWS clusters, including creating, querying, and deleting tags and snapshots. For a comprehensive list of all supported operations, see API Overview.
+Before calling an API, get familiar with related concepts of DWS. For details, see "Service Overview" in the DWS User Guide.
+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".
+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.
+Basic Concepts
- Account
An account has full access permissions for all the resources and cloud services. It can be used to reset user passwords and grant user permissions. For security purposes, create IAM users and grant 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, user, and password will be 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.
+ - 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.
diff --git a/docs/dws/api-ref/dws_02_0061.html b/docs/dws/api-ref/dws_02_0061.html
new file mode 100644
index 000000000..3e83a5c90
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0061.html
@@ -0,0 +1,307 @@
+
+
+Permissions and Supported Actions
+This section describes fine-grained permissions management for your DWS service using IAM. You can skip this section if your cloud account already satisfies your needs.
+By default, new IAM users do not have permissions assigned. You need to add the users to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.
+You can grant users permissions by using roles and policies. Roles are provided by IAM to define service-based permissions depending on user's 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 the permissions required to call all APIs, but IAM users must be assigned the required permissions. 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 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:
+- 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.
+
+
+DWS supports the following actions that can be defined in custom policies:
+
+
+Managing Clusters
+Permissions
+APIs
+Actions
+IAM Project
+
+Enterprise Project
+
+Creating clusters
+POST /v1.0/{project_id}/clusters
+dws:openAPICluster:create
+√
+√
+Querying the cluster list
+GET /v1.0/{project_id}/clusters
+dws:openAPICluster:list
+√
+√
+Querying cluster details
+GET /v1.0/{project_id}/clusters/{cluster_id}
+dws:openAPICluster:getDetail
+√
+√
+Querying the node type
+GET /v2/{project_id}/node-types
+dws:openAPIFlavors:get
+√
+√
+Deleting clusters
+DELETE /v1.0/{project_id}/clusters/{cluster_id}
+dws:openAPICluster:delete
+√
+√
+Restarting clusters
+POST /v1.0/{project_id}/clusters/{cluster_id}/restart
+dws:openAPICluster:restart
+√
+√
+Scales out a cluster.
+POST /v1.0/{project_id}/clusters/{cluster_id}/resize
+dws:cluster:scaleOutOrOpenAPIResize
+√
+√
+Resetting the cluster's administrator password
+POST /v1.0/{project_id}/clusters/{cluster_id}/reset-password
+dws:openAPICluster:resetPassword
+√
+√
+Starting a cluster
+POST /v1/
+{project_id}/clusters/{cluster_id}/start
+dws:cluster:startCluster
+√
+×
+Stopping a cluster
+POST /v1/{project_id}/clusters/{cluster_id}/stop
+dws:cluster:stopCluster
+√
+×
+
+
+
+Managing Snapshots
+Permissions
+APIs
+Actions
+IAM Project
+
+Enterprise Project
+
+Creating snapshots
+POST /v1.0/{project_id}/snapshots
+dws:openAPISnapshot:create
+√
+√
+Querying the snapshot list
+GET /v1.0/{project_id}/snapshots
+dws:openAPISnapshot:list
+√
+√
+Querying snapshot details
+GET /v1.0/{project_id}/snapshots/{snapshot_id}
+dws:openAPISnapshot:detail
+√
+√
+Deleting snapshots
+DELETE /v1.0/{project_id}/snapshots/{snapshot_id}
+dws:openAPISnapshot:delete
+√
+√
+Restoring clusters
+POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions
+dws:openAPISnapshot:restore
+√
+√
+
+
+
+Managing Tags
+Permissions
+APIs
+Actions
+IAM Project
+
+Enterprise Project
+
+Adding a resource tag
+POST /v1.0/{project_id}/clusters/{resource_id}/tags
+dws:openAPITag:add
+√
+√
+Adding and deleting resource tags in batches
+POST /v1.0/{project_id}/clusters/{resource_id}/tags/action
+dws:openAPITag:update
+√
+√
+Querying resources by tag
+POST /v1.0/{project_id}/clusters/resource_instances/action
+dws:openAPITag:getResourceByTag
+√
+√
+Querying resource tags
+GET /v1.0/{project_id}/clusters/{resource_id}/tags
+dws:openAPITag:getResourceTag
+√
+√
+Querying tags in a specified project
+GET /v1.0/{project_id}/clusters/tags
+dws:openAPITag:list
+√
+√
+Deleting a tag
+DELETE /v1.0/{project_id}/clusters/{resource_id}/tags/{key}
+dws:openAPITag:delete
+√
+√
+
+
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0062.html b/docs/dws/api-ref/dws_02_0062.html
index ea5e6b50c..fc82ab4a7 100644
--- a/docs/dws/api-ref/dws_02_0062.html
+++ b/docs/dws/api-ref/dws_02_0062.html
@@ -1,4 +1,4 @@
-
+
Calling APIs
diff --git a/docs/dws/api-ref/dws_02_0063.html b/docs/dws/api-ref/dws_02_0063.html
index 1d8dfa564..31d85fcc4 100644
--- a/docs/dws/api-ref/dws_02_0063.html
+++ b/docs/dws/api-ref/dws_02_0063.html
@@ -1,211 +1,109 @@
-
+
Making an API Request
-This section describes the structure of a REST API request, and describes how to call an API by obtaining a user token of the IAM service. The obtained token can then be used to authenticate the calling of other APIs.
-Request URI
A request URI is in the following format:
-{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
-Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
+This section describes the structure of a RESTful API request, and uses the IAM API for creating an IAM user as an example to describe how to call an API.
+Request URI
A request URI is in the following format:
+{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
+Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
-Table 1 URI parameter description Parameter
+Table 1 URI parameter description Parameter
Description
+Description
URI-scheme
+URI-scheme
Protocol used to transmit requests. All APIs use HTTPS.
+Protocol used to transmit requests. All APIs use HTTPS.
Endpoint
+Endpoint
Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies between services in different regions. It can be obtained from the "Regions and Endpoints" section.
-For example, the endpoint of IAM in the eu-de region is iam.eu-de.otc.t-systems.com.
+Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints.
+For example, the endpoint of IAM in the eu-de region is iam.eu-de.otc.t-systems.com.
resource-path
+resource-path
Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.
+Access path of an API for performing a specified operation. Obtain the value from the URI of an API. For example, resource-path of the API used to create an IAM user is /v3.0/OS-USER/users.
query-string
+query-string
Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ?limit=10 indicates that a maximum of 10 data records will be displayed.
+Query parameter, which is optional. The query parameter must be in the format of parameter-name=parameter-value and prefixed with a question mark (?). For example, limit=10 indicates that a maximum of 10 data records will be displayed.
- To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
+ To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
-Request Methods
The HTTP protocol defines the following request methods that can be used to send a request to the server:
-Table 2 HTTP methods Method
+Request Methods
The HTTP protocol defines the following request methods that can be used to send a request to the server.
+Table 2 HTTP methods Method
Description
+Description
GET
+GET
Requests the server to return specified resources.
+Requests the server to return specified resources.
PUT
+PUT
Requests the server to update specified resources.
+Requests the server to update specified resources.
POST
+POST
Requests the server to add resources or perform special operations.
+Requests the server to add resources or perform special operations.
DELETE
+DELETE
Requests the server to delete specified resources, for example, an object.
+Requests the server to delete specified resources, for example, an object.
HEAD
+HEAD
Same as GET except that the server must return only the response header.
+Same as GET except that the server must return only the response header.
PATCH
+PATCH
Requests the server to update partial content of a specified resource.
-If the resource does not exist, a new resource will be created.
+Requests the server to update partial content of a specified resource.
+If the resource does not exist, a new resource will be created.
-For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
-POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokens
-Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-type, which specifies the request body type.
-For details about common request headers, see Table 3.
-Table 3 Common request header fields Field
-Description
-Mandatory
-Example
-x-sdk-date
-Time when the request is sent. The time is in YYYYMMDD'T'HHMMSS'Z' format.
-The value is the current GMT time of the system.
-No
-20150907T101459Z
-Host
-Server information of the resource being requested. The value can be obtained from the URL of the service API. The value is in the format of hostname[:port]. If the port number is not specified, the default port is used. The default port number for HTTPS is 443.
-No
-code.test.com
-or
-code.test.com:443
-Content-Type
-Request body MIME type. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.
-Yes
-application/json
-Content-Length
-Length of the request body. The unit is byte.
-No
-3495
-X-Project-id
-Project ID. Obtain the project ID by following the instructions in Obtaining a Project ID.
-No
-e9993fc787d94b6c886cbaa340f9c0f4
-X-Auth-Token
-User token.
-The user token is a response to the API used to obtain a user token. This API is the only one that does not require authentication.
-The X-Subject-Token value contained in the returned message header is the token.
-No
-This parameter is mandatory for token-based authentication.
-The following is part of an example token:
-MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
-X-Language
-Request language.
-No
-en_us
-
+Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-type, which specifies the request body type.
+Common request headers include:
+- Content-Type: specifies the request body type or format. This field is mandatory and its default value is application/json. Other values of this field (if any) will be provided for specific APIs.
- Authorization: specifies signature authentication information. This field is optional. When AK/SK authentication is enabled, this field is automatically specified when SDK is used to sign the request. For more information, see AK/SK-based Authentication.
- X-Sdk-Date: specifies the time when a request is sent. This field is optional. When AK/SK authentication is enabled, this field is automatically specified when SDK is used to sign the request. For more information, see AK/SK-based Authentication.
- X-Auth-Token: specifies a user token only for token-based API authentication.
- X-Project-ID: specifies subproject ID. This field is optional and can be used in multi-project scenarios. This field is mandatory in the request header for accessing resources in a sub-project through AK/SK-based authentication.
- X-Domain-ID: specifies the account ID, which is optional. When you call APIs of global services using AK/SK-based authentication, X-Domain-ID needs to be configured in the request header.
-
-The API used to obtain a user token does not require authentication. Therefore, only the Content-type field needs to be added to requests for calling the API. An example of such requests is as follows:
-
-POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokens
-Content-type: application/json
-Request Body
The body of a request is often sent in a structured format (JSON or XML) as specified in the Content-type header field. The request body transfers content except the request header. If the request body contains Chinese characters, these characters must be coded in UTF-8.
-The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
-In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace user_name, domainname (account name), ******** (login password), and xxxxxxxxxxxxxxxxxx (project ID) with actual ones. Obtain the project ID from the database administrator.
- The scope parameter specifies where a token takes effect. In the example, the token takes effect only on the resources specified by the project. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.
-
-POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokens
-Content-type: application/json
-
-{
- "auth": {
- "identity": {
- "methods": [
- "password"
- ],
- "password": {
- "user": {
- "name": "user_name",
- "password": "********",
- "domain": {
- "name": "domainname"
- }
- }
- }
- },
- "scope": {
- "project": {
- "id": "xxxxxxxxxxxxxxxxxx"
- }
- }
- }
-}
-If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.
+Request Body
The body of a request is often sent in a structured format (JSON or XML) as specified in the Content-type header field. The request body transfers content except the request header. If the request body contains Chinese characters, these characters must be coded in UTF-8. Specify the character encoding mode in Content-type, for example, Content-Type: application/json; charset=utf-8.
+The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
+In the case of the API used to , the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included.
+- accountid: ID of the account to which the IAM user belongs.
- username: IAM username to be created.
- email: email address of the IAM user.
- **********: password of the IAM user.
+
+Content-type: application/json
+X-Sdk-Date: 20240416T095341Z
+ Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
+{
+ "user": {
+ "domain_id": "accountid",
+ "name": "username",
+ "password": "**********",
+ "email": "email",
+ "description": "IAM User Description"
+ }
+ }
+The content required by an API request is ready. You can use curl, Postman, or write code to send the request to call the API.
diff --git a/docs/dws/api-ref/dws_02_0064.html b/docs/dws/api-ref/dws_02_0064.html
index e49fb4501..a57b38b49 100644
--- a/docs/dws/api-ref/dws_02_0064.html
+++ b/docs/dws/api-ref/dws_02_0064.html
@@ -1,12 +1,21 @@
-
+
Authentication
-Calling an API can be authenticated using tokens.
-Token-based Authentication
A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to request headers to get permissions for calling the API.
- The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
+You can use either of the following authentication methods when calling APIs:
+- AK/SK authentication: Requests are encrypted using an AK/SK.
- Token authentication: Requests are authenticated using a token.
+AK/SK-based Authentication
- AK/SK-based authentication supports API requests with a body no larger than 12 MB. For API requests with a larger body, you should use token-based authentication.
- You can use the AK/SK in a permanent or temporary access key. The X-Security-Token field must be configured if the AK/SK in a temporary access key is used, and the field value is security_token of the temporary access key.
-When calling the API to obtain a user token, you must set auth.scope in the request body to project.
-{
+In AK/SK-based authentication, the AK/SK is used to sign requests and the signature is then added to the requests for authentication.
+- AK: access key ID, which is a unique identifier used with a secret access key to sign requests cryptographically.
- SK: secret access key. It is used together with an AK to sign requests. They can identify request senders and prevent requests from being modified.
+In AK/SK-based authentication, you can use the AK/SK to sign requests based on the signature algorithm or use a dedicated signing SDK to sign requests. For details about how to sign requests and use the signing SDK, see the AK/SK Signing and Authentication Guide.
+
The signing SDKs are only used for signing requests and different from the SDKs provided by services.
+
+
+Token-based Authentication
A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to request headers to get permissions for calling the API.
+ - Cache the token for authentication to prevent frequently calling the IAM API to obtain the token. A token is valid for 24 hours.
- Ensure that the token is valid while you use it. Using a token that will soon expire may cause API calling failures.
+
+When calling the API to obtain a user token, you must set auth.scope in the request body to project.
+{
"auth": {
"identity": {
"methods": [
@@ -14,22 +23,22 @@
],
"password": {
"user": {
- "name": "user_name",
- "password": "********",
+ "name": "user_name",
+ "password": "********",
"domain": {
- "name": "domainname"
+ "name": "domainname"
}
}
}
},
- "scope": {
- "project": {
- "id": "xxxxxxxx"
- }
- }
+ "scope": {
+ "project": {
+ "name": "xxxxxxxx"
+ }
+ }
}
}
-After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. If the token is ABCDEFG...., add X-Auth-Token: ABCDEFG.... to a request.
+After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFG..., add X-Auth-Token: ABCDEFG.... to the request header.
diff --git a/docs/dws/api-ref/dws_02_0065.html b/docs/dws/api-ref/dws_02_0065.html
index 84cc00406..59d9916a2 100644
--- a/docs/dws/api-ref/dws_02_0065.html
+++ b/docs/dws/api-ref/dws_02_0065.html
@@ -1,35 +1,43 @@
-
+
Response
-Status Code
After sending a request, you will receive a response, including a status code, response header, and response body.
-A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.
-For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.
+After sending a request, you will receive a response containing the status code, response header, and response body.
+Status Code
A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.
-Response Header
Similar to a request, a response also has a header, for example, content-type.
-Figure 1 shows the response header fields for the API used to obtain a user token. The x-subject-token header field is the desired user token. You can use this token to authenticate the calling of other APIs.
-
+Response Header
Similar to a request, a response also has a header, for example, content-type.
+Figure 1 Response headers
-Response Body
The body of a response is often returned in structured format (for example, JSON or XML) as specified in the Content-type header field. The response body transfers content except the response header.
+Response Body
The body of a response is often returned in structured format (for example, JSON or XML) as specified in the Content-type header field. The response body transfers content except the response header.
-The following is part of the response body for the API used to obtain a user token.
-{
- "token": {
- "expires_at": "2019-02-13T06:52:13.855000Z",
- "methods": [
- "password"
- ],
- "catalog": [
- {
- "endpoints": [
- {
- "region_id": "eu-de",
-......
-If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
-{
- "error_msg": "The format of message is error",
- "error_code": "AS.0001"
+{
+ "user": {
+ "id": "c131886aec...",
+ "name": "IAMUser",
+ "description": "IAM User Description",
+ "areacode": "",
+ "phone": "",
+ "email": "***@***.com",
+ "status": null,
+ "enabled": true,
+ "pwd_status": false,
+ "access_mode": "default",
+ "is_domain_owner": false,
+ "xuser_id": "",
+ "xuser_type": "",
+ "password_expires_at": null,
+ "create_time": "2024-05-21T09:03:41.000000",
+ "domain_id": "d78cbac1..........",
+ "xdomain_id": "30086000........",
+ "xdomain_type": "",
+ "default_project_id": null
+ }
}
-In the response body, error_code is an error code, and error_msg provides information about the error.
+If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
+{
+ "error_msg": "The format of message is error",
+ "error_code": "AS.0001"
+}
+In the response body, error_code is an error code, and error_msg provides information about the error.
diff --git a/docs/dws/api-ref/dws_02_0066.html b/docs/dws/api-ref/dws_02_0066.html
index 7d325ea28..47e62427e 100644
--- a/docs/dws/api-ref/dws_02_0066.html
+++ b/docs/dws/api-ref/dws_02_0066.html
@@ -1,7 +1,7 @@
-
+
Appendix
-
+
@@ -11,9 +11,9 @@
- Creating a VPC
-- Obtaining a Project ID
+ - Obtaining Project ID
-- Obtaining an Account
+ - Obtaining an Account ID
- Obtaining the Cluster ID
diff --git a/docs/dws/api-ref/dws_02_0067.html b/docs/dws/api-ref/dws_02_0067.html
index 9a9031fe0..9b0e778b6 100644
--- a/docs/dws/api-ref/dws_02_0067.html
+++ b/docs/dws/api-ref/dws_02_0067.html
@@ -1,8 +1,8 @@
-
+
-Obtaining an Account
-An account ID (domain-id) is required for some URLs when an API is called. To obtain the account ID, do as follows:
-- Log in to the management console.
- Click the username and select My Credential from the drop-down list.
On the My Credential page, view the Account ID.
+Obtaining an Account ID
+An account ID (domain-id) is required for some URLs when an API is called. To obtain the account ID, perform the following steps:
+- Log in to the management console.
- Click the username and select My Credential from the drop-down list.
On the My Credential page, view the Account ID.
diff --git a/docs/dws/api-ref/dws_02_0525.html b/docs/dws/api-ref/dws_02_0525.html
new file mode 100644
index 000000000..9a187ffa5
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0525.html
@@ -0,0 +1,26 @@
+
+
+Event Management
+
+
+
+
+- Querying Event List
+
+- Querying Event Configurations
+
+- Querying Subscribed Events
+
+- Creating an Event Subscription
+
+- Modifying a Subscribed Event
+
+- Deleting a Subscribed Event
+
+
+
+
+Parent topic: API Description
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0536.html b/docs/dws/api-ref/dws_02_0536.html
new file mode 100644
index 000000000..920997f85
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0536.html
@@ -0,0 +1,16 @@
+
+
+Audit Logs
+
+
+
+
+- Querying Log Records
+
+
+
+
+Parent topic: API Description
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0538.html b/docs/dws/api-ref/dws_02_0538.html
new file mode 100644
index 000000000..014d1860f
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0538.html
@@ -0,0 +1,70 @@
+
+
+Resource Management
+
+
+
+
+- Querying Whether Resource Management Is Enabled
+
+- Querying the Resource Management Plan List
+
+- Creating a Resource Management Plan
+
+- Querying Resource Pools
+
+- Creating a Resource Pool
+
+- Stopping a Resource Management Plan
+
+- Querying Details About a Resource Management Plan
+
+- Deleting a Resource Management Plan
+
+- Starting a Resource Management Plan
+
+- Querying the List of Users Bound to a Resource Pool
+
+- Querying Resource Pool Details
+
+- Querying Stage Details About a Resource Management Plan
+
+- Deleting a Stage of Resource Management Plan
+
+- Modifying a Stage of a Resource Management Plan
+
+- Querying Plan Execution Logs
+
+- Deleting a User Bound to a Resource Pool
+
+- Switching the Stage of a Resource Management Plan
+
+- Associating a User to a Resource Pool
+
+- Modifying Resource Configurations of a Resource Pool
+
+- Querying the Schema Space Information of a Cluster
+
+- Editing the Space Limit of a Schema
+
+- Adding a Stage for a Resource Management Plan
+
+- Deleting a Resource Pool
+
+- Querying the Exception Rule List of a Cluster
+
+- Adding an Exception Rule
+
+- Deleting an Exception Rule
+
+- Editing an Exception Rule
+
+- Enabling or Disabling Resource Management
+
+
+
+
+Parent topic: API Description
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0544.html b/docs/dws/api-ref/dws_02_0544.html
new file mode 100644
index 000000000..83a07d970
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0544.html
@@ -0,0 +1,28 @@
+
+
+Alarm Management
+
+
+
+
+- Querying Alarm Configurations
+
+- Querying Alarm Details List
+
+- Querying the Alarm Statistics List
+
+- Querying the Alarm Subscription List
+
+- Creating an Alarm Subscription
+
+- Modifying an Alarm Subscription
+
+- Deleting an Alarm Subscription
+
+
+
+
+Parent topic: API Description
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0552.html b/docs/dws/api-ref/dws_02_0552.html
new file mode 100644
index 000000000..3d27afd90
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0552.html
@@ -0,0 +1,16 @@
+
+
+AZ Management
+
+
+
+
+- Querying the AZ List
+
+
+
+
+Parent topic: API Description
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0554.html b/docs/dws/api-ref/dws_02_0554.html
new file mode 100644
index 000000000..fd42a690c
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0554.html
@@ -0,0 +1,32 @@
+
+
+Connection Management
+
+
+
+
+- Querying Connection Information
+
+- Applying for a Domain Name
+
+- Modifying a Cluster Domain Name
+
+- Deleting a Cluster Domain Name
+
+- Querying the List of ELBs That Can Be Bound to a Cluster
+
+- Binding an ELB to a Cluster
+
+- Unbinding an ELB from a Cluster
+
+- Binding an EIP to a Cluster
+
+- Unbinding an EIP from a Cluster
+
+
+
+
+Parent topic: API Description
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0563.html b/docs/dws/api-ref/dws_02_0563.html
new file mode 100644
index 000000000..82cfa53f3
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0563.html
@@ -0,0 +1,22 @@
+
+
+Tag Management
+
+
+
+
+- Querying Project Tags
+
+- Querying Cluster Tags
+
+- Adding Tags in Batches
+
+- Delete Tags in Batches
+
+
+
+
+Parent topic: API Description
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0604.html b/docs/dws/api-ref/dws_02_0604.html
new file mode 100644
index 000000000..c23f79ce0
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0604.html
@@ -0,0 +1,18 @@
+
+
+Task Management
+
+
+
+
+
+
+Parent topic: API Description
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0605.html b/docs/dws/api-ref/dws_02_0605.html
new file mode 100644
index 000000000..bdac223fd
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0605.html
@@ -0,0 +1,36 @@
+
+
+Logical Cluster Management
+
+
+
+
+- Converting a Physical Cluster to a Logical Cluster
+
+- Creating a Logical Cluster
+
+- Scaling In a Logical Cluster
+
+- Querying Disk Information of a Logical Cluster
+
+- Querying Task Information About a Logical Cluster
+
+- Querying the Logical Cluster List
+
+- Querying Information About Available Ring Nodes in a Logical Cluster
+
+- Restarting a Logical Cluster
+
+- Deleting a Logical Cluster
+
+- Editing a Logical Cluster
+
+- Switching to a Logical Cluster
+
+
+
+
+Parent topic: API Description
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0799.html b/docs/dws/api-ref/dws_02_0799.html
new file mode 100644
index 000000000..6aae656b8
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0799.html
@@ -0,0 +1,20 @@
+
+
+Log Management
+
+
+
+
+- Obtaining the LTS Log List
+
+- Disabling LTS
+
+- Enabling LTS
+
+
+
+
+Parent topic: API Description
+
+
+
diff --git a/docs/dws/api-ref/figure/en-us_image_0000001185833158.png b/docs/dws/api-ref/figure/en-us_image_0000001185833158.png
deleted file mode 100644
index d09645393..000000000
Binary files a/docs/dws/api-ref/figure/en-us_image_0000001185833158.png and /dev/null differ
diff --git a/docs/dws/api-ref/figure/en-us_image_0000001231472779.png b/docs/dws/api-ref/figure/en-us_image_0000001231472779.png
deleted file mode 100644
index 981473001..000000000
Binary files a/docs/dws/api-ref/figure/en-us_image_0000001231472779.png and /dev/null differ
diff --git a/docs/dws/api-ref/figure/en-us_image_0000002138022226.png b/docs/dws/api-ref/figure/en-us_image_0000002138022226.png
deleted file mode 100644
index 15070b937..000000000
Binary files a/docs/dws/api-ref/figure/en-us_image_0000002138022226.png and /dev/null differ
diff --git a/docs/dws/api-ref/figure/en-us_image_0000002500014136.png b/docs/dws/api-ref/figure/en-us_image_0000002500014136.png
new file mode 100644
index 000000000..cf44ab628
Binary files /dev/null and b/docs/dws/api-ref/figure/en-us_image_0000002500014136.png differ
diff --git a/docs/dws/api-ref/figure/en-us_image_0000002531894007.png b/docs/dws/api-ref/figure/en-us_image_0000002531894007.png
new file mode 100644
index 000000000..54638588c
Binary files /dev/null and b/docs/dws/api-ref/figure/en-us_image_0000002531894007.png differ
diff --git a/docs/dws/api-ref/figure/en-us_image_0000002531894009.png b/docs/dws/api-ref/figure/en-us_image_0000002531894009.png
new file mode 100644
index 000000000..a58063e2a
Binary files /dev/null and b/docs/dws/api-ref/figure/en-us_image_0000002531894009.png differ
diff --git a/docs/dws/api-ref/figure/en-us_image_0000001186151638.jpg b/docs/dws/api-ref/figure/en-us_image_0000002531894011.jpg
similarity index 100%
rename from docs/dws/api-ref/figure/en-us_image_0000001186151638.jpg
rename to docs/dws/api-ref/figure/en-us_image_0000002531894011.jpg
