[ { "uri":"opengauss_api_0001.html", "product_code":"opengauss", "code":"1", "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":"Before You Start", "title":"Before You Start", "githuburl":"" }, { "uri":"opengauss_api_0002.html", "product_code":"opengauss", "code":"2", "des":"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", "doc_type":"api", "kw":"Overview,Before You Start,API Reference", "title":"Overview", "githuburl":"" }, { "uri":"opengauss_api_0003.html", "product_code":"opengauss", "code":"3", "des":"GaussDB(openGauss) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see API Overview.", "doc_type":"api", "kw":"API Calling,Before You Start,API Reference", "title":"API Calling", "githuburl":"" }, { "uri":"opengauss_api_0004.html", "product_code":"opengauss", "code":"4", "des":"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.", "doc_type":"api", "kw":"Endpoints,Before You Start,API Reference", "title":"Endpoints", "githuburl":"" }, { "uri":"opengauss_api_0005.html", "product_code":"opengauss", "code":"5", "des":"For more constraints, see API description.", "doc_type":"api", "kw":"Constraints,Before You Start,API Reference", "title":"Constraints", "githuburl":"" }, { "uri":"opengauss_api_0006.html", "product_code":"opengauss", "code":"6", "des":"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", "doc_type":"api", "kw":"Concepts,Before You Start,API Reference", "title":"Concepts", "githuburl":"" }, { "uri":"opengauss_api_0007.html", "product_code":"opengauss", "code":"7", "des":"GaussDB(openGauss) APIs enable you to use all GaussDB(openGauss) functions, including creating/deleting DB instances and scaling up instance storage space.", "doc_type":"api", "kw":"API Overview,API Reference", "title":"API Overview", "githuburl":"" }, { "uri":"opengauss_api_0012.html", "product_code":"opengauss", "code":"8", "des":"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 ", "doc_type":"api", "kw":"Using APIs,API Reference", "title":"Using APIs", "githuburl":"" }, { "uri":"opengauss_api_0013.html", "product_code":"opengauss", "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":"API", "title":"API", "githuburl":"" }, { "uri":"opengauss_api_0014.html", "product_code":"opengauss", "code":"10", "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":"DB Instance Management", "title":"DB Instance Management", "githuburl":"" }, { "uri":"opengauss_api_0015.html", "product_code":"opengauss", "code":"11", "des":"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", "doc_type":"api", "kw":"Creating a DB Instance,DB Instance Management,API Reference", "title":"Creating a DB Instance", "githuburl":"" }, { "uri":"opengauss_api_0016.html", "product_code":"opengauss", "code":"12", "des":"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", "doc_type":"api", "kw":"Scaling Up Storage Space of a DB Instance,DB Instance Management,API Reference", "title":"Scaling Up Storage Space of a DB Instance", "githuburl":"" }, { "uri":"opengauss_api_0017.html", "product_code":"opengauss", "code":"13", "des":"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", "doc_type":"api", "kw":"Deleting a DB Instance,DB Instance Management,API Reference", "title":"Deleting a DB Instance", "githuburl":"" }, { "uri":"opengauss_api_0018.html", "product_code":"opengauss", "code":"14", "des":"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", "doc_type":"api", "kw":"Querying Details About DB Instances,DB Instance Management,API Reference", "title":"Querying Details About DB Instances", "githuburl":"" }, { "uri":"opengauss_api_0019.html", "product_code":"opengauss", "code":"15", "des":"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", "doc_type":"api", "kw":"Adding CNs,DB Instance Management,API Reference", "title":"Adding CNs", "githuburl":"" }, { "uri":"opengauss_api_0020.html", "product_code":"opengauss", "code":"16", "des":"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", "doc_type":"api", "kw":"Adding Shards,DB Instance Management,API Reference", "title":"Adding Shards", "githuburl":"" }, { "uri":"opengauss_api_0021.html", "product_code":"opengauss", "code":"17", "des":"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 ", "doc_type":"api", "kw":"Resetting a Database Password,DB Instance Management,API Reference", "title":"Resetting a Database Password", "githuburl":"" }, { "uri":"opengauss_api_0022.html", "product_code":"opengauss", "code":"18", "des":"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 ", "doc_type":"api", "kw":"Modifying a DB Instance Name,DB Instance Management,API Reference", "title":"Modifying a DB Instance Name", "githuburl":"" }, { "uri":"opengauss_api_0023.html", "product_code":"opengauss", "code":"19", "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":"Parameter Configuration", "title":"Parameter Configuration", "githuburl":"" }, { "uri":"opengauss_api_0024.html", "product_code":"opengauss", "code":"20", "des":"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", "doc_type":"api", "kw":"Modifying Parameters of a Specified DB Instance,Parameter Configuration,API Reference", "title":"Modifying Parameters of a Specified DB Instance", "githuburl":"" }, { "uri":"opengauss_api_0025.html", "product_code":"opengauss", "code":"21", "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":"Backup Management", "title":"Backup Management", "githuburl":"" }, { "uri":"opengauss_api_0026.html", "product_code":"opengauss", "code":"22", "des":"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", "doc_type":"api", "kw":"Setting an Automated Backup Policy,Backup Management,API Reference", "title":"Setting an Automated Backup Policy", "githuburl":"" }, { "uri":"opengauss_api_0030.html", "product_code":"opengauss", "code":"23", "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", "title":"Appendix", "githuburl":"" }, { "uri":"opengauss_api_0031.html", "product_code":"opengauss", "code":"24", "des":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_ms", "doc_type":"api", "kw":"Abnormal Request Results,Appendix,API Reference", "title":"Abnormal Request Results", "githuburl":"" }, { "uri":"opengauss_api_0032.html", "product_code":"opengauss", "code":"25", "des":"Table 1 describes status codes.", "doc_type":"api", "kw":"Status Codes,Appendix,API Reference", "title":"Status Codes", "githuburl":"" }, { "uri":"opengauss_api_0033.html", "product_code":"opengauss", "code":"26", "des":"The following table describes error codes.", "doc_type":"api", "kw":"Error Codes,Appendix,API Reference", "title":"Error Codes", "githuburl":"" }, { "uri":"opengauss_api_0034.html", "product_code":"opengauss", "code":"27", "des":"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", "doc_type":"api", "kw":"Obtaining a Project ID,Appendix,API Reference", "title":"Obtaining a Project ID", "githuburl":"" }, { "uri":"opengauss_api_0036.html", "product_code":"opengauss", "code":"28", "des":"Replication mode table", "doc_type":"api", "kw":"Replication Mode Table,Appendix,API Reference", "title":"Replication Mode Table", "githuburl":"" }, { "uri":"opengauss_api_0037.html", "product_code":"opengauss", "code":"29", "des":"This section describes the GaussDB(openGauss) DB instance class.", "doc_type":"api", "kw":"DB Instance Class,Appendix,API Reference", "title":"DB Instance Class", "githuburl":"" }, { "uri":"opengauss_api_0038.html", "product_code":"opengauss", "code":"30", "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", "title":"Change History", "githuburl":"" } ]