[ { "dockw":"API Reference" }, { "uri":"opengauss_api_0001.html", "node_id":"en-us_topic_0000001917130792.xml", "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", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Before You Start", "githuburl":"" }, { "uri":"opengauss_api_0002.html", "node_id":"en-us_topic_0000001947569661.xml", "product_code":"opengauss", "code":"2", "des":"GaussDB is a distributed relational database. GaussDB supports distributed transactions and intra-city deployment across AZs for zero data loss, storage for petabytes of ", "doc_type":"api", "kw":"Overview,Before You Start,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Overview", "githuburl":"" }, { "uri":"opengauss_api_0003.html", "node_id":"en-us_topic_0000001917290664.xml", "product_code":"opengauss", "code":"3", "des":"GaussDB 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", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"API Calling", "githuburl":"" }, { "uri":"opengauss_api_0004.html", "node_id":"en-us_topic_0000001917130620.xml", "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", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Endpoints", "githuburl":"" }, { "uri":"opengauss_api_0005.html", "node_id":"en-us_topic_0000001917130448.xml", "product_code":"opengauss", "code":"5", "des":"For more constraints, see API description.", "doc_type":"api", "kw":"Constraints,Before You Start,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Constraints", "githuburl":"" }, { "uri":"opengauss_api_0006.html", "node_id":"en-us_topic_0000001947569525.xml", "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", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Concepts", "githuburl":"" }, { "uri":"opengauss_api_0007.html", "node_id":"en-us_topic_0000001917290636.xml", "product_code":"opengauss", "code":"7", "des":"You can use APIs to create and delete DB instances, query DB instances, obtain and modify parameters of a specified DB instance, and set and query automated backup polici", "doc_type":"api", "kw":"API Overview,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"API Overview", "githuburl":"" }, { "uri":"opengauss_api_0008.html", "node_id":"en-us_topic_0000001917130428.xml", "product_code":"opengauss", "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":"Calling APIs", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Calling APIs", "githuburl":"" }, { "uri":"opengauss_api_0009.html", "node_id":"en-us_topic_0000001947569461.xml", "product_code":"opengauss", "code":"9", "des":"This section describes the structure of a REST API and how to call an API. Before calling an API, you need to obtain the user token. The obtained token can then be used t", "doc_type":"api", "kw":"Making an API Request,Calling APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Making an API Request", "githuburl":"" }, { "uri":"opengauss_api_0010.html", "node_id":"en-us_topic_0000001917130680.xml", "product_code":"opengauss", "code":"10", "des":"Token authentication must be performed to call APIs.Token-based authentication: Requests are authenticated using a token.The validity period of a token is 24 hours. If a ", "doc_type":"api", "kw":"Authentication,Calling APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Authentication", "githuburl":"" }, { "uri":"opengauss_api_0011.html", "node_id":"en-us_topic_0000001947569801.xml", "product_code":"opengauss", "code":"11", "des":"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", "doc_type":"api", "kw":"Response,Calling APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Response", "githuburl":"" }, { "uri":"opengauss_api_0012.html", "node_id":"en-us_topic_0000001917130760.xml", "product_code":"opengauss", "code":"12", "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", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Using APIs", "githuburl":"" }, { "uri":"opengauss_api_0013.html", "node_id":"en-us_topic_0000001917290496.xml", "product_code":"opengauss", "code":"13", "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":"APIs (Recommended)", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"APIs (Recommended)", "githuburl":"" }, { "uri":"opengauss_api_0014.html", "node_id":"en-us_topic_0000001917290356.xml", "product_code":"opengauss", "code":"14", "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":"Instance Management", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Instance Management", "githuburl":"" }, { "uri":"opengauss_api_0015.html", "node_id":"en-us_topic_0000001917290508.xml", "product_code":"opengauss", "code":"15", "des":"This API is used to create a GaussDB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and ", "doc_type":"api", "kw":"Creating a DB Instance,Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Creating a DB Instance", "githuburl":"" }, { "uri":"opengauss_api_0016.html", "node_id":"en-us_topic_0000001917290492.xml", "product_code":"opengauss", "code":"16", "des":"This API is used to add CNs, add shards, or scale up storage. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the requi", "doc_type":"api", "kw":"Adding CNs, Adding Shards, or Scaling Up Storage,Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Adding CNs, Adding Shards, or Scaling Up Storage", "githuburl":"" }, { "uri":"opengauss_api_0017.html", "node_id":"en-us_topic_0000001917130708.xml", "product_code":"opengauss", "code":"17", "des":"This API is used to delete a DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and endpo", "doc_type":"api", "kw":"Deleting a DB Instance,Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Deleting a DB Instance", "githuburl":"" }, { "uri":"opengauss_api_0018.html", "node_id":"en-us_topic_0000001917130632.xml", "product_code":"opengauss", "code":"18", "des":"This API is used to query instances according to search criteria. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the r", "doc_type":"api", "kw":"Querying DB Instances,Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Querying DB Instances", "githuburl":"" }, { "uri":"opengauss_api_0021.html", "node_id":"en-us_topic_0000001917290428.xml", "product_code":"opengauss", "code":"19", "des":"This API is used to reset a database password. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and ", "doc_type":"api", "kw":"Resetting a Database Password,Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Resetting a Database Password", "githuburl":"" }, { "uri":"opengauss_api_0022.html", "node_id":"en-us_topic_0000001947569645.xml", "product_code":"opengauss", "code":"20", "des":"This API is used to change an instance name. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and en", "doc_type":"api", "kw":"Changing a DB Instance Name,Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Changing a DB Instance Name", "githuburl":"" }, { "uri":"opengauss_newapi_0001.html", "node_id":"en-us_topic_0000001917130696.xml", "product_code":"opengauss", "code":"21", "des":"This API is used to reboot a DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and endpo", "doc_type":"api", "kw":"Rebooting a DB Instance,Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Rebooting a DB Instance", "githuburl":"" }, { "uri":"opengauss_newapi_0029.html", "node_id":"en-us_topic_0000001917130500.xml", "product_code":"opengauss", "code":"22", "des":"This API is used to perform a primary/standby DN switchover for one or more shards. In a shard, only one standby node can be promoted to primary. Before calling this API:", "doc_type":"api", "kw":"Switching Roles of the Primary and Standby DNs in Shards,Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Switching Roles of the Primary and Standby DNs in Shards", "githuburl":"" }, { "uri":"opengauss_newapi_0030.html", "node_id":"en-us_topic_0000001917130628.xml", "product_code":"opengauss", "code":"23", "des":"This API is used to query components of a DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required reg", "doc_type":"api", "kw":"Querying the Components of a DB Instance,Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Querying the Components of a DB Instance", "githuburl":"" }, { "uri":"opengauss_newapi_0031.html", "node_id":"en-us_topic_0000001917290696.xml", "product_code":"opengauss", "code":"24", "des":"This API is used to change the vCPUs and memory of a DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the r", "doc_type":"api", "kw":"Changing vCPUs and Memory of a DB Instance,Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Changing vCPUs and Memory of a DB Instance", "githuburl":"" }, { "uri":"opengauss_api_1037.html", "node_id":"en-us_topic_0000001917290616.xml", "product_code":"", "code":"25", "des":"This API is used to change the port number of a specified DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain ", "doc_type":"", "kw":"Changing the Port Number of a Specified DB Instance,Instance Management,API Reference", "search_title":"", "metedata":[ { } ], "title":"Changing the Port Number of a Specified DB Instance", "githuburl":"" }, { "uri":"opengauss_api_0023.html", "node_id":"en-us_topic_0000001917290584.xml", "product_code":"opengauss", "code":"26", "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", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Parameter Configuration", "githuburl":"" }, { "uri":"opengauss_newapi_0003.html", "node_id":"en-us_topic_0000001947569465.xml", "product_code":"opengauss", "code":"27", "des":"This API is used to obtain parameter templates, including all databases' default and custom parameter templates. Before calling this API:Learn how to authenticate this AP", "doc_type":"api", "kw":"Obtaining Parameter Templates,Parameter Configuration,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Obtaining Parameter Templates", "githuburl":"" }, { "uri":"opengauss_newapi_0004.html", "node_id":"en-us_topic_0000001947569493.xml", "product_code":"opengauss", "code":"28", "des":"This API is used to obtain parameters of a specified DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the r", "doc_type":"api", "kw":"Obtaining the Parameters of a Specified DB Instance,Parameter Configuration,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Obtaining the Parameters of a Specified DB Instance", "githuburl":"" }, { "uri":"opengauss_api_0024.html", "node_id":"en-us_topic_0000001917130688.xml", "product_code":"opengauss", "code":"29", "des":"This API is used to modify parameters in the parameter template of a specified DB instance. Before calling this API:Learn how to authenticate this API.Understand the API ", "doc_type":"api", "kw":"Modifying Parameters of a Specified DB Instance,Parameter Configuration,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Modifying Parameters of a Specified DB Instance", "githuburl":"" }, { "uri":"opengauss_api_0025.html", "node_id":"en-us_topic_0000001947569457.xml", "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":"Backup Management", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Backup Management", "githuburl":"" }, { "uri":"opengauss_api_0026.html", "node_id":"en-us_topic_0000001917290732.xml", "product_code":"opengauss", "code":"31", "des":"This API is used to configure an automated backup policy. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required ", "doc_type":"api", "kw":"Configuring an Automated Backup Policy,Backup Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Configuring an Automated Backup Policy", "githuburl":"" }, { "uri":"opengauss_newapi_0022.html", "node_id":"en-us_topic_0000001947569641.xml", "product_code":"opengauss", "code":"32", "des":"This API is used to query an automated backup policy. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required regi", "doc_type":"api", "kw":"Querying an Automated Backup Policy,Backup Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Querying an Automated Backup Policy", "githuburl":"" }, { "uri":"opengauss_newapi_0023.html", "node_id":"en-us_topic_0000001917290556.xml", "product_code":"opengauss", "code":"33", "des":"This API is used to obtain backups of an instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region ", "doc_type":"api", "kw":"Querying Backups,Backup Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Querying Backups", "githuburl":"" }, { "uri":"opengauss_newapi_0024.html", "node_id":"en-us_topic_0000001947569849.xml", "product_code":"opengauss", "code":"34", "des":"This API is used to create a manual backup. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and end", "doc_type":"api", "kw":"Creating a Manual Backup,Backup Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Creating a Manual Backup", "githuburl":"" }, { "uri":"opengauss_newapi_0025.html", "node_id":"en-us_topic_0000001947569585.xml", "product_code":"opengauss", "code":"35", "des":"This API is used to delete a manual backup. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and end", "doc_type":"api", "kw":"Deleting a Manual Backup,Backup Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Deleting a Manual Backup", "githuburl":"" }, { "uri":"opengauss_newapi_0026.html", "node_id":"en-us_topic_0000001947569481.xml", "product_code":"opengauss", "code":"36", "des":"This API is used to query the restoration time range of an instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain th", "doc_type":"api", "kw":"Querying the Restoration Time Range,Backup Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Querying the Restoration Time Range", "githuburl":"" }, { "uri":"opengauss_newapi_0027.html", "node_id":"en-us_topic_0000001917130460.xml", "product_code":"opengauss", "code":"37", "des":"This API is used to restore data to a new DB instance using backups. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain th", "doc_type":"api", "kw":"Restoring Data to a New DB Instance,Backup Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Restoring Data to a New DB Instance", "githuburl":"" }, { "uri":"opengauss_newapi_0005.html", "node_id":"en-us_topic_0000001947569533.xml", "product_code":"opengauss", "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":"DB Engine Versions and Specifications", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"DB Engine Versions and Specifications", "githuburl":"" }, { "uri":"opengauss_newapi_0006.html", "node_id":"en-us_topic_0000001947569485.xml", "product_code":"opengauss", "code":"39", "des":"This API is used to query DB engine versions supported by a DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtai", "doc_type":"api", "kw":"Querying DB Engine Versions,DB Engine Versions and Specifications,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Querying DB Engine Versions", "githuburl":"" }, { "uri":"opengauss_newapi_0007.html", "node_id":"en-us_topic_0000001917290424.xml", "product_code":"opengauss", "code":"40", "des":"This API is used to query instance specifications. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region ", "doc_type":"api", "kw":"Querying Instance Specifications,DB Engine Versions and Specifications,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Querying Instance Specifications", "githuburl":"" }, { "uri":"opengauss_newapi_0028.html", "node_id":"en-us_topic_0000001917290656.xml", "product_code":"opengauss", "code":"41", "des":"This API is used to query the disk type of a DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required ", "doc_type":"api", "kw":"Querying Database Disk Type,APIs (Recommended),API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Querying Database Disk Type", "githuburl":"" }, { "uri":"opengauss_newapi_0034.html", "node_id":"en-us_topic_0000001917130420.xml", "product_code":"opengauss", "code":"42", "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":"Task Management", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Task Management", "githuburl":"" }, { "uri":"opengauss_newapi_0035.html", "node_id":"en-us_topic_0000001917130832.xml", "product_code":"opengauss", "code":"43", "des":"This API is used to obtain information about a task with a specified ID. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtai", "doc_type":"api", "kw":"Obtaining Task Information,Task Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Obtaining Task Information", "githuburl":"" }, { "uri":"opengauss_newapi_0072.html", "node_id":"en-us_topic_0000001947569857.xml", "product_code":"opengauss", "code":"44", "des":"This API is used to query the tasks in the task center. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required re", "doc_type":"api", "kw":"Querying Tasks,Task Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Querying Tasks", "githuburl":"" }, { "uri":"opengauss_newapi_0073.html", "node_id":"en-us_topic_0000001947569765.xml", "product_code":"opengauss", "code":"45", "des":"This API is used to delete a task record. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and endpo", "doc_type":"api", "kw":"Deleting a Task Record,Task Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Deleting a Task Record", "githuburl":"" }, { "uri":"opengauss_newapi_0036.html", "node_id":"en-us_topic_0000001917130732.xml", "product_code":"opengauss", "code":"46", "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":"Recycle Bin", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Recycle Bin", "githuburl":"" }, { "uri":"opengauss_newapi_0037.html", "node_id":"en-us_topic_0000001917290436.xml", "product_code":"opengauss", "code":"47", "des":"This API is used to modify the recycling policy. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region an", "doc_type":"api", "kw":"Modifying the Recycling Policy,Recycle Bin,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Modifying the Recycling Policy", "githuburl":"" }, { "uri":"opengauss_query_api_version.html", "node_id":"en-us_topic_0000001917130508.xml", "product_code":"", "code":"48", "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":"", "kw":"API Version Query", "search_title":"", "metedata":[ { } ], "title":"API Version Query", "githuburl":"" }, { "uri":"opengauss_query_version_list.html", "node_id":"en-us_topic_0000001917290504.xml", "product_code":"", "code":"49", "des":"This API is used to query the supported API versions. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required regi", "doc_type":"", "kw":"Querying API Versions,API Version Query,API Reference", "search_title":"", "metedata":[ { } ], "title":"Querying API Versions", "githuburl":"" }, { "uri":"opengauss_query_version_info.html", "node_id":"en-us_topic_0000001917130784.xml", "product_code":"", "code":"50", "des":"This API is used to query version information of a specified API. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the r", "doc_type":"", "kw":"Querying Version Information of an API,API Version Query,API Reference", "search_title":"", "metedata":[ { } ], "title":"Querying Version Information of an API", "githuburl":"" }, { "uri":"opengauss_api_1013.html", "node_id":"en-us_topic_0000001917290668.xml", "product_code":"opengauss", "code":"51", "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":"Historical APIs", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Historical APIs", "githuburl":"" }, { "uri":"opengauss_api_1014.html", "node_id":"en-us_topic_0000001917130712.xml", "product_code":"opengauss", "code":"52", "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", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"DB Instance Management", "githuburl":"" }, { "uri":"opengauss_api_1016.html", "node_id":"en-us_topic_0000001917130496.xml", "product_code":"opengauss", "code":"53", "des":"This API is used to scale up storage space of a DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the requir", "doc_type":"api", "kw":"Scaling up Storage Space of a DB Instance,DB Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Scaling up Storage Space of a DB Instance", "githuburl":"" }, { "uri":"opengauss_api_1017.html", "node_id":"en-us_topic_0000001917290420.xml", "product_code":"opengauss", "code":"54", "des":"This API is used to delete a DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and endpo", "doc_type":"api", "kw":"Deleting a DB Instance,DB Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Deleting a DB Instance", "githuburl":"" }, { "uri":"opengauss_api_1019.html", "node_id":"en-us_topic_0000001947569549.xml", "product_code":"opengauss", "code":"55", "des":"This API is used to add CNs.Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and endpoint.The CN growth increment ranges fro", "doc_type":"api", "kw":"Adding CNs,DB Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Adding CNs", "githuburl":"" }, { "uri":"opengauss_api_1020.html", "node_id":"en-us_topic_0000001947569473.xml", "product_code":"opengauss", "code":"56", "des":"This API is used to add shards.Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and endpoint.Intermittent disconnection occu", "doc_type":"api", "kw":"Adding Shards,DB Instance Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Adding Shards", "githuburl":"" }, { "uri":"opengauss_api_1023.html", "node_id":"en-us_topic_0000001917290400.xml", "product_code":"opengauss", "code":"57", "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", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Parameter Configuration", "githuburl":"" }, { "uri":"opengauss_api_1024.html", "node_id":"en-us_topic_0000001917290728.xml", "product_code":"opengauss", "code":"58", "des":"This API is used to modify parameters in the parameter template of a specified DB instance. Before calling this API:Learn how to authenticate this API.Understand the API ", "doc_type":"api", "kw":"Modifying Parameters of a Specified DB Instance,Parameter Configuration,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Modifying Parameters of a Specified DB Instance", "githuburl":"" }, { "uri":"opengauss_api_0030.html", "node_id":"en-us_topic_0000001947569769.xml", "product_code":"opengauss", "code":"59", "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", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Appendix", "githuburl":"" }, { "uri":"opengauss_api_0031.html", "node_id":"en-us_topic_0000001917290524.xml", "product_code":"opengauss", "code":"60", "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", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Abnormal Request Results", "githuburl":"" }, { "uri":"opengauss_api_0032.html", "node_id":"en-us_topic_0000001917130452.xml", "product_code":"opengauss", "code":"61", "des":"Table 1 describes status codes.", "doc_type":"api", "kw":"Status Codes,Appendix,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Status Codes", "githuburl":"" }, { "uri":"opengauss_api_0033.html", "node_id":"en-us_topic_0000001947569625.xml", "product_code":"opengauss", "code":"62", "des":"The following table describes error codes.", "doc_type":"api", "kw":"Error Codes,Appendix,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Error Codes", "githuburl":"" }, { "uri":"opengauss_api_0034.html", "node_id":"en-us_topic_0000001917130752.xml", "product_code":"opengauss", "code":"63", "des":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID using either of the following methods:Obtaining the Projec", "doc_type":"api", "kw":"Obtaining a Project ID,Appendix,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Obtaining a Project ID", "githuburl":"" }, { "uri":"opengauss_api_0036.html", "node_id":"en-us_topic_0000001917290632.xml", "product_code":"opengauss", "code":"64", "des":"Replication mode table", "doc_type":"api", "kw":"Replication Mode Table,Appendix,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Replication Mode Table", "githuburl":"" }, { "uri":"opengauss_api_0037.html", "node_id":"en-us_topic_0000001917130736.xml", "product_code":"opengauss", "code":"65", "des":"This section describes the GaussDB instance specifications.", "doc_type":"api", "kw":"DB Instance Specifications,Appendix,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"DB Instance Specifications", "githuburl":"" }, { "uri":"opengauss_api_0038.html", "node_id":"en-us_topic_0000001917290528.xml", "product_code":"opengauss", "code":"66", "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", "IsMulti":"No", "prodname":"opengauss;rds", "opensource":"true", "IsBot":"Yes" } ], "title":"Change History", "githuburl":"" } ]