forked from docs/doc-exports
Wang , Deng Ke
a8436b1d56
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
299 lines
11 KiB
JSON
299 lines
11 KiB
JSON
[
|
|
{
|
|
"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":"gaussdb",
|
|
"title":"Before You Start",
|
|
"uri":"gaussdb_00_0011.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"1"
|
|
},
|
|
{
|
|
"desc":"This document describes how to use application programming interfaces (APIs) to perform operations on DB instances. For details about all supported operations, see API Ov",
|
|
"product_code":"gaussdb",
|
|
"title":"Overview",
|
|
"uri":"gaussdb_00_0001.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"2"
|
|
},
|
|
{
|
|
"desc":"GaussDB(for MySQL) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.",
|
|
"product_code":"gaussdb",
|
|
"title":"API Calling",
|
|
"uri":"gaussdb_00_0002.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 Regions and Endpoints.",
|
|
"product_code":"gaussdb",
|
|
"title":"Endpoints",
|
|
"uri":"gaussdb_00_0003.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"4"
|
|
},
|
|
{
|
|
"desc":"The number of DB instances that you can create is determined by your quota. To view or increase the quota, see \"Managing Quotas\" in the GaussDB(for MySQL) User Guide.For ",
|
|
"product_code":"gaussdb",
|
|
"title":"Constraints",
|
|
"uri":"gaussdb_00_0004.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"5"
|
|
},
|
|
{
|
|
"desc":"DomainA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user p",
|
|
"product_code":"gaussdb",
|
|
"title":"Concepts",
|
|
"uri":"gaussdb_00_0005.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"6"
|
|
},
|
|
{
|
|
"desc":"With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas.",
|
|
"product_code":"gaussdb",
|
|
"title":"API Overview",
|
|
"uri":"gaussdb_02_0000.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":"gaussdb",
|
|
"title":"Calling APIs",
|
|
"uri":"gaussdb_03_0000.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"8"
|
|
},
|
|
{
|
|
"desc":"This section describes the structure of a REST API, and uses the IAM API for obtaining a user token as an example to describe how to call an API. The obtained token is us",
|
|
"product_code":"gaussdb",
|
|
"title":"Making an API Request",
|
|
"uri":"gaussdb_03_0005.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"9"
|
|
},
|
|
{
|
|
"desc":"Token authentication must be performed to call APIs.Authentication using tokens: General requests are authenticated using tokens.The validity period of a token is 24 hour",
|
|
"product_code":"gaussdb",
|
|
"title":"Authentication",
|
|
"uri":"gaussdb_03_0001.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"10"
|
|
},
|
|
{
|
|
"desc":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits ranging from 1xx to",
|
|
"product_code":"gaussdb",
|
|
"title":"Response",
|
|
"uri":"gaussdb_03_0006.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"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":"gaussdb",
|
|
"title":"API",
|
|
"uri":"gaussdb_04_0000.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the DB version information of a specified DB engine.Learn how to authorize and authenticate this API before using it.Before calling this API, ob",
|
|
"product_code":"gaussdb",
|
|
"title":"Querying Version Information About a DB Engine",
|
|
"uri":"gaussdb_04_0001.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the database specifications of a specified DB engine version.Learn how to authorize and authenticate this API before using it.Before calling thi",
|
|
"product_code":"gaussdb",
|
|
"title":"Querying Database Specifications",
|
|
"uri":"gaussdb_04_0002.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"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":"gaussdb",
|
|
"title":"Managing DB Instances",
|
|
"uri":"gaussdb_04_0003.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a GaussDB(for MySQL) DB instanceLearn how to authorize and authenticate this API before using it.Before calling this API, obtain the required r",
|
|
"product_code":"gaussdb",
|
|
"title":"Creating a DB instance",
|
|
"uri":"gaussdb_04_0004.html",
|
|
"doc_type":"api",
|
|
"p_code":"15",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"desc":"This API is used to query a DB instance list according to search criteria.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain",
|
|
"product_code":"gaussdb",
|
|
"title":"Querying a DB Instance List",
|
|
"uri":"gaussdb_04_0005.html",
|
|
"doc_type":"api",
|
|
"p_code":"15",
|
|
"code":"17"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the details of a specified DB instance.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain the requ",
|
|
"product_code":"gaussdb",
|
|
"title":"Querying Details of a DB Instance",
|
|
"uri":"gaussdb_04_0006.html",
|
|
"doc_type":"api",
|
|
"p_code":"15",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a DB instance.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain the required region and endpoint",
|
|
"product_code":"gaussdb",
|
|
"title":"Deleting a DB Instance",
|
|
"uri":"gaussdb_04_0007.html",
|
|
"doc_type":"api",
|
|
"p_code":"15",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"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":"gaussdb",
|
|
"title":"Managing Parameter Templates",
|
|
"uri":"gaussdb_04_0008.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain a parameter template list, including all databases' default and custom parameter templates.Learn how to authorize and authenticate this API bef",
|
|
"product_code":"gaussdb",
|
|
"title":"Querying a Parameter Template",
|
|
"uri":"gaussdb_04_0009.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"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":"gaussdb",
|
|
"title":"Managing Quotas",
|
|
"uri":"gaussdb_04_0010.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the resource quota of a specified enterprise project.Learn how to authorize and authenticate this API before using it.Before calling this API, ",
|
|
"product_code":"gaussdb",
|
|
"title":"Querying Resource Quotas",
|
|
"uri":"gaussdb_04_0011.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"desc":"This API is used to set resource quotas for a specified enterprise project.Learn how to authorize and authenticate this API before using it.Before calling this API, obtai",
|
|
"product_code":"gaussdb",
|
|
"title":"Configuring Resource Quotas",
|
|
"uri":"gaussdb_04_0012.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"24"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the resource quota of a specified enterprise project.Learn how to authorize and authenticate this API before using it.Before calling this API, ",
|
|
"product_code":"gaussdb",
|
|
"title":"Modifying Resource Quotas",
|
|
"uri":"gaussdb_04_0013.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"25"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain task information from the task center.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain the requ",
|
|
"product_code":"gaussdb",
|
|
"title":"Obtaining Task Information",
|
|
"uri":"gaussdb_04_0014.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"26"
|
|
},
|
|
{
|
|
"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":"gaussdb",
|
|
"title":"Appendix",
|
|
"uri":"gaussdb_10_0000.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"27"
|
|
},
|
|
{
|
|
"desc":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringReturned error code when a task submission exception occurs. For details, see",
|
|
"product_code":"gaussdb",
|
|
"title":"Abnormal Request Results",
|
|
"uri":"gaussdb_10_0001.html",
|
|
"doc_type":"api",
|
|
"p_code":"27",
|
|
"code":"28"
|
|
},
|
|
{
|
|
"desc":"Status code list:",
|
|
"product_code":"gaussdb",
|
|
"title":"Status Codes",
|
|
"uri":"gaussdb_10_0002.html",
|
|
"doc_type":"api",
|
|
"p_code":"27",
|
|
"code":"29"
|
|
},
|
|
{
|
|
"desc":"The following table describes error codes.",
|
|
"product_code":"gaussdb",
|
|
"title":"Error Codes",
|
|
"uri":"gaussdb_10_0003.html",
|
|
"doc_type":"api",
|
|
"p_code":"27",
|
|
"code":"30"
|
|
},
|
|
{
|
|
"desc":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first. Two methods are available:Obtaining the Project ID ",
|
|
"product_code":"gaussdb",
|
|
"title":"Obtaining a Project ID",
|
|
"uri":"gaussdb_10_0004.html",
|
|
"doc_type":"api",
|
|
"p_code":"27",
|
|
"code":"31"
|
|
},
|
|
{
|
|
"desc":"This section describes namespaces, descriptions, and dimensions of monitoring metrics to be reported to Cloud Eye. You can use APIs provided by Cloud Eye to retrieve moni",
|
|
"product_code":"gaussdb",
|
|
"title":"GaussDB(for MySQL) Monitoring Metrics",
|
|
"uri":"gaussdb_10_0006.html",
|
|
"doc_type":"api",
|
|
"p_code":"27",
|
|
"code":"32"
|
|
},
|
|
{
|
|
"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":"gaussdb",
|
|
"title":"Change History",
|
|
"uri":"changeHistory.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"33"
|
|
}
|
|
] |