vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/api-ref/CLASS.TXT.json
Lu, Huayi 24f47208ec DWS API 831.100 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2024-10-07 10:18:56 +00:00

398 lines
13 KiB
JSON
Raw Blame History

[
{
"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":"Before You Start",
"uri":"dws_02_0057.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"desc":"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 ",
"product_code":"dws",
"title":"Overview",
"uri":"dws_02_0033.html",
"doc_type":"api",
"p_code":"1",
"code":"2"
},
{
"desc":"GaussDB(DWS) supports representational state transfer (REST) APIs, allowing you to call APIs using HTTPS. For details, see Calling APIs.",
"product_code":"dws",
"title":"API Calling",
"uri":"dws_02_0058.html",
"doc_type":"api",
"p_code":"1",
"code":"3"
},
{
"desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see the Regions and Endpoints ",
"product_code":"dws",
"title":"Endpoints",
"uri":"dws_02_0059.html",
"doc_type":"api",
"p_code":"1",
"code":"4"
},
{
"desc":"AccountThis account has full access to all cloud services and resources associated with it. It can be used to reset user passwords and grant user permissions. The domain ",
"product_code":"dws",
"title":"Basic Concepts",
"uri":"dws_02_0061.html",
"doc_type":"api",
"p_code":"1",
"code":"5"
},
{
"desc":"You can use the following GaussDB(DWS) functions with the APIs.",
"product_code":"dws",
"title":"API Overview",
"uri":"dws_02_0034.html",
"doc_type":"api",
"p_code":"",
"code":"6"
},
{
"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":"7"
},
{
"desc":"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 ",
"product_code":"dws",
"title":"Making an API Request",
"uri":"dws_02_0063.html",
"doc_type":"api",
"p_code":"7",
"code":"8"
},
{
"desc":"Calling an API can be authenticated using tokens.A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added",
"product_code":"dws",
"title":"Authentication",
"uri":"dws_02_0064.html",
"doc_type":"api",
"p_code":"7",
"code":"9"
},
{
"desc":"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 ",
"product_code":"dws",
"title":"Response",
"uri":"dws_02_0065.html",
"doc_type":"api",
"p_code":"7",
"code":"10"
},
{
"desc":"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 th",
"product_code":"dws",
"title":"Getting Started",
"uri":"dws_02_0036.html",
"doc_type":"api",
"p_code":"",
"code":"11"
},
{
"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":"12"
},
{
"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":"Managing Clusters",
"uri":"dws_02_0017.html",
"doc_type":"api",
"p_code":"12",
"code":"13"
},
{
"desc":"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 as",
"product_code":"dws",
"title":"Creating a Cluster",
"uri":"dws_02_0020.html",
"doc_type":"api",
"p_code":"13",
"code":"14"
},
{
"desc":"This API is used to query and display the cluster list.None",
"product_code":"dws",
"title":"Querying the Cluster List",
"uri":"dws_02_0018.html",
"doc_type":"api",
"p_code":"13",
"code":"15"
},
{
"desc":"This API is used to query cluster details.None",
"product_code":"dws",
"title":"Querying Cluster Details",
"uri":"dws_02_0019.html",
"doc_type":"api",
"p_code":"13",
"code":"16"
},
{
"desc":"This API is used to query the node types supported by GaussDB(DWS).None",
"product_code":"dws",
"title":"Querying the Supported Node Types",
"uri":"dws_02_0022.html",
"doc_type":"api",
"p_code":"13",
"code":"17"
},
{
"desc":"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",
"product_code":"dws",
"title":"Deleting a Cluster",
"uri":"dws_02_0021.html",
"doc_type":"api",
"p_code":"13",
"code":"18"
},
{
"desc":"This API is used to restart clusters.NoneNone",
"product_code":"dws",
"title":"Restarting a Cluster",
"uri":"dws_02_0052.html",
"doc_type":"api",
"p_code":"13",
"code":"19"
},
{
"desc":"This API is used to scale out a cluster.NoneAn example of the scale_out API is as follows:POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-",
"product_code":"dws",
"title":"Scaling Out a Cluster",
"uri":"dws_02_0053.html",
"doc_type":"api",
"p_code":"13",
"code":"20"
},
{
"desc":"This API is used to reset the password of cluster administrator.None",
"product_code":"dws",
"title":"Resetting a Password",
"uri":"dws_02_0054.html",
"doc_type":"api",
"p_code":"13",
"code":"21"
},
{
"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 APIs",
"uri":"dws_02_0023.html",
"doc_type":"api",
"p_code":"12",
"code":"22"
},
{
"desc":"This API is used to create snapshots for a specified cluster.",
"product_code":"dws",
"title":"Creating a Snapshot",
"uri":"dws_02_0026.html",
"doc_type":"api",
"p_code":"22",
"code":"23"
},
{
"desc":"This API is used to query the snapshot list.None",
"product_code":"dws",
"title":"Querying the Snapshot List",
"uri":"dws_02_0024.html",
"doc_type":"api",
"p_code":"22",
"code":"24"
},
{
"desc":"This API is used to query snapshot details by using the snapshot ID.None",
"product_code":"dws",
"title":"Querying Snapshot Details",
"uri":"dws_02_0025.html",
"doc_type":"api",
"p_code":"22",
"code":"25"
},
{
"desc":"This API is used to delete a specified manual snapshot.NoneNoneNone",
"product_code":"dws",
"title":"Deleting a Manual Snapshot",
"uri":"dws_02_0027.html",
"doc_type":"api",
"p_code":"22",
"code":"26"
},
{
"desc":"This API is used to restore clusters using the snapshot.",
"product_code":"dws",
"title":"Restoring a Cluster",
"uri":"dws_02_0032.html",
"doc_type":"api",
"p_code":"22",
"code":"27"
},
{
"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 APIs",
"uri":"dws_02_0045.html",
"doc_type":"api",
"p_code":"12",
"code":"28"
},
{
"desc":"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 multip",
"product_code":"dws",
"title":"Tagging",
"uri":"dws_02_0055.html",
"doc_type":"api",
"p_code":"28",
"code":"29"
},
{
"desc":"This API is used to add a resource tag for a resource. A maximum of 10 tags can be added for one resource.NoneNone",
"product_code":"dws",
"title":"Adding a Resource Tag",
"uri":"dws_02_0046.html",
"doc_type":"api",
"p_code":"28",
"code":"30"
},
{
"desc":"This API is used to add or delete tags in batches for a specified resource. A maximum of 10 tags can be added for one resource.NoneSample request for adding tags in batch",
"product_code":"dws",
"title":"Adding or Deleting Resource Tags in Batches",
"uri":"dws_02_0047.html",
"doc_type":"api",
"p_code":"28",
"code":"31"
},
{
"desc":"This API is used to query resource instances that meet the specified tag filtering criteria.Sample request when action is set to filterPOST /v1.0/89cd04f168b84af6be287f71",
"product_code":"dws",
"title":"Querying Resources by Tag",
"uri":"dws_02_0048.html",
"doc_type":"api",
"p_code":"28",
"code":"32"
},
{
"desc":"This API is used to query tags of a specified resource.None",
"product_code":"dws",
"title":"Querying Resource Tags",
"uri":"dws_02_0049.html",
"doc_type":"api",
"p_code":"28",
"code":"33"
},
{
"desc":"This API is used to query all tags of a tenant for a specified resource type in a specified project.None",
"product_code":"dws",
"title":"Querying Tags in a Specified Project",
"uri":"dws_02_0050.html",
"doc_type":"api",
"p_code":"28",
"code":"34"
},
{
"desc":"This API is used to delete a resource tag for a resource.NoneNoneNone",
"product_code":"dws",
"title":"Deleting a Resource Tag",
"uri":"dws_02_0051.html",
"doc_type":"api",
"p_code":"28",
"code":"35"
},
{
"desc":"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",
"product_code":"dws",
"title":"Permissions Policies and Supported Actions",
"uri":"dws_02_0056.html",
"doc_type":"api",
"p_code":"",
"code":"36"
},
{
"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":"37"
},
{
"desc":"Table 1 describes the status code.",
"product_code":"dws",
"title":"Status Code",
"uri":"dws_02_0038.html",
"doc_type":"api",
"p_code":"37",
"code":"38"
},
{
"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":"37",
"code":"39"
},
{
"desc":"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 ",
"product_code":"dws",
"title":"Creating a VPC",
"uri":"dws_02_0040.html",
"doc_type":"api",
"p_code":"37",
"code":"40"
},
{
"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 a Project ID",
"uri":"dws_02_0011.html",
"doc_type":"api",
"p_code":"37",
"code":"41"
},
{
"desc":"An account 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 a",
"product_code":"dws",
"title":"Obtaining an Account ID",
"uri":"dws_02_0067.html",
"doc_type":"api",
"p_code":"37",
"code":"42"
},
{
"desc":"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 ",
"product_code":"dws",
"title":"Obtaining the Cluster ID",
"uri":"dws_02_00068.html",
"doc_type":"api",
"p_code":"37",
"code":"43"
},
{
"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":"44"
}
]
View Git Blame Copy Permalink