forked from docs/doc-exports
Wang , Deng Ke
a96a12ecf1
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
272 lines
9.8 KiB
JSON
272 lines
9.8 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":"opengauss",
|
|
"title":"Before You Start",
|
|
"uri":"opengauss_api_0001.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"1"
|
|
},
|
|
{
|
|
"desc":"Welcome to GaussDB(openGauss) API Reference. GaussDB(openGauss) is a next-generation, enterprise-class distributed database. It is designed based on the shared-nothing ar",
|
|
"product_code":"opengauss",
|
|
"title":"Overview",
|
|
"uri":"opengauss_api_0002.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"2"
|
|
},
|
|
{
|
|
"desc":"GaussDB(openGauss) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see API Overview.",
|
|
"product_code":"opengauss",
|
|
"title":"API Calling",
|
|
"uri":"opengauss_api_0003.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":"opengauss",
|
|
"title":"Endpoints",
|
|
"uri":"opengauss_api_0004.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"4"
|
|
},
|
|
{
|
|
"desc":"For more constraints, see API description.",
|
|
"product_code":"opengauss",
|
|
"title":"Constraints",
|
|
"uri":"opengauss_api_0005.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":"opengauss",
|
|
"title":"Concepts",
|
|
"uri":"opengauss_api_0006.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"6"
|
|
},
|
|
{
|
|
"desc":"GaussDB(openGauss) APIs enable you to use all GaussDB(openGauss) functions, including creating/deleting DB instances and scaling up instance storage space.",
|
|
"product_code":"opengauss",
|
|
"title":"API Overview",
|
|
"uri":"opengauss_api_0007.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"7"
|
|
},
|
|
{
|
|
"desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ",
|
|
"product_code":"opengauss",
|
|
"title":"Using APIs",
|
|
"uri":"opengauss_api_0012.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":"opengauss",
|
|
"title":"API",
|
|
"uri":"opengauss_api_0013.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"9"
|
|
},
|
|
{
|
|
"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":"opengauss",
|
|
"title":"DB Instance Management",
|
|
"uri":"opengauss_api_0014.html",
|
|
"doc_type":"api",
|
|
"p_code":"9",
|
|
"code":"10"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a GaussDB(openGauss) DB instance. GaussDB(openGauss) supports distributed instances.Before calling an API, you need to understand the API in Us",
|
|
"product_code":"opengauss",
|
|
"title":"Creating a DB Instance",
|
|
"uri":"opengauss_api_0015.html",
|
|
"doc_type":"api",
|
|
"p_code":"10",
|
|
"code":"11"
|
|
},
|
|
{
|
|
"desc":"This API is used to scale up storage space of a DB instance.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the requir",
|
|
"product_code":"opengauss",
|
|
"title":"Scaling Up Storage Space of a DB Instance",
|
|
"uri":"opengauss_api_0016.html",
|
|
"doc_type":"api",
|
|
"p_code":"10",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a DB instance.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and endpo",
|
|
"product_code":"opengauss",
|
|
"title":"Deleting a DB Instance",
|
|
"uri":"opengauss_api_0017.html",
|
|
"doc_type":"api",
|
|
"p_code":"10",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"This API is used to query DB instances according to search criteria.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain th",
|
|
"product_code":"opengauss",
|
|
"title":"Querying Details About DB Instances",
|
|
"uri":"opengauss_api_0018.html",
|
|
"doc_type":"api",
|
|
"p_code":"10",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"desc":"This API is used to add CNs.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and endpoint.The CN gr",
|
|
"product_code":"opengauss",
|
|
"title":"Adding CNs",
|
|
"uri":"opengauss_api_0019.html",
|
|
"doc_type":"api",
|
|
"p_code":"10",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"This API is used to add shards.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and endpoint.Interm",
|
|
"product_code":"opengauss",
|
|
"title":"Adding Shards",
|
|
"uri":"opengauss_api_0020.html",
|
|
"doc_type":"api",
|
|
"p_code":"10",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"desc":"This API is used to reset a database password.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and ",
|
|
"product_code":"opengauss",
|
|
"title":"Resetting a Database Password",
|
|
"uri":"opengauss_api_0021.html",
|
|
"doc_type":"api",
|
|
"p_code":"10",
|
|
"code":"17"
|
|
},
|
|
{
|
|
"desc":"This API is used to change a DB instance name.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and ",
|
|
"product_code":"opengauss",
|
|
"title":"Modifying a DB Instance Name",
|
|
"uri":"opengauss_api_0022.html",
|
|
"doc_type":"api",
|
|
"p_code":"10",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"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":"opengauss",
|
|
"title":"Parameter Configuration",
|
|
"uri":"opengauss_api_0023.html",
|
|
"doc_type":"api",
|
|
"p_code":"9",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify parameters in the parameter template of a specified DB instance.Before calling an API, you need to understand the API in Using APIs.Before call",
|
|
"product_code":"opengauss",
|
|
"title":"Modifying Parameters of a Specified DB Instance",
|
|
"uri":"opengauss_api_0024.html",
|
|
"doc_type":"api",
|
|
"p_code":"19",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"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":"opengauss",
|
|
"title":"Backup Management",
|
|
"uri":"opengauss_api_0025.html",
|
|
"doc_type":"api",
|
|
"p_code":"9",
|
|
"code":"21"
|
|
},
|
|
{
|
|
"desc":"This API is used to set an automated backup policy.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region",
|
|
"product_code":"opengauss",
|
|
"title":"Setting an Automated Backup Policy",
|
|
"uri":"opengauss_api_0026.html",
|
|
"doc_type":"api",
|
|
"p_code":"21",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"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":"opengauss",
|
|
"title":"Appendix",
|
|
"uri":"opengauss_api_0030.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"desc":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_ms",
|
|
"product_code":"opengauss",
|
|
"title":"Abnormal Request Results",
|
|
"uri":"opengauss_api_0031.html",
|
|
"doc_type":"api",
|
|
"p_code":"23",
|
|
"code":"24"
|
|
},
|
|
{
|
|
"desc":"Table 1 describes status codes.",
|
|
"product_code":"opengauss",
|
|
"title":"Status Codes",
|
|
"uri":"opengauss_api_0032.html",
|
|
"doc_type":"api",
|
|
"p_code":"23",
|
|
"code":"25"
|
|
},
|
|
{
|
|
"desc":"The following table describes error codes.",
|
|
"product_code":"opengauss",
|
|
"title":"Error Codes",
|
|
"uri":"opengauss_api_0033.html",
|
|
"doc_type":"api",
|
|
"p_code":"23",
|
|
"code":"26"
|
|
},
|
|
{
|
|
"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.On the My Credential page, view project IDs in the p",
|
|
"product_code":"opengauss",
|
|
"title":"Obtaining a Project ID",
|
|
"uri":"opengauss_api_0034.html",
|
|
"doc_type":"api",
|
|
"p_code":"23",
|
|
"code":"27"
|
|
},
|
|
{
|
|
"desc":"Replication mode table",
|
|
"product_code":"opengauss",
|
|
"title":"Replication Mode Table",
|
|
"uri":"opengauss_api_0036.html",
|
|
"doc_type":"api",
|
|
"p_code":"23",
|
|
"code":"28"
|
|
},
|
|
{
|
|
"desc":"This section describes the GaussDB(openGauss) DB instance class.",
|
|
"product_code":"opengauss",
|
|
"title":"DB Instance Class",
|
|
"uri":"opengauss_api_0037.html",
|
|
"doc_type":"api",
|
|
"p_code":"23",
|
|
"code":"29"
|
|
},
|
|
{
|
|
"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":"opengauss",
|
|
"title":"Change History",
|
|
"uri":"opengauss_api_0038.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"30"
|
|
}
|
|
] |