forked from docs/doc-exports
luhuayi
007dffd756
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: luhuayi <luhuayi@huawei.com> Co-committed-by: luhuayi <luhuayi@huawei.com>
1469 lines
56 KiB
JSON
1469 lines
56 KiB
JSON
[
|
|
{
|
|
"desc":"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 cl",
|
|
"product_code":"dws",
|
|
"title":"Before You Start",
|
|
"uri":"dws_02_0057.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"1"
|
|
},
|
|
{
|
|
"desc":"DWS provides in-house APIs. The following table lists the key functions of DWS APIs. For details about other APIs, see the corresponding sections.",
|
|
"product_code":"dws",
|
|
"title":"API Overview",
|
|
"uri":"dws_02_0034.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"2"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dws",
|
|
"title":"Calling APIs",
|
|
"uri":"dws_02_0062.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"3"
|
|
},
|
|
{
|
|
"desc":"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.A request URI is",
|
|
"product_code":"dws",
|
|
"title":"Making an API Request",
|
|
"uri":"dws_02_0063.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"4"
|
|
},
|
|
{
|
|
"desc":"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 ar",
|
|
"product_code":"dws",
|
|
"title":"Authentication",
|
|
"uri":"dws_02_0064.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"5"
|
|
},
|
|
{
|
|
"desc":"After sending a request, you will receive a response containing the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t",
|
|
"product_code":"dws",
|
|
"title":"Response",
|
|
"uri":"dws_02_0065.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"6"
|
|
},
|
|
{
|
|
"desc":"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 to",
|
|
"product_code":"dws",
|
|
"title":"Getting Started",
|
|
"uri":"dws_02_0036.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"7"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dws",
|
|
"title":"API Description",
|
|
"uri":"dws_02_0037.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"8"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"AZ Management",
|
|
"uri":"dws_02_0552.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"9"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the ID of the AZ, which you will need to create an instance.For details, see Calling APIs.GET /v1.0/{project_id}/availability-zonesNoneStatus co",
|
|
"product_code":"DWS",
|
|
"title":"Querying the AZ List",
|
|
"uri":"ListAvailabilityZones.html",
|
|
"doc_type":"api",
|
|
"p_code":"9",
|
|
"code":"10"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Cluster Management",
|
|
"uri":"dws_02_0017.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"11"
|
|
},
|
|
{
|
|
"desc":"This API is used to query flavors supported by GaussDB(DWS).For details, see Calling APIs.GET /v2/{project_id}/node-typesNoneStatus code: 200Query flavor information.Stat",
|
|
"product_code":"DWS",
|
|
"title":"Querying Flavor Information",
|
|
"uri":"ListNodeTypes.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"desc":"This API is used to query and display the cluster list.For details, see Calling APIs.GET /v2/{project_id}/clustersNoneStatus code: 200Query the cluster list.Status code: ",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Cluster List (V2)",
|
|
"uri":"ShowClusters.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the enterprise project information of a specified cluster.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/enterprise-pr",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Enterprise Project Information of a Cluster",
|
|
"uri":"ListTagsForResource.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the cluster list.For details, see Calling APIs.GET /v1.0/{project_id}/clustersNoneStatus code: 200Query the cluster list.Status code: 200Cluster",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Cluster List",
|
|
"uri":"ListClusters.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"This API is used to query cluster details.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}NoneStatus code: 200Query cluster details.Status code:",
|
|
"product_code":"DWS",
|
|
"title":"Querying Cluster Details",
|
|
"uri":"ListClusterDetails.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a cluster.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 a",
|
|
"product_code":"DWS",
|
|
"title":"Creating a Cluster",
|
|
"uri":"CreateCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"17"
|
|
},
|
|
{
|
|
"desc":"This API is used to perform a pre-check before cluster creation. It can identify problems such as insufficient subnets and quotas in advance, preventing cluster creation ",
|
|
"product_code":"DWS",
|
|
"title":"Performing a Check Before Cluster Creation",
|
|
"uri":"CheckCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a cluster.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 a",
|
|
"product_code":"DWS",
|
|
"title":"Creating a Cluster (V2)",
|
|
"uri":"CreateClusterV2.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"desc":"This API is used to restart a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/restartStatus code: 200The request for restarting the cl",
|
|
"product_code":"DWS",
|
|
"title":"Restarting a Cluster",
|
|
"uri":"RestartCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"desc":"This API is used to reset the administrator password of a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/reset-passwordStatus code: 2",
|
|
"product_code":"DWS",
|
|
"title":"Resetting a Password",
|
|
"uri":"ResetPassword.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"21"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the security group of a cluster.For details, see Calling APIs.PUT /v1/{project_id}/clusters/{cluster_id}/security-groupStatus code: 200Cluster ",
|
|
"product_code":"DWS",
|
|
"title":"Modifying the Security Group of a Cluster",
|
|
"uri":"ChangeSecurityGroup.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"desc":"In the Unbalanced state, the number of primary instances on some nodes increases. As a result, the load pressure is high. In this case, the cluster is normal, but the ove",
|
|
"product_code":"DWS",
|
|
"title":"Performing a Switchback",
|
|
"uri":"SwitchOverCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"desc":"This API is used to cancel the read-only status on the management console. When a cluster is in the read-only state, you cannot perform any database operations. The read-",
|
|
"product_code":"DWS",
|
|
"title":"Canceling Read-only Status of a Cluster",
|
|
"uri":"CancelReadonlyCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"24"
|
|
},
|
|
{
|
|
"desc":"This API is used to query ring node information in the cluster topology.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/topo/ringsNoneStatus code",
|
|
"product_code":"DWS",
|
|
"title":"Querying Ring Node Information in the Cluster Topology",
|
|
"uri":"ListTopoRings.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"25"
|
|
},
|
|
{
|
|
"desc":"This API is used to stop a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/stopNoneStatus code: 200Stop a cluster.Status code: 200The re",
|
|
"product_code":"DWS",
|
|
"title":"Stopping a Cluster",
|
|
"uri":"StopCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"26"
|
|
},
|
|
{
|
|
"desc":"This API is used to start a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/startNoneStatus code: 200Start a cluster.Status code: 200Req",
|
|
"product_code":"DWS",
|
|
"title":"Starting a Cluster",
|
|
"uri":"StartCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"27"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the time zone of a cluster. This operation will change the time zone of the OS as well as the database.ConstraintsTo change the time zone of a ",
|
|
"product_code":"DWS",
|
|
"title":"Changing Cluster Time Zone",
|
|
"uri":"ModifyClusterTimezone.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"28"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. For data security, you need to create a snapshot fo",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a Cluster",
|
|
"uri":"DeleteCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"29"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. For data security, you need to create a snapshot fo",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a Cluster (V2)",
|
|
"uri":"DeleteDwsCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"30"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the list of DSS storage pools. Only SSD dedicated resource pools that you enabled can be queried.For details, see Calling APIs.GET /v1.0/{projec",
|
|
"product_code":"DWS",
|
|
"title":"Querying the DSS Storage Pool List",
|
|
"uri":"ListDssPools.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"31"
|
|
},
|
|
{
|
|
"desc":"This API is used to query flavor details of a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/flavorNoneStatus code: 200Query the cluster",
|
|
"product_code":"DWS",
|
|
"title":"Querying Flavor Details of a Cluster",
|
|
"uri":"ShowClusterFlavor.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"32"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the cluster description.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/descriptionStatus code: 200Modify the cluster",
|
|
"product_code":"DWS",
|
|
"title":"Modifying Cluster Description",
|
|
"uri":"SaveClusterDescriptionInfo.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"33"
|
|
},
|
|
{
|
|
"desc":"This API is used to query details about a single instance.For details, see Calling APIs.GET /v2/{project_id}/instances/{instance_id}NoneStatus code: 200Query information ",
|
|
"product_code":"DWS",
|
|
"title":"Querying an Instance",
|
|
"uri":"ShowInstance.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"34"
|
|
},
|
|
{
|
|
"desc":"This API is used to query resource statistics.For details, see Calling APIs.GET /v1/{project_id}/resource-statisticsNoneStatus code: 200Query resource statistics.Status c",
|
|
"product_code":"DWS",
|
|
"title":"Querying Resource Statistics",
|
|
"uri":"ShowResourceStatistics.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"35"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the disk usage of a tenant management node.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/volumeNoneStatus code: 200Qu",
|
|
"product_code":"DWS",
|
|
"title":"Querying Disk Usage",
|
|
"uri":"ShowClusterVolume.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"36"
|
|
},
|
|
{
|
|
"desc":"This API is used to change a cluster name.ConstraintsThis parameter is available only for GuestAgent 8.3.1 or later.For details, see Calling APIs.PUT /v1/{project_id}/clu",
|
|
"product_code":"DWS",
|
|
"title":"Changing a Cluster Name",
|
|
"uri":"ModifyClusterName.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"37"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Node Change",
|
|
"uri":"dws_02_0026.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"38"
|
|
},
|
|
{
|
|
"desc":"Disk capacity is more likely to become the bottleneck of storage as workloads develop. When other resources are sufficient, disk capacity expansion can help you quickly b",
|
|
"product_code":"DWS",
|
|
"title":"Expanding Disk Capacity",
|
|
"uri":"ExpandInstanceStorage.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"39"
|
|
},
|
|
{
|
|
"desc":"This API is used to query capacity range that a disk can be expanded to.ConstraintsDisk capacity expansion can be performed only for cloud data warehouses using SSD or hy",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Disk Capacity Expansion Range",
|
|
"uri":"ShowClusterStorageExpandRange.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"40"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the list of flavors that a cluster can be changed to. A maximum of 20 flavors can be returned.ConstraintsIf cluster_id is not specified, all fla",
|
|
"product_code":"DWS",
|
|
"title":"Querying the List of Target Flavors That a Cluster Can Be Changed To",
|
|
"uri":"ListTargetFlavors.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"41"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the CN node list of a cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/cnsNoneStatus code: 200Query CN node li",
|
|
"product_code":"DWS",
|
|
"title":"Querying CN Nodes of a Cluster",
|
|
"uri":"ListClusterCn.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"42"
|
|
},
|
|
{
|
|
"desc":"After a cluster is created, the number of required CN nodes varies with workloads. You can add or delete CN nodes as needed.Other O&M operations cannot be performed durin",
|
|
"product_code":"DWS",
|
|
"title":"Adding CN Nodes in Batches",
|
|
"uri":"BatchCreateClusterCn.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"43"
|
|
},
|
|
{
|
|
"desc":"After a cluster is created, the number of required CN nodes varies with workloads. You can add or delete CN nodes as needed.Other O&M operations cannot be performed durin",
|
|
"product_code":"DWS",
|
|
"title":"Deleting CN Nodes in Batches",
|
|
"uri":"BatchDeleteClusterCn.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"44"
|
|
},
|
|
{
|
|
"desc":"This API is used to scale out a cluster or add idle nodes. By default, scale-out is performed.You can configure create_node_only to determine whether the current operatio",
|
|
"product_code":"DWS",
|
|
"title":"Scaling Out a Cluster",
|
|
"uri":"ResizeCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"45"
|
|
},
|
|
{
|
|
"desc":"This API is used to conduct a precheck for cluster scale-out to identify failures caused by insufficient subnets or permissions.For details, see Calling APIs.POST /v2/{pr",
|
|
"product_code":"DWS",
|
|
"title":"Performing a Scale-Out Check",
|
|
"uri":"CheckGrowCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"46"
|
|
},
|
|
{
|
|
"desc":"This API is used to scale out a cluster with idle nodes.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/resize-with-existed-nodesStatus code: 20",
|
|
"product_code":"DWS",
|
|
"title":"Scaling Out a Cluster with Idle Nodes",
|
|
"uri":"ResizeClusterWithExistedNodes.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"47"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the node list.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/nodesNoneStatus code: 200Query the node list.GET https://",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Node List",
|
|
"uri":"ListClusterNodes.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"48"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete idle nodes.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/nodes/deleteStatus code: 202Delete idle nodes.Status code:",
|
|
"product_code":"DWS",
|
|
"title":"Deleting Idle Nodes",
|
|
"uri":"DeleteClusterNodes.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"49"
|
|
},
|
|
{
|
|
"desc":"This API is used to evenly distribute data from old nodes to new nodes after cluster scale-out. After data redistribution, the service response speed is greatly improved.",
|
|
"product_code":"DWS",
|
|
"title":"Performing a Redistribution Task",
|
|
"uri":"ExecuteRedistributionCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"50"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the monitoring information about a cluster, such as the redistribution mode, redistribution progress, and redistribution details.The redistribut",
|
|
"product_code":"DWS",
|
|
"title":"Querying Redistribution Details",
|
|
"uri":"ShowClusterRedistribution.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"51"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify redistribution configurations.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/redistribution/configurationsStatus code",
|
|
"product_code":"DWS",
|
|
"title":"Modifying Redistribution Configurations",
|
|
"uri":"UpdateRedistributionConfigurations.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"52"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the priority of a redistribution table.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/redistribution/priorityStatus c",
|
|
"product_code":"DWS",
|
|
"title":"Changing the Priority of a Redistribution Table",
|
|
"uri":"SetRedistributionPriority.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"53"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the schema information of the table to be redistributed.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/redistribution/",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Schema Information of the Table to Be Redistributed",
|
|
"uri":"ListRedistributionSchema.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"54"
|
|
},
|
|
{
|
|
"desc":"This API is used to suspend redistribution. After suspension, you can set the redistribution priority and change the number of concurrent redistribution tasks.This functi",
|
|
"product_code":"DWS",
|
|
"title":"Suspending Redistribution",
|
|
"uri":"StopRedistribution.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"55"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the number of nodes to be removed from a cluster for better performance.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_i",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Number of Nodes to Be Removed from a Cluster for Better Performance",
|
|
"uri":"ListClusterScaleInNumbers.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"56"
|
|
},
|
|
{
|
|
"desc":"This API is used to resume redistribution in the suspended state. It is available only for DWS 2.0.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_i",
|
|
"product_code":"DWS",
|
|
"title":"Resuming Redistribution",
|
|
"uri":"RestoreRedistribution.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"57"
|
|
},
|
|
{
|
|
"desc":"This API is used to perform a re-scale-in check. It can ensure that the requirements are met before and after the scale-in.For details, see Calling APIs.GET /v1/{project_",
|
|
"product_code":"DWS",
|
|
"title":"Performing a Scale-in Check",
|
|
"uri":"CheckClusterShrink.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"58"
|
|
},
|
|
{
|
|
"desc":"This API is used to scale in a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/cluster-shrinkStatus code: 200Scale in three nodes in t",
|
|
"product_code":"DWS",
|
|
"title":"Scaling In a Cluster",
|
|
"uri":"ShrinkCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"59"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Logical Cluster Management",
|
|
"uri":"dws_02_0605.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"60"
|
|
},
|
|
{
|
|
"desc":"This API is used to convert a physical cluster to a logical cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/convert-to-logical-cluster/{",
|
|
"product_code":"DWS",
|
|
"title":"Converting a Physical Cluster to a Logical Cluster",
|
|
"uri":"ConvertToLogicalCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"61"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a logical cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/logical-clustersStatus code: 200Create a logical cl",
|
|
"product_code":"DWS",
|
|
"title":"Creating a Logical Cluster",
|
|
"uri":"CreateLogicalCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"62"
|
|
},
|
|
{
|
|
"desc":"This API is used to scale in a logical cluster in an elastic pool.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_clus",
|
|
"product_code":"DWS",
|
|
"title":"Scaling In a Logical Cluster",
|
|
"uri":"ShrinkLogicalCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"63"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the disk information of a logical cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters/volumesNoneS",
|
|
"product_code":"DWS",
|
|
"title":"Querying Disk Information of a Logical Cluster",
|
|
"uri":"ListLogicalClusterVolumes.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"64"
|
|
},
|
|
{
|
|
"desc":"This API is used to query task information about a logical cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters/tasksNoneStat",
|
|
"product_code":"DWS",
|
|
"title":"Querying Task Information About a Logical Cluster",
|
|
"uri":"ListLogicalClusterTasks.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"65"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the logical cluster list.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clustersNoneStatus code: 200Query the ",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Logical Cluster List",
|
|
"uri":"ListLogicalClusters.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"66"
|
|
},
|
|
{
|
|
"desc":"This API is used to query information about available ring nodes in a logical cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clu",
|
|
"product_code":"DWS",
|
|
"title":"Querying Information About Available Ring Nodes in a Logical Cluster",
|
|
"uri":"ListLogicalClusterRings.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"67"
|
|
},
|
|
{
|
|
"desc":"This API is used to restart a logical cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}/restartNoneS",
|
|
"product_code":"DWS",
|
|
"title":"Restarting a Logical Cluster",
|
|
"uri":"RestartLogicalCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"68"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a logical cluster.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}NoneStatus c",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a Logical Cluster",
|
|
"uri":"DeleteLogicalCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"69"
|
|
},
|
|
{
|
|
"desc":"This API is used to edit a logical cluster. The API determines whether to scale out or scale in a logical cluster based on the submitted request body.Scenario 1: The orig",
|
|
"product_code":"DWS",
|
|
"title":"Editing a Logical Cluster",
|
|
"uri":"UpdateLogicalCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"70"
|
|
},
|
|
{
|
|
"desc":"This API is used to control whether the function modules related to a logical cluster are displayed on the page.If the cluster is already a logical cluster, this API has ",
|
|
"product_code":"DWS",
|
|
"title":"Switching to a Logical Cluster",
|
|
"uri":"EnableLogicalCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"71"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Resource Management",
|
|
"uri":"dws_02_0538.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"72"
|
|
},
|
|
{
|
|
"desc":"This API is used to query whether resource management is enabled.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workloadNoneStatus code: 200Quer",
|
|
"product_code":"DWS",
|
|
"title":"Querying Whether Resource Management Is Enabled",
|
|
"uri":"ListClusterWorkload.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"73"
|
|
},
|
|
{
|
|
"desc":"This API is used to query all resource management plans in a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plansNoneStatus cod",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Resource Management Plan List",
|
|
"uri":"ListWorkloadPlans.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"74"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plansStatus code: 200Create the r",
|
|
"product_code":"DWS",
|
|
"title":"Creating a Resource Management Plan",
|
|
"uri":"CreateWorkloadPlan.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"75"
|
|
},
|
|
{
|
|
"desc":"This API is used to query resource pools.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/queuesNoneStatus code: 200Query resource pools.",
|
|
"product_code":"DWS",
|
|
"title":"Querying Resource Pools",
|
|
"uri":"ListWorkloadQueue.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"76"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a resource pool.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/workload/queuesStatus code: 200Create a resource pool ",
|
|
"product_code":"DWS",
|
|
"title":"Creating a Resource Pool",
|
|
"uri":"AddWorkloadQueue.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"77"
|
|
},
|
|
{
|
|
"desc":"This API is used to stop a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stopNoneStatus code",
|
|
"product_code":"DWS",
|
|
"title":"Stopping a Resource Management Plan",
|
|
"uri":"StopWorkloadPlan.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"78"
|
|
},
|
|
{
|
|
"desc":"This API is used to query details about a resource management plan.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}NoneSt",
|
|
"product_code":"DWS",
|
|
"title":"Querying Details About a Resource Management Plan",
|
|
"uri":"ShowWorkloadPlan.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"79"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a resource management plan.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}NoneStatus code:",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a Resource Management Plan",
|
|
"uri":"DeleteWorkloadPlan.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"80"
|
|
},
|
|
{
|
|
"desc":"This API is used start a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/startNoneStatus code:",
|
|
"product_code":"DWS",
|
|
"title":"Starting a Resource Management Plan",
|
|
"uri":"StartWorkloadPlan.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"81"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the list of users bound to a resource pool.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}",
|
|
"product_code":"DWS",
|
|
"title":"Querying the List of Users Bound to a Resource Pool",
|
|
"uri":"ListWorkloadQueueUsers.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"82"
|
|
},
|
|
{
|
|
"desc":"This API is used to query details about a resource pool.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}NoneStatus co",
|
|
"product_code":"DWS",
|
|
"title":"Querying Resource Pool Details",
|
|
"uri":"ShowWorkloadQueue.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"83"
|
|
},
|
|
{
|
|
"desc":"This API is used to query details stage details of resource management plan.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_",
|
|
"product_code":"DWS",
|
|
"title":"Querying Stage Details About a Resource Management Plan",
|
|
"uri":"ShowWorkloadPlanStage.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"84"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a stage of a resource management plan.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stag",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a Stage of Resource Management Plan",
|
|
"uri":"DeleteWorkloadPlanStage.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"85"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify a stage of a resource management plan.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stages/",
|
|
"product_code":"DWS",
|
|
"title":"Modifying a Stage of a Resource Management Plan",
|
|
"uri":"UpdateWorkloadPlanStage.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"86"
|
|
},
|
|
{
|
|
"desc":"This API is used to query plan execution logs.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/logsNoneStatus code: 200St",
|
|
"product_code":"DWS",
|
|
"title":"Querying Plan Execution Logs",
|
|
"uri":"ListPlanExecLogs.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"87"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a user bound to a resource pool.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/users/ba",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a User Bound to a Resource Pool",
|
|
"uri":"DeleteQueueUserList.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"88"
|
|
},
|
|
{
|
|
"desc":"This API is used to switch the stage of a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stag",
|
|
"product_code":"DWS",
|
|
"title":"Switching the Stage of a Resource Management Plan",
|
|
"uri":"SwitchPlanStage.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"89"
|
|
},
|
|
{
|
|
"desc":"This API is used to associate a user to a resource pool.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/users/batch",
|
|
"product_code":"DWS",
|
|
"title":"Associating a User to a Resource Pool",
|
|
"uri":"AddQueueUserList.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"90"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the resource configurations of a resource pool.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_",
|
|
"product_code":"DWS",
|
|
"title":"Modifying Resource Configurations of a Resource Pool",
|
|
"uri":"UpdateQueueResources.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"91"
|
|
},
|
|
{
|
|
"desc":"This API is used to query schema space information of a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/databases/{database_name}/schemas",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Schema Space Information of a Cluster",
|
|
"uri":"ListSchemas.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"92"
|
|
},
|
|
{
|
|
"desc":"This API is used to edit the space limit of a schema.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/databases/{database_name}/schemasStatus code",
|
|
"product_code":"DWS",
|
|
"title":"Editing the Space Limit of a Schema",
|
|
"uri":"UpdateSchemas.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"93"
|
|
},
|
|
{
|
|
"desc":"This API is used to add a resource management plan stage.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stagesStatus c",
|
|
"product_code":"DWS",
|
|
"title":"Adding a Stage for a Resource Management Plan",
|
|
"uri":"AddWorkloadPlanStage.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"94"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a resource pool.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/workload/queuesNoneStatus code: 200Status code: 200",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a Resource Pool",
|
|
"uri":"DeleteWorkloadQueue.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"95"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the exception rule list of a cluster.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/workload/rulesNoneStatus code: 200",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Exception Rule List of a Cluster",
|
|
"uri":"ListWorkloadRules.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"96"
|
|
},
|
|
{
|
|
"desc":"This API is used to add an exception rule.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/workload/rulesStatus code: 200Create an exception rule",
|
|
"product_code":"DWS",
|
|
"title":"Adding an Exception Rule",
|
|
"uri":"AddWorkloadRule.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"97"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete an exception rule.For details, see Calling APIs.DELETE /v1/{project_id}/clusters/{cluster_id}/workload/rules/{rule_name}NoneStatus code: 200Del",
|
|
"product_code":"DWS",
|
|
"title":"Deleting an Exception Rule",
|
|
"uri":"DeleteWorkloadRule.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"98"
|
|
},
|
|
{
|
|
"desc":"This API is used to edit an exception rule.For details, see Calling APIs.PUT /v1/{project_id}/clusters/{cluster_id}/workload/rules/{rule_name}Status code: 200Edit an exce",
|
|
"product_code":"DWS",
|
|
"title":"Editing an Exception Rule",
|
|
"uri":"UpdateWorkloadRule.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"99"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable or disable resource management. The function is enabled by default for new clusters.For details, see Calling APIs.POST /v2/{project_id}/cluster",
|
|
"product_code":"DWS",
|
|
"title":"Enabling or Disabling Resource Management",
|
|
"uri":"CreateClusterWorkload.html",
|
|
"doc_type":"api",
|
|
"p_code":"72",
|
|
"code":"100"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Snapshot Management",
|
|
"uri":"dws_02_0023.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"101"
|
|
},
|
|
{
|
|
"desc":"This API is used to query snapshot statistics.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots/statisticsNoneStatus code: 200Status co",
|
|
"product_code":"DWS",
|
|
"title":"Querying Snapshot Statistics",
|
|
"uri":"ListSnapshotStatistics.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"102"
|
|
},
|
|
{
|
|
"desc":"This API is used to check the name of the table to be restored.For details, see Calling APIs.POST /v1/{project_id}/snapshots/{snapshot_id}/table-restore-checkStatus code:",
|
|
"product_code":"DWS",
|
|
"title":"Checking the Name of the Table to Be Restored",
|
|
"uri":"CheckTableRestore.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"103"
|
|
},
|
|
{
|
|
"desc":"This API is used to restore tables.For details, see Calling APIs.POST /v1/{project_id}/snapshots/{snapshot_id}/table-restoreStatus code: 200Status code: 200The table is s",
|
|
"product_code":"DWS",
|
|
"title":"Restoring a Table",
|
|
"uri":"RestoreTable.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"104"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a snapshot for a specified cluster.For details, see Calling APIs.POST /v1.0/{project_id}/snapshotsStatus code: 200Create a manual snapshot name",
|
|
"product_code":"DWS",
|
|
"title":"Creating a Snapshot",
|
|
"uri":"CreateSnapshot.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"105"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the snapshot list.For details, see Calling APIs.GET /v1.0/{project_id}/snapshotsNoneStatus code: 200Status code: 200Snapshot list queried.",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Snapshot List",
|
|
"uri":"ListSnapshots.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"106"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the cluster snapshot list.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/snapshotsNoneStatus code: 200Status code: 2",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Cluster Snapshot List",
|
|
"uri":"ListClusterSnapshots.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"107"
|
|
},
|
|
{
|
|
"desc":"This API is used to query a snapshot policy.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/snapshot-policiesNoneStatus code: 200Status code: 200",
|
|
"product_code":"DWS",
|
|
"title":"Querying a Snapshot Policy",
|
|
"uri":"ListSnapshotPolicy.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"108"
|
|
},
|
|
{
|
|
"desc":"This API is used to query snapshot details using the snapshot ID.For details, see Calling APIs.GET /v1.0/{project_id}/snapshots/{snapshot_id}NoneStatus code: 200Status co",
|
|
"product_code":"DWS",
|
|
"title":"Querying Snapshot Details",
|
|
"uri":"ListSnapshotDetails.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"109"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a snapshot policy.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/snapshot-policies/{id}NoneStatus code: 200The s",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a Snapshot Policy",
|
|
"uri":"DeleteSnapshotPolicy.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"110"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a manual snapshot.For details, see Calling APIs.DELETE /v1.0/{project_id}/snapshots/{snapshot_id}NoneStatus code: 202The snapshot is deleted.No",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a Snapshot",
|
|
"uri":"DeleteSnapshot.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"111"
|
|
},
|
|
{
|
|
"desc":"This API is used to restore a cluster using a snapshot.For details, see Calling APIs.POST /v1.0/{project_id}/snapshots/{snapshot_id}/actionsStatus code: 200Restore the sn",
|
|
"product_code":"DWS",
|
|
"title":"Restoring a Cluster",
|
|
"uri":"RestoreCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"112"
|
|
},
|
|
{
|
|
"desc":"This API is used to query flavors based on the snapshot ID. You can query the flavor of a snapshot or the flavor to which a snapshot can be restored.For details, see Call",
|
|
"product_code":"DWS",
|
|
"title":"Querying Flavors by Snapshot ID",
|
|
"uri":"ListSnapshotFlavorInfo.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"113"
|
|
},
|
|
{
|
|
"desc":"This API is used to copy an automated snapshot.For details, see Calling APIs.POST /v1.0/{project_id}/snapshots/{snapshot_id}/linked-copyStatus code: 200Copy an automated ",
|
|
"product_code":"DWS",
|
|
"title":"Copying a Snapshot",
|
|
"uri":"CopySnapshot.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"114"
|
|
},
|
|
{
|
|
"desc":"This API is used to configure a snapshot policy.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/snapshot-policiesStatus code: 200Request succeede",
|
|
"product_code":"DWS",
|
|
"title":"Adding a Snapshot Policy",
|
|
"uri":"CreateSnapshotPolicy.html",
|
|
"doc_type":"api",
|
|
"p_code":"101",
|
|
"code":"115"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Connection Management",
|
|
"uri":"dws_02_0554.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"116"
|
|
},
|
|
{
|
|
"desc":"This API is used to query connection information, including public and private domain names.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/endpo",
|
|
"product_code":"DWS",
|
|
"title":"Querying Connection Information",
|
|
"uri":"ListClusterEndpoints.html",
|
|
"doc_type":"api",
|
|
"p_code":"116",
|
|
"code":"117"
|
|
},
|
|
{
|
|
"desc":"This API is used to apply for a domain name for a specified cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/dnsStatus code: 200The dom",
|
|
"product_code":"DWS",
|
|
"title":"Applying for a Domain Name",
|
|
"uri":"CreateClusterDns.html",
|
|
"doc_type":"api",
|
|
"p_code":"116",
|
|
"code":"118"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the domain name of a specified cluster.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/dnsStatus code: 200The cluste",
|
|
"product_code":"DWS",
|
|
"title":"Modifying a Cluster Domain Name",
|
|
"uri":"UpdateClusterDns.html",
|
|
"doc_type":"api",
|
|
"p_code":"116",
|
|
"code":"119"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete the domain name of a specified cluster.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/dnsNoneStatus code: 200The",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a Cluster Domain Name",
|
|
"uri":"DeleteClusterDns.html",
|
|
"doc_type":"api",
|
|
"p_code":"116",
|
|
"code":"120"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the list of ELBs that can be bound to a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/elbsNoneStatus code: 20",
|
|
"product_code":"DWS",
|
|
"title":"Querying the List of ELBs That Can Be Bound to a Cluster",
|
|
"uri":"ListElbs.html",
|
|
"doc_type":"api",
|
|
"p_code":"116",
|
|
"code":"121"
|
|
},
|
|
{
|
|
"desc":"This API is used to bind an ELB to a cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/elbs/{elb_id}NoneStatus code: 200Status code: 200Re",
|
|
"product_code":"DWS",
|
|
"title":"Binding an ELB to a Cluster",
|
|
"uri":"AssociateElb.html",
|
|
"doc_type":"api",
|
|
"p_code":"116",
|
|
"code":"122"
|
|
},
|
|
{
|
|
"desc":"This API is used to unbind an ELB from a cluster.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/elbs/{elb_id}NoneStatus code: 200Status code:",
|
|
"product_code":"DWS",
|
|
"title":"Unbinding an ELB from a Cluster",
|
|
"uri":"DisassociateElb.html",
|
|
"doc_type":"api",
|
|
"p_code":"116",
|
|
"code":"123"
|
|
},
|
|
{
|
|
"desc":"This API is used to bind an EIP to a cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/eips/{eip_id}NoneStatus code: 200The EIP is bound t",
|
|
"product_code":"DWS",
|
|
"title":"Binding an EIP to a Cluster",
|
|
"uri":"AssociateEip.html",
|
|
"doc_type":"api",
|
|
"p_code":"116",
|
|
"code":"124"
|
|
},
|
|
{
|
|
"desc":"This API is used to unbind an EIP from a cluster.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/eips/{eip_id}NoneStatus code: 200The EIP is u",
|
|
"product_code":"DWS",
|
|
"title":"Unbinding an EIP from a Cluster",
|
|
"uri":"DisassociateEip.html",
|
|
"doc_type":"api",
|
|
"p_code":"116",
|
|
"code":"125"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Alarm Management",
|
|
"uri":"dws_02_0544.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"126"
|
|
},
|
|
{
|
|
"desc":"This API is used to query alarm configurations.For details, see Calling APIs.GET /v2/{project_id}/alarm-configsNoneStatus code: 200Status code: 200Alarm configurations qu",
|
|
"product_code":"DWS",
|
|
"title":"Querying Alarm Configurations",
|
|
"uri":"ListAlarmConfigs.html",
|
|
"doc_type":"api",
|
|
"p_code":"126",
|
|
"code":"127"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the alarm details list.For details, see Calling APIs.GET /v2/{project_id}/alarmsNoneStatus code: 200Status code: 200Alarm details list queried.",
|
|
"product_code":"DWS",
|
|
"title":"Querying Alarm Details List",
|
|
"uri":"ListAlarmDetail.html",
|
|
"doc_type":"api",
|
|
"p_code":"126",
|
|
"code":"128"
|
|
},
|
|
{
|
|
"desc":"This API is used to query alarm statistics.For details, see Calling APIs.GET /v2/{project_id}/alarm-statisticNoneStatus code: 200Status code: 200Alarm statistics list que",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Alarm Statistics List",
|
|
"uri":"ListAlarmStatistic.html",
|
|
"doc_type":"api",
|
|
"p_code":"126",
|
|
"code":"129"
|
|
},
|
|
{
|
|
"desc":"This API is used to query subscribed alarms.For details, see Calling APIs.GET /v2/{project_id}/alarm-subsNoneStatus code: 200Status code: 200Alarm subscription list queri",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Alarm Subscription List",
|
|
"uri":"ListAlarmSubs.html",
|
|
"doc_type":"api",
|
|
"p_code":"126",
|
|
"code":"130"
|
|
},
|
|
{
|
|
"desc":"This API is used to create an alarm subscription.For details, see Calling APIs.POST /v2/{project_id}/alarm-subsStatus code: 200Create an alarm subscription (Subscription ",
|
|
"product_code":"DWS",
|
|
"title":"Creating an Alarm Subscription",
|
|
"uri":"CreateAlarmSub.html",
|
|
"doc_type":"api",
|
|
"p_code":"126",
|
|
"code":"131"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify an alarm subscription.For details, see Calling APIs.PUT /v2/{project_id}/alarm-subs/{alarm_sub_id}Status code: 200Modify the zrf-test-13 alarm ",
|
|
"product_code":"DWS",
|
|
"title":"Modifying an Alarm Subscription",
|
|
"uri":"UpdateAlarmSub.html",
|
|
"doc_type":"api",
|
|
"p_code":"126",
|
|
"code":"132"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete an alarm subscription.For details, see Calling APIs.DELETE /v2/{project_id}/alarm-subs/{alarm_sub_id}NoneStatus code: 200Status code: 200Alarm ",
|
|
"product_code":"DWS",
|
|
"title":"Deleting an Alarm Subscription",
|
|
"uri":"DeleteAlarmSub.html",
|
|
"doc_type":"api",
|
|
"p_code":"126",
|
|
"code":"133"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Event Management",
|
|
"uri":"dws_02_0525.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"134"
|
|
},
|
|
{
|
|
"desc":"This API is used to query event list.For details, see Calling APIs.GET /v2/{project_id}/eventsNoneStatus code: 200Status code: 200Event list of the cluster queried.",
|
|
"product_code":"DWS",
|
|
"title":"Querying Event List",
|
|
"uri":"ListEvents.html",
|
|
"doc_type":"api",
|
|
"p_code":"134",
|
|
"code":"135"
|
|
},
|
|
{
|
|
"desc":"This API is used to query event configurations.For details, see Calling APIs.GET /v2/{project_id}/event-specsNoneStatus code: 200Status code: 200Event configurations of a",
|
|
"product_code":"DWS",
|
|
"title":"Querying Event Configurations",
|
|
"uri":"ListEventSpecs.html",
|
|
"doc_type":"api",
|
|
"p_code":"134",
|
|
"code":"136"
|
|
},
|
|
{
|
|
"desc":"This API is used to query subscribed events.For details, see Calling APIs.GET /v2/{project_id}/event-subsNoneStatus code: 200Status code: 200Subscribed events queried.",
|
|
"product_code":"DWS",
|
|
"title":"Querying Subscribed Events",
|
|
"uri":"ListEventSubs.html",
|
|
"doc_type":"api",
|
|
"p_code":"134",
|
|
"code":"137"
|
|
},
|
|
{
|
|
"desc":"This API is used to create an event subscription.For details, see Calling APIs.POST /v2/{project_id}/event-subsStatus code: 200Create a subscription (Subscription name zr",
|
|
"product_code":"DWS",
|
|
"title":"Creating an Event Subscription",
|
|
"uri":"CreateEventSub.html",
|
|
"doc_type":"api",
|
|
"p_code":"134",
|
|
"code":"138"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify a subscribed event.For details, see Calling APIs.PUT /v2/{project_id}/event-subs/{event_sub_id}Status code: 200Modify the zrf-test-66 event sub",
|
|
"product_code":"DWS",
|
|
"title":"Modifying a Subscribed Event",
|
|
"uri":"UpdateEventSub.html",
|
|
"doc_type":"api",
|
|
"p_code":"134",
|
|
"code":"139"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a subscribed event.For details, see Calling APIs.DELETE /v2/{project_id}/event-subs/{event_sub_id}NoneStatus code: 200Status code: 200Event sub",
|
|
"product_code":"DWS",
|
|
"title":"Deleting a Subscribed Event",
|
|
"uri":"DeleteEventSub.html",
|
|
"doc_type":"api",
|
|
"p_code":"134",
|
|
"code":"140"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Task Management",
|
|
"uri":"dws_02_0604.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"141"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the task progress.For details, see Calling APIs.GET /v1.0/{project_id}/job/{job_id}NoneStatus code: 200Status code: 200Task progress queried.",
|
|
"product_code":"DWS",
|
|
"title":"Querying the Task Progress",
|
|
"uri":"ListJobDetails.html",
|
|
"doc_type":"api",
|
|
"p_code":"141",
|
|
"code":"142"
|
|
},
|
|
{
|
|
"desc":"This API is used to query cluster task details.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/actions/{action_name}NoneStatus code: 200Query det",
|
|
"product_code":"DWS",
|
|
"title":"Querying Cluster Task Details",
|
|
"uri":"ListClusterActions.html",
|
|
"doc_type":"api",
|
|
"p_code":"141",
|
|
"code":"143"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Tag Management",
|
|
"uri":"dws_02_0563.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"144"
|
|
},
|
|
{
|
|
"desc":"This API is used to query project tag list.For details, see Calling APIs.GET /v1.0/{project_id}/tagsNoneStatus code: 200Status code: 200Project tags queried.",
|
|
"product_code":"DWS",
|
|
"title":"Querying Project Tags",
|
|
"uri":"ListTags.html",
|
|
"doc_type":"api",
|
|
"p_code":"144",
|
|
"code":"145"
|
|
},
|
|
{
|
|
"desc":"This API is used to query tag information of a cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/tagsNoneStatus code: 200Status code: 200",
|
|
"product_code":"DWS",
|
|
"title":"Querying Cluster Tags",
|
|
"uri":"ListClusterTags.html",
|
|
"doc_type":"api",
|
|
"p_code":"144",
|
|
"code":"146"
|
|
},
|
|
{
|
|
"desc":"This API is used to batch add tags to a specified cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-createStatus code: 200Tag",
|
|
"product_code":"DWS",
|
|
"title":"Adding Tags in Batches",
|
|
"uri":"BatchCreateResourceTag.html",
|
|
"doc_type":"api",
|
|
"p_code":"144",
|
|
"code":"147"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete tags from a specified cluster in batches.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-deleteStatus co",
|
|
"product_code":"DWS",
|
|
"title":"Delete Tags in Batches",
|
|
"uri":"BatchDeleteResourceTag.html",
|
|
"doc_type":"api",
|
|
"p_code":"144",
|
|
"code":"148"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Audit Logs",
|
|
"uri":"dws_02_0536.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"149"
|
|
},
|
|
{
|
|
"desc":"This API is used to query audit logs.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/audit-log-recordsNoneStatus code: 200Status code: 200Query",
|
|
"product_code":"DWS",
|
|
"title":"Querying Log Records",
|
|
"uri":"ListAuditLog.html",
|
|
"doc_type":"api",
|
|
"p_code":"149",
|
|
"code":"150"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"DWS",
|
|
"title":"Log Management",
|
|
"uri":"dws_02_0799.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"151"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the LTS log list.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/lts-logsNoneStatus code: 200Status code: 200LTS log li",
|
|
"product_code":"DWS",
|
|
"title":"Obtaining the LTS Log List",
|
|
"uri":"ListLtsLogs.html",
|
|
"doc_type":"api",
|
|
"p_code":"151",
|
|
"code":"152"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable LTS for a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/lts-logs/disableNoneStatus code: 200LTS disabled.N",
|
|
"product_code":"DWS",
|
|
"title":"Disabling LTS",
|
|
"uri":"DisableLtsLogs.html",
|
|
"doc_type":"api",
|
|
"p_code":"151",
|
|
"code":"153"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable LTS for a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/lts-logs/enableNoneStatus code: 200LTS enabled.None",
|
|
"product_code":"DWS",
|
|
"title":"Enabling LTS",
|
|
"uri":"EnableLtsLogs.html",
|
|
"doc_type":"api",
|
|
"p_code":"151",
|
|
"code":"154"
|
|
},
|
|
{
|
|
"desc":"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",
|
|
"product_code":"dws",
|
|
"title":"Permissions and Supported Actions",
|
|
"uri":"dws_02_0061.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"155"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dws",
|
|
"title":"Appendix",
|
|
"uri":"dws_02_0066.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"156"
|
|
},
|
|
{
|
|
"desc":"Table 1 describes the status code.",
|
|
"product_code":"dws",
|
|
"title":"Status Code",
|
|
"uri":"dws_02_0038.html",
|
|
"doc_type":"api",
|
|
"p_code":"156",
|
|
"code":"157"
|
|
},
|
|
{
|
|
"desc":"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 ",
|
|
"product_code":"dws",
|
|
"title":"Error Code",
|
|
"uri":"dws_02_0030.html",
|
|
"doc_type":"api",
|
|
"p_code":"156",
|
|
"code":"158"
|
|
},
|
|
{
|
|
"desc":"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 ",
|
|
"product_code":"dws",
|
|
"title":"Creating a VPC",
|
|
"uri":"dws_02_0040.html",
|
|
"doc_type":"api",
|
|
"p_code":"156",
|
|
"code":"159"
|
|
},
|
|
{
|
|
"desc":"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://",
|
|
"product_code":"dws",
|
|
"title":"Obtaining Project ID",
|
|
"uri":"dws_02_0011.html",
|
|
"doc_type":"api",
|
|
"p_code":"156",
|
|
"code":"160"
|
|
},
|
|
{
|
|
"desc":"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 th",
|
|
"product_code":"dws",
|
|
"title":"Obtaining an Account ID",
|
|
"uri":"dws_02_0067.html",
|
|
"doc_type":"api",
|
|
"p_code":"156",
|
|
"code":"161"
|
|
},
|
|
{
|
|
"desc":"A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain the cluster ID, perform the following steps:You can obtain the cluster ID by calling ",
|
|
"product_code":"dws",
|
|
"title":"Obtaining the Cluster ID",
|
|
"uri":"dws_02_00068.html",
|
|
"doc_type":"api",
|
|
"p_code":"156",
|
|
"code":"162"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dws",
|
|
"title":"Change History",
|
|
"uri":"dws_02_0031.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"163"
|
|
}
|
|
] |