diff --git a/docs/taurusdb/api-ref/ALL_META.TXT.json b/docs/taurusdb/api-ref/ALL_META.TXT.json index 21a61c0ce..ba261d207 100644 --- a/docs/taurusdb/api-ref/ALL_META.TXT.json +++ b/docs/taurusdb/api-ref/ALL_META.TXT.json @@ -43,7 +43,7 @@ "node_id":"gaussdb_00_0002.xml", "product_code":"taurusdb", "code":"3", - "des":"TaurusDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see API Usage Guidelines.", + "des":"TaurusDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", "doc_type":"api", "kw":"API Calling,Before You Start,API Reference", "search_title":"", @@ -135,7 +135,7 @@ "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 Usage Guidelines", + "kw":"Calling APIs", "search_title":"", "metedata":[ { @@ -143,7 +143,7 @@ "prodname":"taurusdb" } ], - "title":"API Usage Guidelines", + "title":"Calling APIs", "githuburl":"" }, { @@ -153,7 +153,7 @@ "code":"9", "des":"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", "doc_type":"api", - "kw":"Making an API Request,API Usage Guidelines,API Reference", + "kw":"Making an API Request,Calling APIs,API Reference", "search_title":"", "metedata":[ { @@ -171,7 +171,7 @@ "code":"10", "des":"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", "doc_type":"api", - "kw":"Authentication,API Usage Guidelines,API Reference", + "kw":"Authentication,Calling APIs,API Reference", "search_title":"", "metedata":[ { @@ -189,7 +189,7 @@ "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,API Usage Guidelines,API Reference", + "kw":"Response,Calling APIs,API Reference", "search_title":"", "metedata":[ { @@ -704,11 +704,29 @@ "title":"Obtaining Parameter Information of a Specified DB Instance", "githuburl":"" }, + { + "uri":"UpdateInstanceConfigurations.html", + "node_id":"updateinstanceconfigurations.xml", + "product_code":"taurusdb", + "code":"40", + "des":"This API is used to modify parameters of a specified instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.", + "doc_type":"api", + "kw":"Modifying Parameters of a Specified Instance,Parameter Template Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Modifying Parameters of a Specified Instance", + "githuburl":"" + }, { "uri":"gaussdb_04_0010.html", "node_id":"gaussdb_04_0010.xml", "product_code":"taurusdb", - "code":"40", + "code":"41", "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":"Quota Management", @@ -726,7 +744,7 @@ "uri":"gaussdb_04_0011.html", "node_id":"gaussdb_04_0011.xml", "product_code":"taurusdb", - "code":"41", + "code":"42", "des":"This API is used to obtain the resource quotas of a specified enterprise project. Before using this API:Learn how to authorize and authenticate it.Obtain the required reg", "doc_type":"api", "kw":"Querying Resource Quotas,Quota Management,API Reference", @@ -744,7 +762,7 @@ "uri":"gaussdb_04_0012.html", "node_id":"gaussdb_04_0012.xml", "product_code":"taurusdb", - "code":"42", + "code":"43", "des":"This API is used to configure resource quotas for a specified enterprise project. Before using this API:Learn how to authorize and authenticate it.Obtain the required reg", "doc_type":"api", "kw":"Configuring Resource Quotas,Quota Management,API Reference", @@ -762,7 +780,7 @@ "uri":"gaussdb_04_0013.html", "node_id":"gaussdb_04_0013.xml", "product_code":"taurusdb", - "code":"43", + "code":"44", "des":"This API is used to modify the resource quota of a specified enterprise project.Learn how to authorize and authenticate it.Obtain the required region and endpoint.Before ", "doc_type":"api", "kw":"Modifying Resource Quotas,Quota Management,API Reference", @@ -780,7 +798,7 @@ "uri":"ShowGaussMySqlProjectQuotas.html", "node_id":"showgaussmysqlprojectquotas.xml", "product_code":"taurusdb", - "code":"44", + "code":"45", "des":"This API is used to obtain the resource quotas of a specified tenant. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endp", "doc_type":"api", "kw":"Querying the DB Instance Quotas of a Tenant,Quota Management,API Reference", @@ -798,7 +816,7 @@ "uri":"topic_300000006.html", "node_id":"topic_300000006.xml", "product_code":"taurusdb", - "code":"45", + "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":"Database Proxy", @@ -816,7 +834,7 @@ "uri":"CreateGaussMySqlProxy.html", "node_id":"creategaussmysqlproxy.xml", "product_code":"taurusdb", - "code":"46", + "code":"47", "des":"This API is used to enable database proxy in ELB mode. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/{", "doc_type":"api", "kw":"Enabling Database Proxy,Database Proxy,API Reference", @@ -834,7 +852,7 @@ "uri":"DeleteGaussMySqlProxy.html", "node_id":"deletegaussmysqlproxy.xml", "product_code":"taurusdb", - "code":"47", + "code":"48", "des":"This API is used to disable database proxy. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.Database proxy is una", "doc_type":"api", "kw":"Disabling Database Proxy,Database Proxy,API Reference", @@ -852,7 +870,7 @@ "uri":"ShowGaussMySqlProxyList.html", "node_id":"showgaussmysqlproxylist.xml", "product_code":"taurusdb", - "code":"48", + "code":"49", "des":"This API is used to query database proxy instances. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.Database pr", "doc_type":"api", "kw":"Querying Database Proxy Instances,Database Proxy,API Reference", @@ -870,7 +888,7 @@ "uri":"ShowGaussMySqlProxyFlavors.html", "node_id":"showgaussmysqlproxyflavors.xml", "product_code":"taurusdb", - "code":"49", + "code":"50", "des":"This API is used to query database proxy specifications. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.Database", "doc_type":"api", "kw":"Querying Database Proxy Specifications,Database Proxy,API Reference", @@ -888,7 +906,7 @@ "uri":"ExpandGaussMySqlProxy.html", "node_id":"expandgaussmysqlproxy.xml", "product_code":"taurusdb", - "code":"50", + "code":"51", "des":"This API is used to add database proxy nodes.Learn how to authorize and authenticate it.Obtain the required region and endpoint.Database proxy is unavailable for DB insta", "doc_type":"api", "kw":"Adding Database Proxy Nodes,Database Proxy,API Reference", @@ -906,7 +924,7 @@ "uri":"ChangeGaussMySqlProxySpecification.html", "node_id":"changegaussmysqlproxyspecification.xml", "product_code":"taurusdb", - "code":"51", + "code":"52", "des":"This API is used to change specifications of a database proxy instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and ", "doc_type":"api", "kw":"Changing Specifications of a Database Proxy Instance,Database Proxy,API Reference", @@ -924,7 +942,7 @@ "uri":"SetGaussMySqlProxyWeight.html", "node_id":"setgaussmysqlproxyweight.xml", "product_code":"taurusdb", - "code":"52", + "code":"53", "des":"This API is used to assign read weights for nodes. Being using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.PUT /v3/{projec", "doc_type":"api", "kw":"Assigning Read Weights,Database Proxy,API Reference", @@ -942,7 +960,7 @@ "uri":"topic_300000007.html", "node_id":"topic_300000007.xml", "product_code":"taurusdb", - "code":"53", + "code":"54", "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":"Log Management", @@ -960,7 +978,7 @@ "uri":"ListGaussMySqlErrorLog.html", "node_id":"listgaussmysqlerrorlog.xml", "product_code":"taurusdb", - "code":"54", + "code":"55", "des":"This API is used to query database error logs. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /v3/{project_i", "doc_type":"api", "kw":"Querying Database Error Logs,Log Management,API Reference", @@ -978,7 +996,7 @@ "uri":"ListGaussMySqlSlowLog.html", "node_id":"listgaussmysqlslowlog.xml", "product_code":"taurusdb", - "code":"55", + "code":"56", "des":"This API is used to query database slow logs. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /v3/{project_id", "doc_type":"api", "kw":"Querying Database Slow Logs,Log Management,API Reference", @@ -996,7 +1014,7 @@ "uri":"topic_300000009.html", "node_id":"topic_300000009.xml", "product_code":"taurusdb", - "code":"56", + "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":"Tag Management", @@ -1014,7 +1032,7 @@ "uri":"ListInstanceTags.html", "node_id":"listinstancetags.xml", "product_code":"taurusdb", - "code":"57", + "code":"58", "des":"This API is used to query tags of a specified instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /v3", "doc_type":"api", "kw":"Querying Resource Tags,Tag Management,API Reference", @@ -1032,7 +1050,7 @@ "uri":"ListProjectTags.html", "node_id":"listprojecttags.xml", "product_code":"taurusdb", - "code":"58", + "code":"59", "des":"This API is used to query all tags of instances in a specified project. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and en", "doc_type":"api", "kw":"Querying Project Tags,Tag Management,API Reference", @@ -1050,7 +1068,7 @@ "uri":"BatchTagAction.html", "node_id":"batchtagaction.xml", "product_code":"taurusdb", - "code":"59", + "code":"60", "des":"This API is used to add tags to or delete tags from a specified DB instance in batches. Before calling this API:Learn how to authorize and authenticate it.Obtain the requ", "doc_type":"api", "kw":"Adding or Deleting Tags in Batches,Tag Management,API Reference", @@ -1068,10 +1086,10 @@ "uri":"topic_300000012.html", "node_id":"topic_300000012.xml", "product_code":"taurusdb", - "code":"60", + "code":"61", "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":"SQL Statement Concurrency Control", + "kw":"SQL Throttling", "search_title":"", "metedata":[ { @@ -1079,17 +1097,17 @@ "prodname":"taurusdb" } ], - "title":"SQL Statement Concurrency Control", + "title":"SQL Throttling", "githuburl":"" }, { "uri":"UpdateSqlFilterControl.html", "node_id":"updatesqlfiltercontrol.xml", "product_code":"taurusdb", - "code":"61", - "des":"This API is used to enable or disable SQL Statement Concurrency Control. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and", + "code":"62", + "des":"This API is used to enable or disable SQL Throttling. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/", "doc_type":"api", - "kw":"Enabling or Disabling SQL Statement Concurrency Control,SQL Statement Concurrency Control,API Refere", + "kw":"Enabling or Disabling SQL Throttling,SQL Throttling,API Reference", "search_title":"", "metedata":[ { @@ -1097,17 +1115,17 @@ "prodname":"taurusdb" } ], - "title":"Enabling or Disabling SQL Statement Concurrency Control", + "title":"Enabling or Disabling SQL Throttling", "githuburl":"" }, { "uri":"ShowSqlFilterControl.html", "node_id":"showsqlfiltercontrol.xml", "product_code":"taurusdb", - "code":"62", - "des":"This API is used to query whether SQL Statement Concurrency Control is enabled. Before calling this API:Learn how to authorize and authenticate it.Obtain the required reg", + "code":"63", + "des":"This API is used to query whether SQL Throttling is enabled. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GE", "doc_type":"api", - "kw":"Querying Whether SQL Statement Concurrency Control Is Enabled,SQL Statement Concurrency Control,API ", + "kw":"Querying Whether SQL Throttling Is Enabled,SQL Throttling,API Reference", "search_title":"", "metedata":[ { @@ -1115,17 +1133,17 @@ "prodname":"taurusdb" } ], - "title":"Querying Whether SQL Statement Concurrency Control Is Enabled", + "title":"Querying Whether SQL Throttling Is Enabled", "githuburl":"" }, { "uri":"SetSqlFilterRule.html", "node_id":"setsqlfilterrule.xml", "product_code":"taurusdb", - "code":"63", - "des":"This API is used to configure concurrency control rules of SQL statements. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region a", + "code":"64", + "des":"This API is used to configure SQL throttling rules. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.PUT /v3/{pr", "doc_type":"api", - "kw":"Configuring Concurrency Control Rules of SQL Statements,SQL Statement Concurrency Control,API Refere", + "kw":"Configuring SQL Throttling Rules,SQL Throttling,API Reference", "search_title":"", "metedata":[ { @@ -1133,17 +1151,17 @@ "prodname":"taurusdb" } ], - "title":"Configuring Concurrency Control Rules of SQL Statements", + "title":"Configuring SQL Throttling Rules", "githuburl":"" }, { "uri":"ShowSqlFilterRule.html", "node_id":"showsqlfilterrule.xml", "product_code":"taurusdb", - "code":"64", - "des":"This API is used to query concurrency control rules of SQL statements. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and e", + "code":"65", + "des":"This API is used to query SQL throttling rules. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /v3/{projec", "doc_type":"api", - "kw":"Querying Concurrency Control Rules of SQL Statements,SQL Statement Concurrency Control,API Reference", + "kw":"Querying SQL Throttling Rules,SQL Throttling,API Reference", "search_title":"", "metedata":[ { @@ -1151,17 +1169,17 @@ "prodname":"taurusdb" } ], - "title":"Querying Concurrency Control Rules of SQL Statements", + "title":"Querying SQL Throttling Rules", "githuburl":"" }, { "uri":"DeleteSqlFilterRule.html", "node_id":"deletesqlfilterrule.xml", "product_code":"taurusdb", - "code":"65", - "des":"This API is used to delete concurrency control rules of SQL statements. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and ", + "code":"66", + "des":"This API is used to delete SQL throttling rules. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.DELETE /v3/{pr", "doc_type":"api", - "kw":"Deleting Concurrency Control Rules of SQL Statements,SQL Statement Concurrency Control,API Reference", + "kw":"Deleting SQL Throttling Rules,SQL Throttling,API Reference", "search_title":"", "metedata":[ { @@ -1169,14 +1187,14 @@ "prodname":"taurusdb" } ], - "title":"Deleting Concurrency Control Rules of SQL Statements", + "title":"Deleting SQL Throttling Rules", "githuburl":"" }, { "uri":"gaussdb_04_0014.html", "node_id":"gaussdb_04_0014.xml", "product_code":"taurusdb", - "code":"66", + "code":"67", "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 Center", @@ -1194,7 +1212,7 @@ "uri":"ShowGaussMySqlJobInfo.html", "node_id":"showgaussmysqljobinfo.xml", "product_code":"taurusdb", - "code":"67", + "code":"68", "des":"This API is used to obtain information about a TaurusDB task with a specified ID in the task center. Before calling this API:Learn how to authorize and authenticate it.Ob", "doc_type":"api", "kw":"Obtaining Information About a Task with a Specified ID,Task Center,API Reference", @@ -1212,7 +1230,7 @@ "uri":"gaussdb_11_0000.html", "node_id":"gaussdb_11_0000.xml", "product_code":"taurusdb", - "code":"68", + "code":"69", "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 (Unavailable Soon)", @@ -1230,7 +1248,7 @@ "uri":"gaussdb_11_0001.html", "node_id":"gaussdb_11_0001.xml", "product_code":"taurusdb", - "code":"69", + "code":"70", "des":"This API is used to query the version information of a specified DB engine. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region ", "doc_type":"api", "kw":"Querying Version Information About a DB Engine,APIs (Unavailable Soon),API Reference", @@ -1248,7 +1266,7 @@ "uri":"gaussdb_11_0002.html", "node_id":"gaussdb_11_0002.xml", "product_code":"taurusdb", - "code":"70", + "code":"71", "des":"This API is used to query the database specifications of a specified DB engine version. Before calling this API:Learn how to authorize and authenticate it.Obtain the requ", "doc_type":"api", "kw":"Querying Database Specifications,APIs (Unavailable Soon),API Reference", @@ -1266,7 +1284,7 @@ "uri":"gaussdb_11_0003.html", "node_id":"gaussdb_11_0003.xml", "product_code":"taurusdb", - "code":"71", + "code":"72", "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", @@ -1284,7 +1302,7 @@ "uri":"gaussdb_11_0004.html", "node_id":"gaussdb_11_0004.xml", "product_code":"taurusdb", - "code":"72", + "code":"73", "des":"This API is used to create a DB instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPOST https:", "doc_type":"api", "kw":"Creating a DB Instance,Instance Management,API Reference", @@ -1302,7 +1320,7 @@ "uri":"gaussdb_11_0005.html", "node_id":"gaussdb_11_0005.xml", "product_code":"taurusdb", - "code":"73", + "code":"74", "des":"This API is used to query instances according to search criteria. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoi", "doc_type":"api", "kw":"Querying DB Instances,Instance Management,API Reference", @@ -1320,7 +1338,7 @@ "uri":"gaussdb_11_0006.html", "node_id":"gaussdb_11_0006.xml", "product_code":"taurusdb", - "code":"74", + "code":"75", "des":"This API is used to query the details of a specified DB instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoi", "doc_type":"api", "kw":"Querying Details of a DB Instance,Instance Management,API Reference", @@ -1338,7 +1356,7 @@ "uri":"gaussdb_11_0007.html", "node_id":"gaussdb_11_0007.xml", "product_code":"taurusdb", - "code":"75", + "code":"76", "des":"This API is used to delete a DB instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatDELETE http", "doc_type":"api", "kw":"Deleting a DB Instance,Instance Management,API Reference", @@ -1356,7 +1374,7 @@ "uri":"gaussdb_11_0015.html", "node_id":"gaussdb_11_0015.xml", "product_code":"taurusdb", - "code":"76", + "code":"77", "des":"This API is used to create a read replica. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPOST https", "doc_type":"api", "kw":"Creating a Read Replica,Instance Management,API Reference", @@ -1374,7 +1392,7 @@ "uri":"gaussdb_11_0016.html", "node_id":"gaussdb_11_0016.xml", "product_code":"taurusdb", - "code":"77", + "code":"78", "des":"This API is used to delete a read replica. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatDELETE htt", "doc_type":"api", "kw":"Deleting a Read Replica,Instance Management,API Reference", @@ -1392,7 +1410,7 @@ "uri":"gaussdb_11_0018.html", "node_id":"gaussdb_11_0018.xml", "product_code":"taurusdb", - "code":"78", + "code":"79", "des":"This API is used to change a DB instance name. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPUT ht", "doc_type":"api", "kw":"Changing a DB Instance Name,Instance Management,API Reference", @@ -1410,7 +1428,7 @@ "uri":"gaussdb_11_0019.html", "node_id":"gaussdb_11_0019.xml", "product_code":"taurusdb", - "code":"79", + "code":"80", "des":"This API is used to reset a database password. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPOST h", "doc_type":"api", "kw":"Resetting a Database Password,Instance Management,API Reference", @@ -1428,7 +1446,7 @@ "uri":"gaussdb_11_0020.html", "node_id":"gaussdb_11_0020.xml", "product_code":"taurusdb", - "code":"80", + "code":"81", "des":"This API is used to change DB instance specifications. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI form", "doc_type":"api", "kw":"Changing DB Instance Specifications,Instance Management,API Reference", @@ -1446,7 +1464,7 @@ "uri":"gaussdb_11_0021.html", "node_id":"gaussdb_11_0021.xml", "product_code":"taurusdb", - "code":"81", + "code":"82", "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", @@ -1464,7 +1482,7 @@ "uri":"gaussdb_11_0022.html", "node_id":"gaussdb_11_0022.xml", "product_code":"taurusdb", - "code":"82", + "code":"83", "des":"This API is used to create a manual backup. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPOST http", "doc_type":"api", "kw":"Creating a Manual Backup,Backup Management,API Reference", @@ -1482,7 +1500,7 @@ "uri":"gaussdb_11_0023.html", "node_id":"gaussdb_11_0023.xml", "product_code":"taurusdb", - "code":"83", + "code":"84", "des":"This API is used to query backups according to search criteria. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint", "doc_type":"api", "kw":"Querying Backups,Backup Management,API Reference", @@ -1500,7 +1518,7 @@ "uri":"gaussdb_11_0024.html", "node_id":"gaussdb_11_0024.xml", "product_code":"taurusdb", - "code":"84", + "code":"85", "des":"This API is used to query an automated backup policy. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI forma", "doc_type":"api", "kw":"Querying an Automated Backup Policy,Backup Management,API Reference", @@ -1518,7 +1536,7 @@ "uri":"gaussdb_11_0025.html", "node_id":"gaussdb_11_0025.xml", "product_code":"taurusdb", - "code":"85", + "code":"86", "des":"This API is used to modify the backup policy. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPUT htt", "doc_type":"api", "kw":"Modifying the Backup Policy,Backup Management,API Reference", @@ -1536,7 +1554,7 @@ "uri":"gaussdb_11_0026.html", "node_id":"gaussdb_11_0026.xml", "product_code":"taurusdb", - "code":"86", + "code":"87", "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 Template Management", @@ -1554,7 +1572,7 @@ "uri":"gaussdb_11_0027.html", "node_id":"gaussdb_11_0027.xml", "product_code":"taurusdb", - "code":"87", + "code":"88", "des":"This API is used to obtain parameter templates, including all databases' default and custom parameter templates. Before calling this API:Learn how to authorize and authen", "doc_type":"api", "kw":"Querying Parameter Templates,Parameter Template Management,API Reference", @@ -1572,7 +1590,7 @@ "uri":"gaussdb_11_0028.html", "node_id":"gaussdb_11_0028.xml", "product_code":"taurusdb", - "code":"88", + "code":"89", "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":"Quota Management", @@ -1590,7 +1608,7 @@ "uri":"gaussdb_11_0029.html", "node_id":"gaussdb_11_0029.xml", "product_code":"taurusdb", - "code":"89", + "code":"90", "des":"This API is used to obtain the resource quotas of a specified enterprise project. Before calling this API:Learn how to authorize and authenticate it.Obtain the required r", "doc_type":"api", "kw":"Querying Enterprise Project Resource Quotas of a Tenant,Quota Management,API Reference", @@ -1608,7 +1626,7 @@ "uri":"gaussdb_11_0030.html", "node_id":"gaussdb_11_0030.xml", "product_code":"taurusdb", - "code":"90", + "code":"91", "des":"This API is used to configure resource quotas for a specified enterprise project. Before calling this API:Learn how to authorize and authenticate it.Obtain the required r", "doc_type":"api", "kw":"Configuring Enterprise Project Resource Quotas of a Tenant,Quota Management,API Reference", @@ -1626,7 +1644,7 @@ "uri":"gaussdb_11_0031.html", "node_id":"gaussdb_11_0031.xml", "product_code":"taurusdb", - "code":"91", + "code":"92", "des":"This API is used to modify the resource quotas of a specified enterprise project. Before calling this API:Learn how to authorize and authenticate it.Obtain the required r", "doc_type":"api", "kw":"Modifying Enterprise Project Resource Quotas of a Tenant,Quota Management,API Reference", @@ -1644,7 +1662,7 @@ "uri":"gaussdb_11_0032.html", "node_id":"gaussdb_11_0032.xml", "product_code":"taurusdb", - "code":"92", + "code":"93", "des":"This API is used to obtain information about a TaurusDB task with a specified ID in the task center. Before calling this API:Learn how to authorize and authenticate it.Ob", "doc_type":"api", "kw":"Obtaining Information About a Task with a Specified ID,APIs (Unavailable Soon),API Reference", @@ -1662,7 +1680,7 @@ "uri":"gaussdb_10_0000.html", "node_id":"gaussdb_10_0000.xml", "product_code":"taurusdb", - "code":"93", + "code":"94", "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", @@ -1680,7 +1698,7 @@ "uri":"gaussdb_10_0001.html", "node_id":"gaussdb_10_0001.xml", "product_code":"taurusdb", - "code":"94", + "code":"95", "des":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringReturned error code when a task submission exception occurs. For details, see", "doc_type":"api", "kw":"Abnormal Request Results,Appendix,API Reference", @@ -1698,7 +1716,7 @@ "uri":"gaussdb_10_0002.html", "node_id":"gaussdb_10_0002.xml", "product_code":"taurusdb", - "code":"95", + "code":"96", "des":"The following table describes status codes.", "doc_type":"api", "kw":"Status Codes,Appendix,API Reference", @@ -1716,7 +1734,7 @@ "uri":"gaussdb_10_0003.html", "node_id":"gaussdb_10_0003.xml", "product_code":"taurusdb", - "code":"96", + "code":"97", "des":"The following table describes error codes.", "doc_type":"api", "kw":"Error Codes,Appendix,API Reference", @@ -1734,7 +1752,7 @@ "uri":"gaussdb_10_0004.html", "node_id":"gaussdb_10_0004.xml", "product_code":"taurusdb", - "code":"97", + "code":"98", "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. Two methods are available:Obtaining the Project ID ", "doc_type":"api", "kw":"Obtaining a Project ID,Appendix,API Reference", @@ -1752,7 +1770,7 @@ "uri":"gaussdb_10_0006.html", "node_id":"gaussdb_10_0006.xml", "product_code":"taurusdb", - "code":"98", + "code":"99", "des":"This section describes namespaces, descriptions, and dimensions of metrics to be reported to Cloud Eye. You can use APIs provided by Cloud Eye to retrieve metrics and ala", "doc_type":"api", "kw":"TaurusDB Metrics,Appendix,API Reference", @@ -1770,7 +1788,7 @@ "uri":"changeHistory.html", "node_id":"changehistory.xml", "product_code":"taurusdb", - "code":"99", + "code":"100", "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", diff --git a/docs/taurusdb/api-ref/CLASS.TXT.json b/docs/taurusdb/api-ref/CLASS.TXT.json index d43caf1b4..0259d63e7 100644 --- a/docs/taurusdb/api-ref/CLASS.TXT.json +++ b/docs/taurusdb/api-ref/CLASS.TXT.json @@ -18,7 +18,7 @@ "code":"2" }, { - "desc":"TaurusDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see API Usage Guidelines.", + "desc":"TaurusDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", "product_code":"taurusdb", "title":"API Calling", "uri":"gaussdb_00_0002.html", @@ -65,7 +65,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":"taurusdb", - "title":"API Usage Guidelines", + "title":"Calling APIs", "uri":"gaussdb_03_0000.html", "doc_type":"api", "p_code":"", @@ -350,6 +350,15 @@ "p_code":"37", "code":"39" }, + { + "desc":"This API is used to modify parameters of a specified instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.", + "product_code":"taurusdb", + "title":"Modifying Parameters of a Specified Instance", + "uri":"UpdateInstanceConfigurations.html", + "doc_type":"api", + "p_code":"37", + "code":"40" + }, { "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":"taurusdb", @@ -357,7 +366,7 @@ "uri":"gaussdb_04_0010.html", "doc_type":"api", "p_code":"12", - "code":"40" + "code":"41" }, { "desc":"This API is used to obtain the resource quotas of a specified enterprise project. Before using this API:Learn how to authorize and authenticate it.Obtain the required reg", @@ -365,8 +374,8 @@ "title":"Querying Resource Quotas", "uri":"gaussdb_04_0011.html", "doc_type":"api", - "p_code":"40", - "code":"41" + "p_code":"41", + "code":"42" }, { "desc":"This API is used to configure resource quotas for a specified enterprise project. Before using this API:Learn how to authorize and authenticate it.Obtain the required reg", @@ -374,8 +383,8 @@ "title":"Configuring Resource Quotas", "uri":"gaussdb_04_0012.html", "doc_type":"api", - "p_code":"40", - "code":"42" + "p_code":"41", + "code":"43" }, { "desc":"This API is used to modify the resource quota of a specified enterprise project.Learn how to authorize and authenticate it.Obtain the required region and endpoint.Before ", @@ -383,8 +392,8 @@ "title":"Modifying Resource Quotas", "uri":"gaussdb_04_0013.html", "doc_type":"api", - "p_code":"40", - "code":"43" + "p_code":"41", + "code":"44" }, { "desc":"This API is used to obtain the resource quotas of a specified tenant. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endp", @@ -392,8 +401,8 @@ "title":"Querying the DB Instance Quotas of a Tenant", "uri":"ShowGaussMySqlProjectQuotas.html", "doc_type":"api", - "p_code":"40", - "code":"44" + "p_code":"41", + "code":"45" }, { "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.", @@ -402,7 +411,7 @@ "uri":"topic_300000006.html", "doc_type":"api", "p_code":"12", - "code":"45" + "code":"46" }, { "desc":"This API is used to enable database proxy in ELB mode. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/{", @@ -410,8 +419,8 @@ "title":"Enabling Database Proxy", "uri":"CreateGaussMySqlProxy.html", "doc_type":"api", - "p_code":"45", - "code":"46" + "p_code":"46", + "code":"47" }, { "desc":"This API is used to disable database proxy. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.Database proxy is una", @@ -419,8 +428,8 @@ "title":"Disabling Database Proxy", "uri":"DeleteGaussMySqlProxy.html", "doc_type":"api", - "p_code":"45", - "code":"47" + "p_code":"46", + "code":"48" }, { "desc":"This API is used to query database proxy instances. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.Database pr", @@ -428,8 +437,8 @@ "title":"Querying Database Proxy Instances", "uri":"ShowGaussMySqlProxyList.html", "doc_type":"api", - "p_code":"45", - "code":"48" + "p_code":"46", + "code":"49" }, { "desc":"This API is used to query database proxy specifications. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.Database", @@ -437,8 +446,8 @@ "title":"Querying Database Proxy Specifications", "uri":"ShowGaussMySqlProxyFlavors.html", "doc_type":"api", - "p_code":"45", - "code":"49" + "p_code":"46", + "code":"50" }, { "desc":"This API is used to add database proxy nodes.Learn how to authorize and authenticate it.Obtain the required region and endpoint.Database proxy is unavailable for DB insta", @@ -446,8 +455,8 @@ "title":"Adding Database Proxy Nodes", "uri":"ExpandGaussMySqlProxy.html", "doc_type":"api", - "p_code":"45", - "code":"50" + "p_code":"46", + "code":"51" }, { "desc":"This API is used to change specifications of a database proxy instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and ", @@ -455,8 +464,8 @@ "title":"Changing Specifications of a Database Proxy Instance", "uri":"ChangeGaussMySqlProxySpecification.html", "doc_type":"api", - "p_code":"45", - "code":"51" + "p_code":"46", + "code":"52" }, { "desc":"This API is used to assign read weights for nodes. Being using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.PUT /v3/{projec", @@ -464,8 +473,8 @@ "title":"Assigning Read Weights", "uri":"SetGaussMySqlProxyWeight.html", "doc_type":"api", - "p_code":"45", - "code":"52" + "p_code":"46", + "code":"53" }, { "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.", @@ -474,7 +483,7 @@ "uri":"topic_300000007.html", "doc_type":"api", "p_code":"12", - "code":"53" + "code":"54" }, { "desc":"This API is used to query database error logs. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /v3/{project_i", @@ -482,8 +491,8 @@ "title":"Querying Database Error Logs", "uri":"ListGaussMySqlErrorLog.html", "doc_type":"api", - "p_code":"53", - "code":"54" + "p_code":"54", + "code":"55" }, { "desc":"This API is used to query database slow logs. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /v3/{project_id", @@ -491,8 +500,8 @@ "title":"Querying Database Slow Logs", "uri":"ListGaussMySqlSlowLog.html", "doc_type":"api", - "p_code":"53", - "code":"55" + "p_code":"54", + "code":"56" }, { "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.", @@ -501,7 +510,7 @@ "uri":"topic_300000009.html", "doc_type":"api", "p_code":"12", - "code":"56" + "code":"57" }, { "desc":"This API is used to query tags of a specified instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /v3", @@ -509,8 +518,8 @@ "title":"Querying Resource Tags", "uri":"ListInstanceTags.html", "doc_type":"api", - "p_code":"56", - "code":"57" + "p_code":"57", + "code":"58" }, { "desc":"This API is used to query all tags of instances in a specified project. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and en", @@ -518,8 +527,8 @@ "title":"Querying Project Tags", "uri":"ListProjectTags.html", "doc_type":"api", - "p_code":"56", - "code":"58" + "p_code":"57", + "code":"59" }, { "desc":"This API is used to add tags to or delete tags from a specified DB instance in batches. Before calling this API:Learn how to authorize and authenticate it.Obtain the requ", @@ -527,62 +536,62 @@ "title":"Adding or Deleting Tags in Batches", "uri":"BatchTagAction.html", "doc_type":"api", - "p_code":"56", - "code":"59" + "p_code":"57", + "code":"60" }, { "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":"taurusdb", - "title":"SQL Statement Concurrency Control", + "title":"SQL Throttling", "uri":"topic_300000012.html", "doc_type":"api", "p_code":"12", - "code":"60" - }, - { - "desc":"This API is used to enable or disable SQL Statement Concurrency Control. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and", - "product_code":"taurusdb", - "title":"Enabling or Disabling SQL Statement Concurrency Control", - "uri":"UpdateSqlFilterControl.html", - "doc_type":"api", - "p_code":"60", "code":"61" }, { - "desc":"This API is used to query whether SQL Statement Concurrency Control is enabled. Before calling this API:Learn how to authorize and authenticate it.Obtain the required reg", + "desc":"This API is used to enable or disable SQL Throttling. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/", "product_code":"taurusdb", - "title":"Querying Whether SQL Statement Concurrency Control Is Enabled", - "uri":"ShowSqlFilterControl.html", + "title":"Enabling or Disabling SQL Throttling", + "uri":"UpdateSqlFilterControl.html", "doc_type":"api", - "p_code":"60", + "p_code":"61", "code":"62" }, { - "desc":"This API is used to configure concurrency control rules of SQL statements. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region a", + "desc":"This API is used to query whether SQL Throttling is enabled. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GE", "product_code":"taurusdb", - "title":"Configuring Concurrency Control Rules of SQL Statements", - "uri":"SetSqlFilterRule.html", + "title":"Querying Whether SQL Throttling Is Enabled", + "uri":"ShowSqlFilterControl.html", "doc_type":"api", - "p_code":"60", + "p_code":"61", "code":"63" }, { - "desc":"This API is used to query concurrency control rules of SQL statements. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and e", + "desc":"This API is used to configure SQL throttling rules. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.PUT /v3/{pr", "product_code":"taurusdb", - "title":"Querying Concurrency Control Rules of SQL Statements", - "uri":"ShowSqlFilterRule.html", + "title":"Configuring SQL Throttling Rules", + "uri":"SetSqlFilterRule.html", "doc_type":"api", - "p_code":"60", + "p_code":"61", "code":"64" }, { - "desc":"This API is used to delete concurrency control rules of SQL statements. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and ", + "desc":"This API is used to query SQL throttling rules. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /v3/{projec", "product_code":"taurusdb", - "title":"Deleting Concurrency Control Rules of SQL Statements", + "title":"Querying SQL Throttling Rules", + "uri":"ShowSqlFilterRule.html", + "doc_type":"api", + "p_code":"61", + "code":"65" + }, + { + "desc":"This API is used to delete SQL throttling rules. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.DELETE /v3/{pr", + "product_code":"taurusdb", + "title":"Deleting SQL Throttling Rules", "uri":"DeleteSqlFilterRule.html", "doc_type":"api", - "p_code":"60", - "code":"65" + "p_code":"61", + "code":"66" }, { "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.", @@ -591,7 +600,7 @@ "uri":"gaussdb_04_0014.html", "doc_type":"api", "p_code":"12", - "code":"66" + "code":"67" }, { "desc":"This API is used to obtain information about a TaurusDB task with a specified ID in the task center. Before calling this API:Learn how to authorize and authenticate it.Ob", @@ -599,8 +608,8 @@ "title":"Obtaining Information About a Task with a Specified ID", "uri":"ShowGaussMySqlJobInfo.html", "doc_type":"api", - "p_code":"66", - "code":"67" + "p_code":"67", + "code":"68" }, { "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.", @@ -609,7 +618,7 @@ "uri":"gaussdb_11_0000.html", "doc_type":"api", "p_code":"", - "code":"68" + "code":"69" }, { "desc":"This API is used to query the version information of a specified DB engine. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region ", @@ -617,8 +626,8 @@ "title":"Querying Version Information About a DB Engine", "uri":"gaussdb_11_0001.html", "doc_type":"api", - "p_code":"68", - "code":"69" + "p_code":"69", + "code":"70" }, { "desc":"This API is used to query the database specifications of a specified DB engine version. Before calling this API:Learn how to authorize and authenticate it.Obtain the requ", @@ -626,8 +635,8 @@ "title":"Querying Database Specifications", "uri":"gaussdb_11_0002.html", "doc_type":"api", - "p_code":"68", - "code":"70" + "p_code":"69", + "code":"71" }, { "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.", @@ -635,8 +644,8 @@ "title":"Instance Management", "uri":"gaussdb_11_0003.html", "doc_type":"api", - "p_code":"68", - "code":"71" + "p_code":"69", + "code":"72" }, { "desc":"This API is used to create a DB instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPOST https:", @@ -644,8 +653,8 @@ "title":"Creating a DB Instance", "uri":"gaussdb_11_0004.html", "doc_type":"api", - "p_code":"71", - "code":"72" + "p_code":"72", + "code":"73" }, { "desc":"This API is used to query instances according to search criteria. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoi", @@ -653,8 +662,8 @@ "title":"Querying DB Instances", "uri":"gaussdb_11_0005.html", "doc_type":"api", - "p_code":"71", - "code":"73" + "p_code":"72", + "code":"74" }, { "desc":"This API is used to query the details of a specified DB instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoi", @@ -662,8 +671,8 @@ "title":"Querying Details of a DB Instance", "uri":"gaussdb_11_0006.html", "doc_type":"api", - "p_code":"71", - "code":"74" + "p_code":"72", + "code":"75" }, { "desc":"This API is used to delete a DB instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatDELETE http", @@ -671,8 +680,8 @@ "title":"Deleting a DB Instance", "uri":"gaussdb_11_0007.html", "doc_type":"api", - "p_code":"71", - "code":"75" + "p_code":"72", + "code":"76" }, { "desc":"This API is used to create a read replica. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPOST https", @@ -680,8 +689,8 @@ "title":"Creating a Read Replica", "uri":"gaussdb_11_0015.html", "doc_type":"api", - "p_code":"71", - "code":"76" + "p_code":"72", + "code":"77" }, { "desc":"This API is used to delete a read replica. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatDELETE htt", @@ -689,8 +698,8 @@ "title":"Deleting a Read Replica", "uri":"gaussdb_11_0016.html", "doc_type":"api", - "p_code":"71", - "code":"77" + "p_code":"72", + "code":"78" }, { "desc":"This API is used to change a DB instance name. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPUT ht", @@ -698,8 +707,8 @@ "title":"Changing a DB Instance Name", "uri":"gaussdb_11_0018.html", "doc_type":"api", - "p_code":"71", - "code":"78" + "p_code":"72", + "code":"79" }, { "desc":"This API is used to reset a database password. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPOST h", @@ -707,8 +716,8 @@ "title":"Resetting a Database Password", "uri":"gaussdb_11_0019.html", "doc_type":"api", - "p_code":"71", - "code":"79" + "p_code":"72", + "code":"80" }, { "desc":"This API is used to change DB instance specifications. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI form", @@ -716,8 +725,8 @@ "title":"Changing DB Instance Specifications", "uri":"gaussdb_11_0020.html", "doc_type":"api", - "p_code":"71", - "code":"80" + "p_code":"72", + "code":"81" }, { "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.", @@ -725,8 +734,8 @@ "title":"Backup Management", "uri":"gaussdb_11_0021.html", "doc_type":"api", - "p_code":"68", - "code":"81" + "p_code":"69", + "code":"82" }, { "desc":"This API is used to create a manual backup. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPOST http", @@ -734,8 +743,8 @@ "title":"Creating a Manual Backup", "uri":"gaussdb_11_0022.html", "doc_type":"api", - "p_code":"81", - "code":"82" + "p_code":"82", + "code":"83" }, { "desc":"This API is used to query backups according to search criteria. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint", @@ -743,8 +752,8 @@ "title":"Querying Backups", "uri":"gaussdb_11_0023.html", "doc_type":"api", - "p_code":"81", - "code":"83" + "p_code":"82", + "code":"84" }, { "desc":"This API is used to query an automated backup policy. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI forma", @@ -752,8 +761,8 @@ "title":"Querying an Automated Backup Policy", "uri":"gaussdb_11_0024.html", "doc_type":"api", - "p_code":"81", - "code":"84" + "p_code":"82", + "code":"85" }, { "desc":"This API is used to modify the backup policy. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.URI formatPUT htt", @@ -761,8 +770,8 @@ "title":"Modifying the Backup Policy", "uri":"gaussdb_11_0025.html", "doc_type":"api", - "p_code":"81", - "code":"85" + "p_code":"82", + "code":"86" }, { "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.", @@ -770,8 +779,8 @@ "title":"Parameter Template Management", "uri":"gaussdb_11_0026.html", "doc_type":"api", - "p_code":"68", - "code":"86" + "p_code":"69", + "code":"87" }, { "desc":"This API is used to obtain parameter templates, including all databases' default and custom parameter templates. Before calling this API:Learn how to authorize and authen", @@ -779,8 +788,8 @@ "title":"Querying Parameter Templates", "uri":"gaussdb_11_0027.html", "doc_type":"api", - "p_code":"86", - "code":"87" + "p_code":"87", + "code":"88" }, { "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.", @@ -788,8 +797,8 @@ "title":"Quota Management", "uri":"gaussdb_11_0028.html", "doc_type":"api", - "p_code":"68", - "code":"88" + "p_code":"69", + "code":"89" }, { "desc":"This API is used to obtain the resource quotas of a specified enterprise project. Before calling this API:Learn how to authorize and authenticate it.Obtain the required r", @@ -797,8 +806,8 @@ "title":"Querying Enterprise Project Resource Quotas of a Tenant", "uri":"gaussdb_11_0029.html", "doc_type":"api", - "p_code":"88", - "code":"89" + "p_code":"89", + "code":"90" }, { "desc":"This API is used to configure resource quotas for a specified enterprise project. Before calling this API:Learn how to authorize and authenticate it.Obtain the required r", @@ -806,8 +815,8 @@ "title":"Configuring Enterprise Project Resource Quotas of a Tenant", "uri":"gaussdb_11_0030.html", "doc_type":"api", - "p_code":"88", - "code":"90" + "p_code":"89", + "code":"91" }, { "desc":"This API is used to modify the resource quotas of a specified enterprise project. Before calling this API:Learn how to authorize and authenticate it.Obtain the required r", @@ -815,8 +824,8 @@ "title":"Modifying Enterprise Project Resource Quotas of a Tenant", "uri":"gaussdb_11_0031.html", "doc_type":"api", - "p_code":"88", - "code":"91" + "p_code":"89", + "code":"92" }, { "desc":"This API is used to obtain information about a TaurusDB task with a specified ID in the task center. Before calling this API:Learn how to authorize and authenticate it.Ob", @@ -824,8 +833,8 @@ "title":"Obtaining Information About a Task with a Specified ID", "uri":"gaussdb_11_0032.html", "doc_type":"api", - "p_code":"68", - "code":"92" + "p_code":"69", + "code":"93" }, { "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.", @@ -834,7 +843,7 @@ "uri":"gaussdb_10_0000.html", "doc_type":"api", "p_code":"", - "code":"93" + "code":"94" }, { "desc":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringReturned error code when a task submission exception occurs. For details, see", @@ -842,8 +851,8 @@ "title":"Abnormal Request Results", "uri":"gaussdb_10_0001.html", "doc_type":"api", - "p_code":"93", - "code":"94" + "p_code":"94", + "code":"95" }, { "desc":"The following table describes status codes.", @@ -851,8 +860,8 @@ "title":"Status Codes", "uri":"gaussdb_10_0002.html", "doc_type":"api", - "p_code":"93", - "code":"95" + "p_code":"94", + "code":"96" }, { "desc":"The following table describes error codes.", @@ -860,8 +869,8 @@ "title":"Error Codes", "uri":"gaussdb_10_0003.html", "doc_type":"api", - "p_code":"93", - "code":"96" + "p_code":"94", + "code":"97" }, { "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 ", @@ -869,8 +878,8 @@ "title":"Obtaining a Project ID", "uri":"gaussdb_10_0004.html", "doc_type":"api", - "p_code":"93", - "code":"97" + "p_code":"94", + "code":"98" }, { "desc":"This section describes namespaces, descriptions, and dimensions of metrics to be reported to Cloud Eye. You can use APIs provided by Cloud Eye to retrieve metrics and ala", @@ -878,8 +887,8 @@ "title":"TaurusDB Metrics", "uri":"gaussdb_10_0006.html", "doc_type":"api", - "p_code":"93", - "code":"98" + "p_code":"94", + "code":"99" }, { "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.", @@ -888,6 +897,6 @@ "uri":"changeHistory.html", "doc_type":"api", "p_code":"", - "code":"99" + "code":"100" } ] \ No newline at end of file diff --git a/docs/taurusdb/api-ref/DeleteGaussMySqlBackup.html b/docs/taurusdb/api-ref/DeleteGaussMySqlBackup.html index c24e24174..5c5bc83a1 100644 --- a/docs/taurusdb/api-ref/DeleteGaussMySqlBackup.html +++ b/docs/taurusdb/api-ref/DeleteGaussMySqlBackup.html @@ -73,7 +73,7 @@

Response Parameters

Status code: 200

-
Table 3 Response body parameter

Parameter

+
@@ -100,7 +100,7 @@

Status code: 400

-
Table 3 Response body parameters

Parameter

Type

Table 4 Response body parameter

Parameter

+
@@ -127,7 +127,7 @@

Status code: 500

-
Table 4 Response body parameters

Parameter

Type

Table 5 Response body parameter

Parameter

+
diff --git a/docs/taurusdb/api-ref/DeleteGaussMySqlProxy.html b/docs/taurusdb/api-ref/DeleteGaussMySqlProxy.html index c34dd20fd..3c8fe5ee5 100644 --- a/docs/taurusdb/api-ref/DeleteGaussMySqlProxy.html +++ b/docs/taurusdb/api-ref/DeleteGaussMySqlProxy.html @@ -32,7 +32,7 @@ - @@ -170,7 +170,8 @@
Table 5 Response body parameters

Parameter

Type

String

DB instance ID.

+

Instance ID.

-

Example Request

DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy
+

Example Request

+DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy
 {
   "proxy_ids" : [ "151c14381ac14ecfb9703a745b992677po01" ]
 }
diff --git a/docs/taurusdb/api-ref/DeleteSqlFilterRule.html b/docs/taurusdb/api-ref/DeleteSqlFilterRule.html index 5ae167c6d..8f40ce7ab 100644 --- a/docs/taurusdb/api-ref/DeleteSqlFilterRule.html +++ b/docs/taurusdb/api-ref/DeleteSqlFilterRule.html @@ -1,7 +1,7 @@ -

Deleting Concurrency Control Rules of SQL Statements

-

Function

This API is used to delete concurrency control rules of SQL statements. Before calling this API:

+

Deleting SQL Throttling Rules

+

Function

This API is used to delete SQL throttling rules. Before calling this API:

URI

DELETE /v3/{project_id}/instances/{instance_id}/sql-filter/rules

@@ -40,39 +40,39 @@

Request Parameters

-
Table 2 Request header parameters

Parameter

+
- - - - - - - - - - -
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

+

User token.

X-Language

+

Content-Type

No

+

Yes

String

+

String

Language.

+

Content type.

-
Table 3 Request body parameters

Parameter

+
@@ -88,7 +88,7 @@ - @@ -120,7 +120,7 @@ - @@ -145,7 +145,7 @@ - @@ -163,7 +163,7 @@

Response Parameters

Status code: 200

-
Table 3 Request body parameter

Parameter

Mandatory

Array of DeleteNodeSqlFilterRuleInfo objects

Concurrency control rules of SQL statements for nodes.

+

SQL throttling rules for nodes.

Array of DeleteNodeSqlFilterRule objects

Concurrency control rules of SQL statements.

+

SQL throttling rules.

SQL statement type.

Valid value:

-
  • SELECT
  • UPDATE
  • DELETE
+
  • SELECT
  • UPDATE
  • DELETE
  • INSERT

patterns

@@ -154,7 +154,7 @@

Array of strings

Concurrency control rules of SQL statements.

+

SQL throttling rules.

Table 6 Response body parameters

Parameter

+
@@ -175,7 +175,7 @@ - @@ -236,7 +236,7 @@
Table 6 Response body parameter

Parameter

Type

String

ID of the task for deleting concurrency control rules of SQL statements.

+

ID of the task for deleting SQL throttling rules.

-

Example Request

Deleting concurrency control rules of SQL statements

+

Example Request

Deleting SQL throttling rules

 DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules
 {
@@ -274,7 +274,7 @@ DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c019
 
diff --git a/docs/taurusdb/api-ref/ListGaussMySqlErrorLog.html b/docs/taurusdb/api-ref/ListGaussMySqlErrorLog.html index ec1acf16f..55dda7044 100644 --- a/docs/taurusdb/api-ref/ListGaussMySqlErrorLog.html +++ b/docs/taurusdb/api-ref/ListGaussMySqlErrorLog.html @@ -4,7 +4,7 @@

Function

This API is used to query database error logs. Before using this API:

-

URI

GET /v3/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date}&node_id={node_id}

+

URI

GET /v3/{project_id}/instances/{instance_id}/errorlog

diff --git a/docs/taurusdb/api-ref/ListGaussMySqlSlowLog.html b/docs/taurusdb/api-ref/ListGaussMySqlSlowLog.html index 0c7070f97..aea341c0d 100644 --- a/docs/taurusdb/api-ref/ListGaussMySqlSlowLog.html +++ b/docs/taurusdb/api-ref/ListGaussMySqlSlowLog.html @@ -4,7 +4,7 @@

Function

This API is used to query database slow logs. Before using this API:

-

URI

GET /v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date}&node_id={node_id}

+

URI

GET /v3/{project_id}/instances/{instance_id}/slowlog

Table 1 URI parameters

Parameter

diff --git a/docs/taurusdb/api-ref/ListInstanceConfigurations.html b/docs/taurusdb/api-ref/ListInstanceConfigurations.html index 27e500656..df7d7e1c5 100644 --- a/docs/taurusdb/api-ref/ListInstanceConfigurations.html +++ b/docs/taurusdb/api-ref/ListInstanceConfigurations.html @@ -16,21 +16,14 @@ - - - - -
Table 1 URI parameters

Parameter

project_id

+

project_id

Yes

+

Yes

String

+

String

Explanation:

-

Project ID of a tenant in a region.

-

To obtain this value, see Obtaining a Project ID.

-

Constraints:

-

None

-

Value range:

-

The value can contain 32 characters. Only letters and digits are allowed.

-

Default value:

-

None

+

Project ID of a tenant in a region.

+

To obtain this value, see Obtaining a Project ID.

instance_id

@@ -39,60 +32,39 @@

String

Explanation:

-

Instance ID, which uniquely identifies an instance.

-

Constraints:

-

None

-

Value range:

-

The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed.

-

Default value:

-

None

+

Instance ID, which uniquely identifies an instance.

-
Table 2 Query parameters

Parameter

+
- - - - - - - - - - - @@ -100,48 +72,23 @@

Request Parameters

-
Table 2 Query parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

offset

+

offset

No

+

No

Integer

+

Integer

Explanation:

-

Index offset. The query starts from the next piece of data indexed by this parameter.

-

Constraints:

-

The value must be an integer and cannot be a negative number.

-

Value range:

-

≥0

-

Default value:

-

0

+

Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.

limit

+

limit

No

+

No

Integer

+

Integer

Explanation:

-

Number of records to be queried.

-

Constraints:

-

The value must be an integer and cannot be a negative number.

-

Value range:

-

1–100

-

Default value:

-

100

+

Number of records to be queried. The default value is 100. The value must be a positive integer. The minimum value is 1 and the maximum value is 100.

Table 3 Request header parameters

Parameter

+
- - - - - - - - - - - - @@ -150,174 +97,146 @@

Response Parameters

Status code: 200

-
Table 3 Request header parameter

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

Explanation:

-

User token.

-

To obtain this value, call the IAM API for obtaining a user token.

-

The value of X-Subject-Token in the response header is the token value.

-

Constraints:

-

None

-

Value range:

-

None

-

Default value:

-

None

-

X-Language

-

No

-

String

-

Explanation:

-

Request language type.

-

Constraints:

-

None

-

Value range:

-
  • en-us
  • zh-cn
-

Default value:

-

en-us

+

User token.

Table 4 Response body parameters

Parameter

+
- - - - - - - - - - -
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

configurations

+

configurations

ParameterConfigurationInfo object

+

ParameterConfigurationInfo object

Explanation:

-

Instance parameter template information.

+

Instance parameter template information.

total_count

+

total_count

Long

+

Long

Explanation:

-

Total number of instance parameters.

-

Value range:

-

≥0

+

Total number of instance parameters.

parameter_values

+

parameter_values

Array of ParameterValuesInfo objects

+

Array of ParameterValuesInfo objects

Explanation:

-

Instance parameter information.

+

Instance parameter information.

-
Table 5 ParameterConfigurationInfo

Parameter

+
- - - - - - - - - - - + + + + - - -
Table 5 ParameterConfigurationInfo

Parameter

Type

+

Type

Description

+

Description

datastore_version_name

+

datastore_version_name

String

+

String

Explanation:

-

DB version name.

-

Value range:

-

2.0

+

DB version name.

datastore_name

+

datastore_name

String

+

String

Explanation:

-

DB engine name in the parameter template.

-

Value range:

-

taurus

+

DB engine name in the parameter template.

created

+

configuration_id

String

+

String

Explanation:

-

Time when the parameter template was created. The format is "yyyy-mm-ddThh:mm:ssZ".

+

Parameter template ID.

+

created

+

String

+

Time when the parameter template was created. The format is "yyyy-mm-ddThh:mm:ssZ".

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

-

Value range:

-

None

updated

+

updated

String

+

String

Explanation:

-

Time when the parameter template was updated. The format is "yyyy-mm-ddThh:mm:ssZ".

+

Time when the parameter template was updated. The format is "yyyy-mm-ddThh:mm:ssZ".

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

-

Value range:

-

None

-
Table 6 ParameterValuesInfo

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - @@ -388,6 +307,7 @@ GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c "configurations" : { "datastore_version_name" : "2.0", "datastore_name" : "taurus", + "configuration_id": "f35d2c4501944225bc96ef8d20ece2bcpr07", "created" : "2022-10-29T09:38:36+0000", "updated" : "2022-10-29T09:38:36+0000" }, diff --git a/docs/taurusdb/api-ref/ListProjectTags.html b/docs/taurusdb/api-ref/ListProjectTags.html index ab3c164bf..38d7a7cd9 100644 --- a/docs/taurusdb/api-ref/ListProjectTags.html +++ b/docs/taurusdb/api-ref/ListProjectTags.html @@ -6,7 +6,7 @@

URI

GET /v3/{project_id}/tags

-
Table 6 ParameterValuesInfo

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Explanation:

-

Parameter name.

-

Value range:

-

None

+

Parameter name.

value

+

value

String

+

String

Explanation:

-

Parameter value.

-

Value range:

-

None

+

Parameter value.

restart_required

+

restart_required

Boolean

+

Boolean

Explanation:

-

Whether a reboot is required.

-

Value range:

-
  • false: No
  • true: Yes
+

Whether a reboot is required.

+
  • false: no
  • true: yes

readonly

+

readonly

Boolean

+

Boolean

Explanation:

-

Whether the parameter is read-only.

-

Value range:

-
  • false: No
  • true: Yes
+

Whether the parameter is read-only.

+
  • false: no
  • true: yes

value_range

+

value_range

String

+

String

Explanation:

-

Value range.

-

Value range:

-

None

+

Value range.

type

+

type

String

+

String

Explanation:

-

Parameter type.

-

Value range:

+

Parameter type.

  • string
  • integer
  • boolean
  • list
  • float

description

+

description

String

+

String

Explanation:

-

Parameter description.

-

Value range:

-

None

+

Parameter description.

Table 1 URI parameters

Parameter

+
diff --git a/docs/taurusdb/api-ref/SetGaussMySqlProxyWeight.html b/docs/taurusdb/api-ref/SetGaussMySqlProxyWeight.html index 44168b8e9..1250e56e3 100644 --- a/docs/taurusdb/api-ref/SetGaussMySqlProxyWeight.html +++ b/docs/taurusdb/api-ref/SetGaussMySqlProxyWeight.html @@ -146,7 +146,7 @@

Response Parameters

Status code: 200

-
Table 1 URI parameter

Parameter

Mandatory

Table 5 Response body parameters

Parameter

+
diff --git a/docs/taurusdb/api-ref/SetSqlFilterRule.html b/docs/taurusdb/api-ref/SetSqlFilterRule.html index a2ecb0fe9..cf49f738b 100644 --- a/docs/taurusdb/api-ref/SetSqlFilterRule.html +++ b/docs/taurusdb/api-ref/SetSqlFilterRule.html @@ -1,7 +1,7 @@ -

Configuring Concurrency Control Rules of SQL Statements

-

Function

This API is used to configure concurrency control rules of SQL statements. Before calling this API:

+

Configuring SQL Throttling Rules

+

Function

This API is used to configure SQL throttling rules. Before calling this API:

URI

PUT /v3/{project_id}/instances/{instance_id}/sql-filter/rules

@@ -32,7 +32,7 @@
- @@ -40,39 +40,39 @@

Request Parameters

-
Table 5 Response body parameter

Parameter

Type

String

DB instance ID.

+

Instance ID.

Table 2 Request header parameters

Parameter

+
- - - - - - - - - - -
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

+

User token.

X-Language

+

Content-Type

No

+

Yes

String

+

String

Language.

+

Content type.

-
Table 3 Request body parameters

Parameter

+
@@ -88,7 +88,7 @@ - @@ -120,7 +120,7 @@ - @@ -145,7 +145,7 @@ - @@ -177,7 +177,7 @@ -
Table 3 Request body parameter

Parameter

Mandatory

Array of NodeSqlFilterRuleInfo objects

Concurrency control rules of SQL statements for nodes.

+

SQL throttling rules for nodes.

Array of NodeSqlFilterRule objects

Concurrency control rules of SQL statements. The sql_type value must be unique.

+

SQL throttling rules. The sql_type value must be unique.

SQL statement type.

Valid value:

-
  • SELECT
  • UPDATE
  • DELETE
+
  • SELECT
  • UPDATE
  • DELETE
  • INSERT

patterns

@@ -154,7 +154,7 @@

Array of NodeSqlFilterRulePattern objects

Concurrency control rules of SQL statements.

+

SQL throttling rules.

String

A concurrency control rule of SQL statements. A rule can consist of up to 128 keywords. The keywords are separated by tildes (~), for example, select~from~t1. The rule cannot contain backslashes (\), commas (,), or double tildes (~~). It cannot end with tildes (~).

+

SQL throttling rule. A rule can consist of up to 128 keywords. The keywords are separated by tildes (~), for example, select~from~t1. The rule cannot contain backslashes (\), commas (,), or double tildes (~~). It cannot end with tildes (~).

max_concurrency

@@ -195,7 +195,7 @@

Response Parameters

Status code: 200

-
Table 7 Response body parameters

Parameter

+
@@ -207,7 +207,7 @@ - @@ -268,7 +268,7 @@
Table 7 Response body parameter

Parameter

Type

String

ID of the task for configuring concurrency control rules of SQL statements.

+

ID of the task for configuring SQL throttling rules.

-

Example Request

Configuring concurrency control rules of SQL statements

+

Example Request

Configuring SQL throttling rules

 PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules
 {
@@ -321,7 +321,7 @@ PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3
 
diff --git a/docs/taurusdb/api-ref/ShowGaussMySqlJobInfo.html b/docs/taurusdb/api-ref/ShowGaussMySqlJobInfo.html index 218bb5e9e..c8917f09f 100644 --- a/docs/taurusdb/api-ref/ShowGaussMySqlJobInfo.html +++ b/docs/taurusdb/api-ref/ShowGaussMySqlJobInfo.html @@ -6,9 +6,9 @@

Constraints

  • This API is used to query asynchronous tasks of the last one month in the task center.
  • After a job is generated, it takes several seconds to query the job ID.
-

URI

GET /v3/{project_id}/jobs?id={id}

+

URI

GET /v3/{project_id}/jobs

-
Table 1 URI parameters

Parameter

+
@@ -32,7 +32,7 @@
Table 1 URI parameter

Parameter

Mandatory

-
Table 2 Query parameters

Parameter

+
diff --git a/docs/taurusdb/api-ref/ShowInstanceMonitorExtend.html b/docs/taurusdb/api-ref/ShowInstanceMonitorExtend.html index 2ba9faa8e..db1b6a6de 100644 --- a/docs/taurusdb/api-ref/ShowInstanceMonitorExtend.html +++ b/docs/taurusdb/api-ref/ShowInstanceMonitorExtend.html @@ -33,7 +33,7 @@ - diff --git a/docs/taurusdb/api-ref/ShowSqlFilterControl.html b/docs/taurusdb/api-ref/ShowSqlFilterControl.html index bba03ef93..274525aef 100644 --- a/docs/taurusdb/api-ref/ShowSqlFilterControl.html +++ b/docs/taurusdb/api-ref/ShowSqlFilterControl.html @@ -1,7 +1,7 @@ -

Querying Whether SQL Statement Concurrency Control Is Enabled

-

Function

This API is used to query whether SQL Statement Concurrency Control is enabled. Before calling this API:

+

Querying Whether SQL Throttling Is Enabled

+

Function

This API is used to query whether SQL Throttling is enabled. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/sql-filter/switch

@@ -74,7 +74,7 @@

Response Parameters

Status code: 200

-
Table 2 Query parameter

Parameter

Mandatory

String

DB instance ID.

+

Instance ID.

Table 3 Response body parameters

Parameter

+
@@ -86,7 +86,7 @@ - @@ -149,7 +149,7 @@
Table 3 Response body parameter

Parameter

Type

String

Whether SQL Statement Concurrency Control is enabled.

+

Whether SQL Throttling is enabled.

Value:

  • ON: enabled
  • OFF: disabled
-

Example Request

Querying whether SQL Statement Concurrency Control is enabled

+

Example Request

Querying whether SQL Throttling is enabled

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch

Example Response

Status code: 200

@@ -165,7 +165,7 @@
diff --git a/docs/taurusdb/api-ref/ShowSqlFilterRule.html b/docs/taurusdb/api-ref/ShowSqlFilterRule.html index 6010fc36e..e37c06305 100644 --- a/docs/taurusdb/api-ref/ShowSqlFilterRule.html +++ b/docs/taurusdb/api-ref/ShowSqlFilterRule.html @@ -1,10 +1,10 @@ -

Querying Concurrency Control Rules of SQL Statements

-

Function

This API is used to query concurrency control rules of SQL statements. Before calling this API:

+

Querying SQL Throttling Rules

+

Function

This API is used to query SQL throttling rules. Before calling this API:

-

URI

GET /v3/{project_id}/instances/{instance_id}/sql-filter/rules?node_id={node_id}

+

URI

GET /v3/{project_id}/instances/{instance_id}/sql-filter/rules

@@ -32,7 +32,7 @@ - @@ -58,13 +58,13 @@ - - @@ -72,7 +72,7 @@

Request Parameters

-
Table 1 URI parameters

Parameter

String

DB instance ID.

+

Instance ID.

Node ID.

type

+

sql_type

No

String

SQL statement type. The value can be SELECT, UPDATE, and DELETE (case-insensitive). If this parameter is not specified, concurrency control rules of all types of statements are queried.

+

SQL statements. The value can be SELECT, UPDATE, DELETE, or INSERT (case-insensitive). If this parameter is not specified, SQL throttling rules of all the statements are queried.

- @@ -146,14 +137,14 @@ - @@ -172,7 +163,7 @@ - + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+
@@ -91,15 +91,6 @@ - - - - -
Table 3 Request header parameter

Parameter

Mandatory

User token.

X-Language

-

No

-

String

-

Language.

-
@@ -125,7 +116,7 @@

Array of SqlFilterRule objects

Concurrency control rules of SQL statements.

+

SQL throttling rules.

SQL statement type.

Valid value:

-
  • SELECT
  • UPDATE
  • DELETE
+
  • SELECT
  • UPDATE
  • DELETE
  • INSERT

patterns

Array of SqlFilterRulePattern objects

Concurrency control rules of SQL statements.

+

SQL throttling rules.

String

A concurrency control rule of SQL statements.

+

SQL throttling rule.

max_concurrency

@@ -182,6 +173,34 @@

Maximum number of concurrent SQL statements.

cur_concurrency

+

Integer

+

Current number of concurrent requests.

+

cur_reject

+

Integer

+

Current number of interceptions.

+

create_at

+

Long

+

Time when a SQL throttling rule was created.

+

expire_at

+

Long

+

Time when a SQL throttling rule expires.

+
@@ -240,36 +259,56 @@
-

Example Request

Querying concurrency control rules of SQL statements

+

Example Request

Querying SQL throttling rules

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules?node_id=c01a5645eb2c4fb6a9373542f5366e50no07

Example Response

Status code: 200

Success.

-
{
+
{
   "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07",
   "sql_filter_rules" : [ {
     "sql_type" : "SELECT",
     "patterns" : [ {
       "pattern" : "select~from~t1",
-      "max_concurrency" : 0
+      "max_concurrency" : 0,
+      "cur_concurrency" : 0,
+      "cur_reject" : 0,
+      "create_at" : 1753254394,
+      "expire_at" : 9223372036854775807
     }, {
       "pattern" : "select~from~t2~where~id",
-      "max_concurrency" : 10
+      "max_concurrency" : 10,
+      "cur_concurrency" : 0,
+      "cur_reject" : 0,
+      "create_at" : 1753254394,
+      "expire_at" : 9223372036854775807
     } ]
   }, {
-    "sql_type" : "UDPATE",
+    "sql_type" : "UPDATE",
     "patterns" : [ {
       "pattern" : "update~t1",
-      "max_concurrency" : 0
+      "max_concurrency" : 0,
+      "cur_concurrency" : 0,
+      "cur_reject" : 0,
+      "create_at" : 1753254394,
+      "expire_at" : 9223372036854775807
     }, {
       "pattern" : "update~t2~where~id",
-      "max_concurrency" : 10
+      "max_concurrency" : 10,
+      "cur_concurrency" : 0,
+      "cur_reject" : 0,
+      "create_at" : 1753254394,
+      "expire_at" : 9223372036854775807
     } ]
   }, {
     "sql_type" : "DELETE",
     "patterns" : [ {
       "pattern" : "delete~from",
-      "max_concurrency" : 0
+      "max_concurrency" : 0,
+      "cur_concurrency" : 0,
+      "cur_reject" : 0,
+      "create_at" : 1753254394,
+      "expire_at" : 9223372036854775807
     } ]
   } ]
 }
@@ -281,7 +320,7 @@
diff --git a/docs/taurusdb/api-ref/UpdateInstanceConfigurations.html b/docs/taurusdb/api-ref/UpdateInstanceConfigurations.html new file mode 100644 index 000000000..708ac8794 --- /dev/null +++ b/docs/taurusdb/api-ref/UpdateInstanceConfigurations.html @@ -0,0 +1,210 @@ + + +

Modifying Parameters of a Specified Instance

+

Function

This API is used to modify parameters of a specified instance. Before calling this API:

+ +
+

URI

PUT /v3/{project_id}/instances/{instance_id}/configurations

+ +
+ + + + + + + + + + + + + + + + +
Table 1 URI parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region.

+

To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID, which uniquely identifies an instance.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

Content-Type

+

Yes

+

String

+

Content type.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameter

Parameter

+

Mandatory

+

Type

+

Description

+

parameter_values

+

Yes

+

Map<String,String>

+

Mapping between parameter names and parameter values. You can specify parameter values based on a default parameter template. If this parameter is not specified, the original parameter information is retained.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

ID of the task for modifying parameters of a specified instance.

+

restart_required

+

Boolean

+

Whether a reboot is required.

+
  • true: yes

    +
  • false: no

    +
+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Modifying parameters of a specified instance

+
+PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/3ef58db3986540d19f95151309368d34in07/configurations
+
+{
+  "parameter_values" : {
+    "max_user_connections" : "100"
+  }
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "e5d698a9-d8db-47d2-bf75-3c9018f72b6f",
+  "restart_required" : false
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+ +
+ diff --git a/docs/taurusdb/api-ref/UpdateInstanceMonitor.html b/docs/taurusdb/api-ref/UpdateInstanceMonitor.html index 8a84600eb..fcd4ec888 100644 --- a/docs/taurusdb/api-ref/UpdateInstanceMonitor.html +++ b/docs/taurusdb/api-ref/UpdateInstanceMonitor.html @@ -109,7 +109,7 @@

Response Parameters

Status code: 200

-
Table 4 Response body parameters

Parameter

+
diff --git a/docs/taurusdb/api-ref/UpdateSqlFilterControl.html b/docs/taurusdb/api-ref/UpdateSqlFilterControl.html index 4d2f6c57c..0e408755d 100644 --- a/docs/taurusdb/api-ref/UpdateSqlFilterControl.html +++ b/docs/taurusdb/api-ref/UpdateSqlFilterControl.html @@ -1,7 +1,7 @@ -

Enabling or Disabling SQL Statement Concurrency Control

-

Function

This API is used to enable or disable SQL Statement Concurrency Control. Before calling this API:

+

Enabling or Disabling SQL Throttling

+

Function

This API is used to enable or disable SQL Throttling. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/sql-filter/switch

@@ -72,7 +72,7 @@
Table 4 Response body parameter

Parameter

Type

-
Table 3 Request body parameters

Parameter

+
@@ -88,7 +88,7 @@ - @@ -98,7 +98,7 @@

Response Parameters

Status code: 200

-
Table 3 Request body parameter

Parameter

Mandatory

String

Whether SQL Statement Concurrency Control is enabled. Value:

+

Whether SQL Throttling is enabled. Value:

  • ON: enabled
  • OFF: disabled
- + + + + + +
Table 4 Response body parameters

Parameter

+
@@ -110,7 +110,7 @@ - @@ -171,11 +171,11 @@
Table 4 Response body parameter

Parameter

Type

String

ID of the task for enabling or disabling SQL Statement Concurrency Control.

+

ID of the task for enabling or disabling SQL Throttling.

-

Example Request

  • Enabling SQL Statement Concurrency Control
    POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
    +

    Example Request

    • Enabling SQL Throttling
      POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
       {
         "switch_status" : "ON"
       }
      -
    • Disabling SQL Statement Concurrency Control
      POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
      +
    • Disabling SQL Throttling
      POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
       {
         "switch_status" : "OFF"
       }
      @@ -194,7 +194,7 @@
    diff --git a/docs/taurusdb/api-ref/changeHistory.html b/docs/taurusdb/api-ref/changeHistory.html index 4e03b1f67..f4f61c48a 100644 --- a/docs/taurusdb/api-ref/changeHistory.html +++ b/docs/taurusdb/api-ref/changeHistory.html @@ -8,7 +8,13 @@

2025-03-27

+

2025-07-16

+

Modified the following content:

+

Added Modifying Parameters of a Specified Instance.

+

2025-03-27

Modified the following content:

@@ -23,7 +29,7 @@

2024-04-15

Added the following content:

- +

2024-02-28

@@ -49,7 +55,7 @@

Modified the following content:

Delete the following APIs:

-
  • Configuring Concurrency Control Rules of SQL Statements
  • Querying Concurrency Control Rules of SQL Statements
  • Deleting Concurrency Control Rules of SQL Statements
+
  • Configuring SQL Throttling Rules
  • Querying SQL Throttling Rules
  • Deleting SQL Throttling Rules

2023-04-06

@@ -62,7 +68,7 @@

Modified the following content:

Added the following APIs:

- +

2020-12-09

diff --git a/docs/taurusdb/api-ref/en-us_image_0000001427231638.png b/docs/taurusdb/api-ref/en-us_image_0000001562311076.png similarity index 100% rename from docs/taurusdb/api-ref/en-us_image_0000001427231638.png rename to docs/taurusdb/api-ref/en-us_image_0000001562311076.png diff --git a/docs/taurusdb/api-ref/gaussdb_00_0002.html b/docs/taurusdb/api-ref/gaussdb_00_0002.html index 382e52148..a4325e3c5 100644 --- a/docs/taurusdb/api-ref/gaussdb_00_0002.html +++ b/docs/taurusdb/api-ref/gaussdb_00_0002.html @@ -1,7 +1,7 @@

API Calling

-

TaurusDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see API Usage Guidelines.

+

TaurusDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

Manage tags, including adding tags in batches, deleting tags in batches, and querying project tags.

SQL throttling

+

Query, configure and delete SQL throttling rules.

+

Task center

Obtain task information about the task center.

diff --git a/docs/taurusdb/api-ref/gaussdb_03_0000.html b/docs/taurusdb/api-ref/gaussdb_03_0000.html index 87f435490..954e92898 100644 --- a/docs/taurusdb/api-ref/gaussdb_03_0000.html +++ b/docs/taurusdb/api-ref/gaussdb_03_0000.html @@ -1,6 +1,6 @@ -

API Usage Guidelines

+

Calling APIs

diff --git a/docs/taurusdb/api-ref/gaussdb_03_0005.html b/docs/taurusdb/api-ref/gaussdb_03_0005.html index ad0f8a6d3..da0092c33 100644 --- a/docs/taurusdb/api-ref/gaussdb_03_0005.html +++ b/docs/taurusdb/api-ref/gaussdb_03_0005.html @@ -64,7 +64,7 @@
-

For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:

+

For example, for the URI of the API used to obtain a user token, the request method is POST. The request is as follows:

Request Header

You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.

Table 3 lists common request header fields. @@ -134,11 +134,11 @@
-

The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:

+

The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:

(Optional) Request Body

This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the Content-Type header field. If the request body contains full-width characters, these characters must be coded in UTF-8.

The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.

-
In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with actual values. It can be obtained from Regions and Endpoints.

The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.

+
In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with actual values. It can be obtained from Regions and Endpoints.

The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.

@@ -172,7 +172,7 @@ Content-Type: application/json
 
diff --git a/docs/taurusdb/api-ref/gaussdb_03_0006.html b/docs/taurusdb/api-ref/gaussdb_03_0006.html index 9772ba99c..e46877684 100644 --- a/docs/taurusdb/api-ref/gaussdb_03_0006.html +++ b/docs/taurusdb/api-ref/gaussdb_03_0006.html @@ -3,13 +3,13 @@

Response

Status Code

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 5xx. It indicates the status of a response. For more information, see Status Codes.

-

For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.

+

For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.

Response Header

Similar to a request, a response also has a header, for example, Content-Type.

-

Figure 1 shows the response header for the API used to obtain a user token. The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.

-
Figure 1 Header fields of the response to the request for obtaining a user token
+

Figure 1 shows the response header for the API used to obtain a user token. The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.

+
Figure 1 Header fields of the response to the request for obtaining a user token
-

(Optional) Response Body

This part is optional. The body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.

+

(Optional) Response Body

This part is optional. The body of a response is often returned in structured format (for example, JSON or XML) as specified in the Content-Type header field. The response body transfers content except the response header.

The following is part of the response body for the API used to obtain a user token.
{
     "token": {
         "expires_at": "2019-02-13T06:52:13.855000Z",
@@ -33,7 +33,7 @@
 
diff --git a/docs/taurusdb/api-ref/gaussdb_04_0000.html b/docs/taurusdb/api-ref/gaussdb_04_0000.html index 1783ffd57..5694532e4 100644 --- a/docs/taurusdb/api-ref/gaussdb_04_0000.html +++ b/docs/taurusdb/api-ref/gaussdb_04_0000.html @@ -24,7 +24,7 @@ - diff --git a/docs/taurusdb/api-ref/gaussdb_04_0002.html b/docs/taurusdb/api-ref/gaussdb_04_0002.html index 984ef8d40..78330f931 100644 --- a/docs/taurusdb/api-ref/gaussdb_04_0002.html +++ b/docs/taurusdb/api-ref/gaussdb_04_0002.html @@ -4,7 +4,7 @@

Function

This API is used to query the database specifications of a specified DB engine version. Before calling this API:

-

URI

GET /v3/{project_id}/flavors/{database_name}?availability_zone_mode={availability_zone_mode}

+

URI

GET /v3/{project_id}/flavors/{database_name}

diff --git a/docs/taurusdb/api-ref/gaussdb_04_0004.html b/docs/taurusdb/api-ref/gaussdb_04_0004.html index c7833d774..fd6a76b7f 100644 --- a/docs/taurusdb/api-ref/gaussdb_04_0004.html +++ b/docs/taurusdb/api-ref/gaussdb_04_0004.html @@ -580,7 +580,7 @@ - - @@ -193,7 +193,8 @@ "keep_days" : "7,", "start_time" : "19:00-20:00", "period" : "1,2" - } + + } }

Status Code

For details, see Status Codes.

diff --git a/docs/taurusdb/api-ref/gaussdb_10_0004.html b/docs/taurusdb/api-ref/gaussdb_10_0004.html index 50568eb05..f00416748 100644 --- a/docs/taurusdb/api-ref/gaussdb_10_0004.html +++ b/docs/taurusdb/api-ref/gaussdb_10_0004.html @@ -4,7 +4,7 @@

Scenarios

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 by Calling an API

The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from Regions and Endpoints. For details about API authentication, see Authentication.

+

Obtaining the Project ID by Calling an API

The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from Regions and Endpoints. For details about API authentication, see Authentication.

The following is an example response. The value of id is the project ID.

{
     "projects": [
diff --git a/docs/taurusdb/api-ref/gaussdb_11_0001.html b/docs/taurusdb/api-ref/gaussdb_11_0001.html
index a93261e8f..3eb212127 100644
--- a/docs/taurusdb/api-ref/gaussdb_11_0001.html
+++ b/docs/taurusdb/api-ref/gaussdb_11_0001.html
@@ -5,7 +5,7 @@
 
 

URI

  • URI format

    GET https://{endpoint}/mysql/v3/{project_id}/datastores/{database_name}

    -
  • Example

    GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql

    +
  • URI example

    GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql

  • Parameter description
Table 1 URI parameters

Parameter

Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter.

The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.

-
  1. The HH value must be 1 greater than the hh value.
  2. The values of mm and MM must be the same and must be set to 00.
+
  1. The HH value must be 1 greater than the hh value.
  2. The values of mm and MM must be the same and must be set to 00.

keep_days

diff --git a/docs/taurusdb/api-ref/gaussdb_04_0006.html b/docs/taurusdb/api-ref/gaussdb_04_0006.html index 9869c3329..f05f36dd6 100644 --- a/docs/taurusdb/api-ref/gaussdb_04_0006.html +++ b/docs/taurusdb/api-ref/gaussdb_04_0006.html @@ -492,7 +492,7 @@

String

Update time. The format is the same as that of the created field. The value is empty unless the DB instance creation is complete.

+

Update time. The format is the same as that of the created field. The value is empty unless the DB instance creation is complete.

flavor_id

diff --git a/docs/taurusdb/api-ref/gaussdb_04_0008.html b/docs/taurusdb/api-ref/gaussdb_04_0008.html index 83b29ec3e..c29a95474 100644 --- a/docs/taurusdb/api-ref/gaussdb_04_0008.html +++ b/docs/taurusdb/api-ref/gaussdb_04_0008.html @@ -8,6 +8,8 @@ +

String

DB instance ID, which is compliant with the UUID format.

+

Instance ID, which is compliant with the UUID format.

diff --git a/docs/taurusdb/api-ref/gaussdb_11_0002.html b/docs/taurusdb/api-ref/gaussdb_11_0002.html index 83c80714d..beade45e0 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0002.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0002.html @@ -5,7 +5,7 @@

URI

  • URI format

    GET https://{endpoint}/mysql/v3/{project_id}/flavors/{database_name}?version_name={version_name}&spec_code={spec_code}&availability_zone_mode={availability_zone_mode}

    -
  • Example

    GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql

    +
  • URI example

    GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql

  • Parameter description
Table 1 Parameter description

Name

Table 1 Parameter description

Name

diff --git a/docs/taurusdb/api-ref/gaussdb_11_0004.html b/docs/taurusdb/api-ref/gaussdb_11_0004.html index 1d49b07b5..22f45267c 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0004.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0004.html @@ -5,7 +5,7 @@

URI

  • URI format

    POST https://{endpoint}/mysql/v3/{project_id}/instances

    -
  • Example

    POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances

    +
  • URI example

    POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances

  • Parameter description
    @@ -674,7 +674,7 @@ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0005.html b/docs/taurusdb/api-ref/gaussdb_11_0005.html index 8540b79c1..029a87351 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0005.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0005.html @@ -5,7 +5,7 @@

    URI

    • URI format

      GET https://{endpoint}/mysql/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}

      -
    • Example

      GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10

      +
    • URI example

      GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10

    • Parameter description
    Table 1 Parameter description

    Name

    Subscription period.

    Values:

    -
    • month: The service is subscribed by month.
    • year: The service is subscribed by year.
    +
    • month: The service is subscribed by month.
    • year: The service is subscribed by year.

    This parameter is valid and mandatory only when charge_mode is set to prePaid.

    diff --git a/docs/taurusdb/api-ref/gaussdb_11_0006.html b/docs/taurusdb/api-ref/gaussdb_11_0006.html index b4452852f..919b87eae 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0006.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0006.html @@ -5,7 +5,7 @@

    URI

    • URI format

      GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}

      -
    • Example

      GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07

      +
    • URI example

      GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07

    • Parameter description
    Table 1 Parameter description

    Name

    diff --git a/docs/taurusdb/api-ref/gaussdb_11_0007.html b/docs/taurusdb/api-ref/gaussdb_11_0007.html index 042a724c2..841a1a75e 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0007.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0007.html @@ -5,7 +5,7 @@

    URI

    • URI format

      DELETE https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}

      -
    • Example

      DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01

      +
    • URI example

      DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01

    • Parameter description
    Table 1 Parameter description

    Name

    @@ -27,7 +27,7 @@ - diff --git a/docs/taurusdb/api-ref/gaussdb_11_0015.html b/docs/taurusdb/api-ref/gaussdb_11_0015.html index 43193c5e1..28b609ff6 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0015.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0015.html @@ -5,7 +5,7 @@

    URI

    • URI format

      POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/nodes/enlarge

      -
    • Example

      POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/enlarge

      +
    • URI example

      POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/enlarge

    • Parameter description
    Table 1 Parameter description

    Name

    Yes

    DB instance ID, which is compliant with the UUID format.

    +

    Instance ID, which is compliant with the UUID format.

    diff --git a/docs/taurusdb/api-ref/gaussdb_11_0016.html b/docs/taurusdb/api-ref/gaussdb_11_0016.html index 4b6306088..edbaaacd6 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0016.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0016.html @@ -5,7 +5,7 @@

    URI

    • URI format

      DELETE https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/nodes/{node_id}

      -
    • Example

      DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/d11ae66fsfdsaer3w3ino9

      +
    • URI example

      DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/d11ae66fsfdsaer3w3ino9

    • Parameter description
    Table 1 Parameter description

    Name

    @@ -27,7 +27,7 @@ -
    Table 1 Parameter description

    Name

    Yes

    DB instance ID, which is compliant with the UUID format.

    +

    Instance ID, which is compliant with the UUID format.

    node_id

    diff --git a/docs/taurusdb/api-ref/gaussdb_11_0018.html b/docs/taurusdb/api-ref/gaussdb_11_0018.html index c275cb5f2..e6cd15ea3 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0018.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0018.html @@ -5,7 +5,7 @@

    URI

    • URI format

      PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/name

      -
    • Example

      PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/name

      +
    • URI example

      PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/name

    • Parameter description
      diff --git a/docs/taurusdb/api-ref/gaussdb_11_0019.html b/docs/taurusdb/api-ref/gaussdb_11_0019.html index 4d67667fb..ea3cbd366 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0019.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0019.html @@ -5,7 +5,7 @@

      URI

      • URI format

        POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/password

        -
      • Example

        POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/password

        +
      • URI example

        POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/password

      • Parameter description
      Table 1 Parameter description

      Name

      @@ -164,8 +164,9 @@
      Table 1 Parameter description

      Name

    -

    Example Request

    Resetting a database password

    -
    POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password
    +

    Example Request

    Resetting a database password

    +
    +POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password
     {
       "password" : "Test_345612"
     }
    diff --git a/docs/taurusdb/api-ref/gaussdb_11_0020.html b/docs/taurusdb/api-ref/gaussdb_11_0020.html index a971a6dda..68320a26c 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0020.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0020.html @@ -5,7 +5,7 @@

    URI

    • URI format

      POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/action

      -
    • Example

      POST https://gaussdb-mysql.eu-de.otc.t-systems.commysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/action

      +
    • URI example

      POST https://gaussdb-mysql.eu-de.otc.t-systems.commysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/action

    • Parameter description
      diff --git a/docs/taurusdb/api-ref/gaussdb_11_0022.html b/docs/taurusdb/api-ref/gaussdb_11_0022.html index df8e46299..071ef9d63 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0022.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0022.html @@ -5,7 +5,7 @@

      URI

      • URI format

        POST https://{endpoint}/mysql/v3/{project_id}/backups/create

        -
      • Example

        POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create

        +
      • URI example

        POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create

      • Parameter description
      Table 1 Parameter description

      Name

      @@ -86,7 +86,7 @@ - - @@ -252,8 +252,10 @@
      Table 1 Parameter description

      Name

      String

      DB instance ID, which is compliant with the UUID format.

      +

      Instance ID, which is compliant with the UUID format.

      name

      @@ -191,7 +191,7 @@

      String

      DB instance ID.

      +

      Instance ID.

    -

    Example Request

    Creating a Manual Backup

    -
    POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create
    +

    Example Request

    Creating a Manual Backup

    +
    +POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create
    +
     {
        "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
        "name": "backup-1",
    diff --git a/docs/taurusdb/api-ref/gaussdb_11_0023.html b/docs/taurusdb/api-ref/gaussdb_11_0023.html
    index d10e799c3..81f2d5f65 100644
    --- a/docs/taurusdb/api-ref/gaussdb_11_0023.html
    +++ b/docs/taurusdb/api-ref/gaussdb_11_0023.html
    @@ -5,7 +5,7 @@
     
     

    URI

    • URI format

      GET https://{endpoint}/mysql/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time}

      -
    • Example

      GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800

      +
    • URI example

      GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800

    • Parameter description
      @@ -226,7 +226,7 @@
      Table 1 Parameter description

      Name

      String

      Backup type. Value:

      -
      • auto: automated full backup
      • manual: manual full backup
      +
      • auto: automated full backup
      • manual: manual full backup

      size

      diff --git a/docs/taurusdb/api-ref/gaussdb_11_0024.html b/docs/taurusdb/api-ref/gaussdb_11_0024.html index 712feec4c..beef25179 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0024.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0024.html @@ -5,7 +5,7 @@

      URI

      • URI format

        GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy

        -
      • Example

        GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy

        +
      • URI example

        GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy

      • Parameter description
        diff --git a/docs/taurusdb/api-ref/gaussdb_11_0025.html b/docs/taurusdb/api-ref/gaussdb_11_0025.html index a90e7ddd1..02be81790 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0025.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0025.html @@ -5,7 +5,7 @@

        URI

        • URI format

          PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy/update

          -
        • Example

          PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy/update

          +
        • URI example

          PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy/update

        • Parameter description
        Table 1 Parameter description

        Name

        diff --git a/docs/taurusdb/api-ref/gaussdb_11_0029.html b/docs/taurusdb/api-ref/gaussdb_11_0029.html index 6cbb7a439..458840eed 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0029.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0029.html @@ -5,7 +5,7 @@

        URI

        • URI format

          GET https://{endpoint}/mysql/v3/{project_id}/quotas

          -
        • Example

          GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas

          +
        • URI example

          GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas

        • Parameter description
        Table 1 Parameter description

        Name

        diff --git a/docs/taurusdb/api-ref/gaussdb_11_0030.html b/docs/taurusdb/api-ref/gaussdb_11_0030.html index 141792d26..5a8c2f252 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0030.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0030.html @@ -5,7 +5,7 @@

        URI

        • URI format

          POST https://{endpoint}/mysql/v3/{project_id}/quotas

          -
        • Example

          POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas

          +
        • URI example

          POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas

        • Parameter description
        Table 1 Parameter description

        Name

        Table 1 Parameter description

        Name

        diff --git a/docs/taurusdb/api-ref/gaussdb_11_0031.html b/docs/taurusdb/api-ref/gaussdb_11_0031.html index e84f43596..4bf0cfc5c 100644 --- a/docs/taurusdb/api-ref/gaussdb_11_0031.html +++ b/docs/taurusdb/api-ref/gaussdb_11_0031.html @@ -5,7 +5,7 @@

        URI

        • URI format

          PUT https://{endpoint}/mysql/v3/{project_id}/quotas

          -
        • Example

          PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas

          +
        • URI example

          PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas

        • Parameter description
          Table 1 Parameter description

          Name

          @@ -259,7 +259,9 @@
        -

        Example Request

        POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas
        +

        Example Request

        +POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas
        +
         {
           "quota_list" : [ {
             "enterprise_project_id" : "0",
        diff --git a/docs/taurusdb/api-ref/topic_300000009.html b/docs/taurusdb/api-ref/topic_300000009.html
        index a06499d51..0a04b30c3 100644
        --- a/docs/taurusdb/api-ref/topic_300000009.html
        +++ b/docs/taurusdb/api-ref/topic_300000009.html
        @@ -1,7 +1,7 @@
         
         
         

        Tag Management

        -

        +