yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
070036121f0605ae625830461f9c1e02058e22f1
doc-exports/docs/dws/api-ref/ALL_META.TXT.json
luhuayi fd5ee5dcd8 DWS API 20250722 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: luhuayi <luhuayi@huawei.com>
Co-committed-by: luhuayi <luhuayi@huawei.com>
2025-07-30 14:29:39 +00:00

726 lines
20 KiB
JSON
Raw Blame History

[
{
"dockw":"API Reference"
},
{
"uri":"dws_02_0057.html",
"node_id":"en-us_topic_0000001231391265.xml",
"product_code":"dws",
"code":"1",
"des":"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 ",
"doc_type":"api",
"kw":"Before You Start,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Before You Start",
"githuburl":""
},
{
"uri":"dws_02_0034.html",
"node_id":"en-us_topic_0000001231631313.xml",
"product_code":"dws",
"code":"2",
"des":"You can use the following GaussDB(DWS) functions with the APIs.",
"doc_type":"api",
"kw":"API Overview,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"API Overview",
"githuburl":""
},
{
"uri":"dws_02_0062.html",
"node_id":"en-us_topic_0000001186151620.xml",
"product_code":"dws",
"code":"3",
"des":"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.",
"doc_type":"api",
"kw":"Calling APIs",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws"
}
],
"title":"Calling APIs",
"githuburl":""
},
{
"uri":"dws_02_0063.html",
"node_id":"en-us_topic_0000001185673174.xml",
"product_code":"dws",
"code":"4",
"des":"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 ",
"doc_type":"api",
"kw":"Making an API Request,Calling APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Making an API Request",
"githuburl":""
},
{
"uri":"dws_02_0064.html",
"node_id":"en-us_topic_0000001231391263.xml",
"product_code":"dws",
"code":"5",
"des":"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",
"doc_type":"api",
"kw":"Authentication,Calling APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Authentication",
"githuburl":""
},
{
"uri":"dws_02_0065.html",
"node_id":"en-us_topic_0000001185833138.xml",
"product_code":"dws",
"code":"6",
"des":"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 ",
"doc_type":"api",
"kw":"Response,Calling APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Response",
"githuburl":""
},
{
"uri":"dws_02_0036.html",
"node_id":"en-us_topic_0000001231272819.xml",
"product_code":"dws",
"code":"7",
"des":"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",
"doc_type":"api",
"kw":"Getting Started,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Getting Started",
"githuburl":""
},
{
"uri":"dws_02_0037.html",
"node_id":"en-us_topic_0000001231631319.xml",
"product_code":"dws",
"code":"8",
"des":"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.",
"doc_type":"api",
"kw":"API Description",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"API Description",
"githuburl":""
},
{
"uri":"dws_02_0017.html",
"node_id":"en-us_topic_0000001231472771.xml",
"product_code":"dws",
"code":"9",
"des":"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.",
"doc_type":"api",
"kw":"Cluster Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Cluster Management",
"githuburl":""
},
{
"uri":"dws_02_0020.html",
"node_id":"en-us_topic_0000001231272825.xml",
"product_code":"dws",
"code":"10",
"des":"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",
"doc_type":"api",
"kw":"Creating a Cluster,Cluster Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Creating a Cluster",
"githuburl":""
},
{
"uri":"dws_02_0018.html",
"node_id":"en-us_topic_0000001185833140.xml",
"product_code":"dws",
"code":"11",
"des":"This API is used to query and display the cluster list.None",
"doc_type":"api",
"kw":"Querying the Cluster List,Cluster Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Querying the Cluster List",
"githuburl":""
},
{
"uri":"dws_02_0019.html",
"node_id":"en-us_topic_0000001185991702.xml",
"product_code":"dws",
"code":"12",
"des":"This API is used to query cluster details.None",
"doc_type":"api",
"kw":"Querying Cluster Details,Cluster Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Querying Cluster Details",
"githuburl":""
},
{
"uri":"dws_02_0022.html",
"node_id":"en-us_topic_0000001231472761.xml",
"product_code":"dws",
"code":"13",
"des":"This API is used to query the node types supported by GaussDB(DWS).None",
"doc_type":"api",
"kw":"Querying the Supported Node Types,Cluster Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Querying the Supported Node Types",
"githuburl":""
},
{
"uri":"dws_02_0021.html",
"node_id":"en-us_topic_0000001185991698.xml",
"product_code":"dws",
"code":"14",
"des":"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",
"doc_type":"api",
"kw":"Deleting a Cluster,Cluster Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Deleting a Cluster",
"githuburl":""
},
{
"uri":"dws_02_0052.html",
"node_id":"en-us_topic_0000001231272815.xml",
"product_code":"dws",
"code":"15",
"des":"This API is used to restart clusters.NoneNone",
"doc_type":"api",
"kw":"Restarting a Cluster,Cluster Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Restarting a Cluster",
"githuburl":""
},
{
"uri":"dws_02_0053.html",
"node_id":"en-us_topic_0000001231472767.xml",
"product_code":"dws",
"code":"16",
"des":"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-",
"doc_type":"api",
"kw":"Scaling Out a Cluster,Cluster Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Scaling Out a Cluster",
"githuburl":""
},
{
"uri":"dws_02_0054.html",
"node_id":"en-us_topic_0000001186151628.xml",
"product_code":"dws",
"code":"17",
"des":"This API is used to reset the password of cluster administrator.None",
"doc_type":"api",
"kw":"Resetting a Password,Cluster Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Resetting a Password",
"githuburl":""
},
{
"uri":"dws_02_0023.html",
"node_id":"en-us_topic_0000001231631321.xml",
"product_code":"dws",
"code":"18",
"des":"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.",
"doc_type":"api",
"kw":"Snapshot Management APIs",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Snapshot Management APIs",
"githuburl":""
},
{
"uri":"dws_02_0026.html",
"node_id":"en-us_topic_0000001185673172.xml",
"product_code":"dws",
"code":"19",
"des":"This API is used to create snapshots for a specified cluster.",
"doc_type":"api",
"kw":"Creating a Snapshot,Snapshot Management APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Creating a Snapshot",
"githuburl":""
},
{
"uri":"dws_02_0024.html",
"node_id":"en-us_topic_0000001186151630.xml",
"product_code":"dws",
"code":"20",
"des":"This API is used to query the snapshot list.None",
"doc_type":"api",
"kw":"Querying the Snapshot List,Snapshot Management APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Querying the Snapshot List",
"githuburl":""
},
{
"uri":"dws_02_0025.html",
"node_id":"en-us_topic_0000001185833136.xml",
"product_code":"dws",
"code":"21",
"des":"This API is used to query snapshot details by using the snapshot ID.None",
"doc_type":"api",
"kw":"Querying Snapshot Details,Snapshot Management APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Querying Snapshot Details",
"githuburl":""
},
{
"uri":"dws_02_0027.html",
"node_id":"en-us_topic_0000001231631317.xml",
"product_code":"dws",
"code":"22",
"des":"This API is used to delete a specified manual snapshot.NoneNoneNone",
"doc_type":"api",
"kw":"Deleting a Manual Snapshot,Snapshot Management APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Deleting a Manual Snapshot",
"githuburl":""
},
{
"uri":"dws_02_0032.html",
"node_id":"en-us_topic_0000001186151624.xml",
"product_code":"dws",
"code":"23",
"des":"This API is used to restore clusters using the snapshot.",
"doc_type":"api",
"kw":"Restoring a Cluster,Snapshot Management APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Restoring a Cluster",
"githuburl":""
},
{
"uri":"dws_02_0045.html",
"node_id":"en-us_topic_0000002395330893.xml",
"product_code":"DWS",
"code":"24",
"des":"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.",
"doc_type":"api",
"kw":"Tag Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"DWS"
}
],
"title":"Tag Management",
"githuburl":""
},
{
"uri":"dws_02_0055.html",
"node_id":"en-us_topic_0000001231272809.xml",
"product_code":"dws",
"code":"25",
"des":"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",
"doc_type":"api",
"kw":"Tagging,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws"
}
],
"title":"Tagging",
"githuburl":""
},
{
"uri":"dws_02_0050.html",
"node_id":"en-us_topic_0000002361650974.xml",
"product_code":"DWS",
"code":"26",
"des":"This API is used to query the tags of a project.NoneStatus code: 200Status code: 200The project tags are queried successfully.",
"doc_type":"api",
"kw":"Querying Tags in a Project,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"DWS",
"operation_id":"ListTags"
}
],
"title":"Querying Tags in a Project",
"githuburl":""
},
{
"uri":"dws_02_0049.html",
"node_id":"en-us_topic_0000002361491110.xml",
"product_code":"DWS",
"code":"27",
"des":"This API is used to query the tags of a cluster.NoneStatus code: 200Status code: 200The cluster tags are queried successfully.",
"doc_type":"api",
"kw":"Querying Cluster Tags,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"DWS",
"operation_id":"ListClusterTags"
}
],
"title":"Querying Cluster Tags",
"githuburl":""
},
{
"uri":"dws_02_0047.html",
"node_id":"en-us_topic_0000002395171013.xml",
"product_code":"DWS",
"code":"28",
"des":"This API is used to add tags to a cluster in batches.Status code: 200Tags are added in batches.NoneAdd tags whose key is key and value is value in batches.None",
"doc_type":"api",
"kw":"Adding Tags in Batches,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"DWS",
"operation_id":"BatchCreateResourceTag"
}
],
"title":"Adding Tags in Batches",
"githuburl":""
},
{
"uri":"dws_02_0048.html",
"node_id":"en-us_topic_0000002395330901.xml",
"product_code":"DWS",
"code":"29",
"des":"This API is used to delete tags from a cluster in batches.Status code: 200Tags are deleted in batches.NoneDelete tags whose key is key and value is value in batches.None",
"doc_type":"api",
"kw":"Deleting Tags in Batches,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"DWS",
"operation_id":"BatchDeleteResourceTag"
}
],
"title":"Deleting Tags in Batches",
"githuburl":""
},
{
"uri":"dws_02_0056.html",
"node_id":"en-us_topic_0000001185673170.xml",
"product_code":"dws",
"code":"30",
"des":"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",
"doc_type":"api",
"kw":"Permissions Policies and Supported Actions,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Permissions Policies and Supported Actions",
"githuburl":""
},
{
"uri":"dws_02_0066.html",
"node_id":"en-us_topic_0000001185991712.xml",
"product_code":"dws",
"code":"31",
"des":"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.",
"doc_type":"api",
"kw":"Appendix",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws"
}
],
"title":"Appendix",
"githuburl":""
},
{
"uri":"dws_02_0038.html",
"node_id":"en-us_topic_0000001231472773.xml",
"product_code":"dws",
"code":"32",
"des":"Table 1 describes the status code.",
"doc_type":"api",
"kw":"Status Code,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws"
}
],
"title":"Status Code",
"githuburl":""
},
{
"uri":"dws_02_0030.html",
"node_id":"en-us_topic_0000001326816266.xml",
"product_code":"dws",
"code":"33",
"des":"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 ",
"doc_type":"api",
"kw":"Error Code,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Error Code",
"githuburl":""
},
{
"uri":"dws_02_0040.html",
"node_id":"en-us_topic_0000001231631331.xml",
"product_code":"dws",
"code":"34",
"des":"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 ",
"doc_type":"api",
"kw":"Creating a VPC,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Creating a VPC",
"githuburl":""
},
{
"uri":"dws_02_0011.html",
"node_id":"en-us_topic_0000001231472757.xml",
"product_code":"dws",
"code":"35",
"des":"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://",
"doc_type":"api",
"kw":"Obtaining a Project ID,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Obtaining a Project ID",
"githuburl":""
},
{
"uri":"dws_02_0067.html",
"node_id":"en-us_topic_0000001231631315.xml",
"product_code":"dws",
"code":"36",
"des":"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",
"doc_type":"api",
"kw":"Obtaining an Account,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Obtaining an Account",
"githuburl":""
},
{
"uri":"dws_02_00068.html",
"node_id":"en-us_topic_0000001231631323.xml",
"product_code":"dws",
"code":"37",
"des":"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 ",
"doc_type":"api",
"kw":"Obtaining the Cluster ID,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Obtaining the Cluster ID",
"githuburl":""
},
{
"uri":"dws_02_0031.html",
"node_id":"en-us_topic_0000001185673176.xml",
"product_code":"dws",
"code":"38",
"des":"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.",
"doc_type":"api",
"kw":"Change History,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dws",
"opensource":"true"
}
],
"title":"Change History",
"githuburl":""
}
]
View Git Blame Copy Permalink