diff --git a/docs/taurusdb/api-ref/ALL_META.TXT.json b/docs/taurusdb/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..21a61c0ce --- /dev/null +++ b/docs/taurusdb/api-ref/ALL_META.TXT.json @@ -0,0 +1,1787 @@ +[ + { + "dockw":"API Reference" + }, + { + "uri":"gaussdb_00_0011.html", + "node_id":"gaussdb_00_0011.xml", + "product_code":"taurusdb", + "code":"1", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Before You Start", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Before You Start", + "githuburl":"" + }, + { + "uri":"gaussdb_00_0001.html", + "node_id":"gaussdb_00_0001.xml", + "product_code":"taurusdb", + "code":"2", + "des":"TaurusDB is a MySQL-compatible, enterprise-grade distributed database service. It decouples compute from storage and supports up to 128 TB of storage per instance. With T", + "doc_type":"api", + "kw":"Overview,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Overview", + "githuburl":"" + }, + { + "uri":"gaussdb_00_0002.html", + "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.", + "doc_type":"api", + "kw":"API Calling,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"API Calling", + "githuburl":"" + }, + { + "uri":"gaussdb_00_0003.html", + "node_id":"gaussdb_00_0003.xml", + "product_code":"taurusdb", + "code":"4", + "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", + "doc_type":"api", + "kw":"Endpoints,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Endpoints", + "githuburl":"" + }, + { + "uri":"gaussdb_00_0004.html", + "node_id":"gaussdb_00_0004.xml", + "product_code":"taurusdb", + "code":"5", + "des":"The number of DB instances that you can create is determined by your quota. To view or increase the quota, see \"Managing Quotas\" in TaurusDB User Guide.For more constrain", + "doc_type":"api", + "kw":"Constraints,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Constraints", + "githuburl":"" + }, + { + "uri":"gaussdb_00_0005.html", + "node_id":"gaussdb_00_0005.xml", + "product_code":"taurusdb", + "code":"6", + "des":"DomainA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user p", + "doc_type":"api", + "kw":"Concepts,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Concepts", + "githuburl":"" + }, + { + "uri":"gaussdb_02_0000.html", + "node_id":"gaussdb_02_0000.xml", + "product_code":"taurusdb", + "code":"7", + "des":"With TaurusDB APIs, you can query, set, and modify resource quotas.", + "doc_type":"api", + "kw":"API Overview,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"API Overview", + "githuburl":"" + }, + { + "uri":"gaussdb_03_0000.html", + "node_id":"gaussdb_03_0000.xml", + "product_code":"taurusdb", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"gaussdb_03_0005.html", + "node_id":"gaussdb_03_0005.xml", + "product_code":"taurusdb", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Making an API Request", + "githuburl":"" + }, + { + "uri":"gaussdb_03_0001.html", + "node_id":"gaussdb_03_0001.xml", + "product_code":"taurusdb", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Authentication", + "githuburl":"" + }, + { + "uri":"gaussdb_03_0006.html", + "node_id":"gaussdb_03_0006.xml", + "product_code":"taurusdb", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Response", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0000.html", + "node_id":"gaussdb_04_0000.xml", + "product_code":"taurusdb", + "code":"12", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"APIs (Recommended)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"APIs (Recommended)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002235108869.html", + "node_id":"en-us_topic_0000002235108869.xml", + "product_code":"taurusdb", + "code":"13", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API Version Queries", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"API Version Queries", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002235229005.html", + "node_id":"en-us_topic_0000002235229005.xml", + "product_code":"taurusdb", + "code":"14", + "des":"This API is used to query API versions. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /NoneStatus code: 2", + "doc_type":"api", + "kw":"Querying API Versions,API Version Queries,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying API Versions", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002200308556.html", + "node_id":"en-us_topic_0000002200308556.xml", + "product_code":"taurusdb", + "code":"15", + "des":"This API is used to query a specified API version. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /{versio", + "doc_type":"api", + "kw":"Querying a Specified API Version,API Version Queries,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying a Specified API Version", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0001.html", + "node_id":"gaussdb_04_0001.xml", + "product_code":"taurusdb", + "code":"16", + "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 (Recommended),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Version Information About a DB Engine", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0002.html", + "node_id":"gaussdb_04_0002.xml", + "product_code":"taurusdb", + "code":"17", + "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 (Recommended),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Database Specifications", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0003.html", + "node_id":"gaussdb_04_0003.xml", + "product_code":"taurusdb", + "code":"18", + "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":"Managing DB Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Managing DB Instances", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0004.html", + "node_id":"gaussdb_04_0004.xml", + "product_code":"taurusdb", + "code":"19", + "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.POST /v3/{project_id}", + "doc_type":"api", + "kw":"Creating a DB Instance,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Creating a DB Instance", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0005.html", + "node_id":"gaussdb_04_0005.xml", + "product_code":"taurusdb", + "code":"20", + "des":"This API is used to query DB instances according to search criteria. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpo", + "doc_type":"api", + "kw":"Querying DB Instances,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying DB Instances", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0007.html", + "node_id":"gaussdb_04_0007.xml", + "product_code":"taurusdb", + "code":"21", + "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.DELETE /v3/{project_i", + "doc_type":"api", + "kw":"Deleting a DB Instance,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Deleting a DB Instance", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0006.html", + "node_id":"gaussdb_04_0006.xml", + "product_code":"taurusdb", + "code":"22", + "des":"This API is used to query the details of a specified DB instance. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint", + "doc_type":"api", + "kw":"Querying Details of a DB Instance,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Details of a DB Instance", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0015.html", + "node_id":"gaussdb_04_0015.xml", + "product_code":"taurusdb", + "code":"23", + "des":"This API is used to create a read replica. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/{project_id}/", + "doc_type":"api", + "kw":"Creating a Read Replica,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Creating a Read Replica", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0016.html", + "node_id":"gaussdb_04_0016.xml", + "product_code":"taurusdb", + "code":"24", + "des":"This API is used to delete a read replica. For multi-AZ deployment, the primary node and remaining read replicas must be located in different AZs after read replicas are ", + "doc_type":"api", + "kw":"Deleting a Read Replica,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Deleting a Read Replica", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0018.html", + "node_id":"gaussdb_04_0018.xml", + "product_code":"taurusdb", + "code":"25", + "des":"This API is used to change a DB instance name. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.PUT /v3/{project_i", + "doc_type":"api", + "kw":"Changing a DB Instance Name,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Changing a DB Instance Name", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0019.html", + "node_id":"gaussdb_04_0019.xml", + "product_code":"taurusdb", + "code":"26", + "des":"This API is used to reset a database password. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/{project_", + "doc_type":"api", + "kw":"Resetting a Database Password,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Resetting a Database Password", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0020.html", + "node_id":"gaussdb_04_0020.xml", + "product_code":"taurusdb", + "code":"27", + "des":"This API is used to change DB instance specifications. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/{", + "doc_type":"api", + "kw":"Changing DB Instance Specifications,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Changing DB Instance Specifications", + "githuburl":"" + }, + { + "uri":"UpdateInstanceMonitor.html", + "node_id":"updateinstancemonitor.xml", + "product_code":"taurusdb", + "code":"28", + "des":"This API is used to enable and disable Monitoring by Seconds, and change its collection period. Before calling this API, you can:Learn how to authorize and authenticate i", + "doc_type":"api", + "kw":"Changing the Collection Period of Monitoring by Seconds,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Changing the Collection Period of Monitoring by Seconds", + "githuburl":"" + }, + { + "uri":"ShowInstanceMonitorExtend.html", + "node_id":"showinstancemonitorextend.xml", + "product_code":"taurusdb", + "code":"29", + "des":"This API is used to query the collection period of Monitoring by Seconds. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region an", + "doc_type":"api", + "kw":"Querying the Collection Period of Monitoring by Seconds,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying the Collection Period of Monitoring by Seconds", + "githuburl":"" + }, + { + "uri":"UpdateGaussMySqlInstancePort.html", + "node_id":"updategaussmysqlinstanceport.xml", + "product_code":"taurusdb", + "code":"30", + "des":"This API is used to change the database port of a DB instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.", + "doc_type":"api", + "kw":"Changing a Database Port,Managing DB Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Changing a Database Port", + "githuburl":"" + }, + { + "uri":"gaussdb_06_0002.html", + "node_id":"gaussdb_06_0002.xml", + "product_code":"taurusdb", + "code":"31", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Backup Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Backup Management", + "githuburl":"" + }, + { + "uri":"gaussdb_06_0003.html", + "node_id":"gaussdb_06_0003.xml", + "product_code":"taurusdb", + "code":"32", + "des":"This API is used to create a manual backup. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/{project_id}", + "doc_type":"api", + "kw":"Creating a Manual Backup,Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Creating a Manual Backup", + "githuburl":"" + }, + { + "uri":"gaussdb_06_0004.html", + "node_id":"gaussdb_06_0004.xml", + "product_code":"taurusdb", + "code":"33", + "des":"This API is used to query backups according to search criteria. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.G", + "doc_type":"api", + "kw":"Querying Backups,Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Backups", + "githuburl":"" + }, + { + "uri":"gaussdb_06_0005.html", + "node_id":"gaussdb_06_0005.xml", + "product_code":"taurusdb", + "code":"34", + "des":"This API is used to query an automated backup policy. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /v3/{pr", + "doc_type":"api", + "kw":"Querying an Automated Backup Policy,Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying an Automated Backup Policy", + "githuburl":"" + }, + { + "uri":"gaussdb_06_0006.html", + "node_id":"gaussdb_06_0006.xml", + "product_code":"taurusdb", + "code":"35", + "des":"This API is used to modify an automated backup policy. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.PUT /v3/{p", + "doc_type":"api", + "kw":"Modifying an Automated Backup Policy,Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Modifying an Automated Backup Policy", + "githuburl":"" + }, + { + "uri":"DeleteGaussMySqlBackup.html", + "node_id":"deletegaussmysqlbackup.xml", + "product_code":"taurusdb", + "code":"36", + "des":"This API is used to delete a manual backup. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.DELETE /v3/{project", + "doc_type":"api", + "kw":"Deleting a Manual Backup,Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Deleting a Manual Backup", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0008.html", + "node_id":"gaussdb_04_0008.xml", + "product_code":"taurusdb", + "code":"37", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Parameter Template Management", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0009.html", + "node_id":"gaussdb_04_0009.xml", + "product_code":"taurusdb", + "code":"38", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Parameter Templates", + "githuburl":"" + }, + { + "uri":"ListInstanceConfigurations.html", + "node_id":"listinstanceconfigurations.xml", + "product_code":"taurusdb", + "code":"39", + "des":"This API is used to obtain parameter information of a specified DB instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region", + "doc_type":"api", + "kw":"Obtaining Parameter Information of a Specified DB Instance,Parameter Template Management,API Referen", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Obtaining Parameter Information of a Specified DB Instance", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0010.html", + "node_id":"gaussdb_04_0010.xml", + "product_code":"taurusdb", + "code":"40", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Quota Management", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0011.html", + "node_id":"gaussdb_04_0011.xml", + "product_code":"taurusdb", + "code":"41", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Resource Quotas", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0012.html", + "node_id":"gaussdb_04_0012.xml", + "product_code":"taurusdb", + "code":"42", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Configuring Resource Quotas", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0013.html", + "node_id":"gaussdb_04_0013.xml", + "product_code":"taurusdb", + "code":"43", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Modifying Resource Quotas", + "githuburl":"" + }, + { + "uri":"ShowGaussMySqlProjectQuotas.html", + "node_id":"showgaussmysqlprojectquotas.xml", + "product_code":"taurusdb", + "code":"44", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying the DB Instance Quotas of a Tenant", + "githuburl":"" + }, + { + "uri":"topic_300000006.html", + "node_id":"topic_300000006.xml", + "product_code":"taurusdb", + "code":"45", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Database Proxy", + "githuburl":"" + }, + { + "uri":"CreateGaussMySqlProxy.html", + "node_id":"creategaussmysqlproxy.xml", + "product_code":"taurusdb", + "code":"46", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Enabling Database Proxy", + "githuburl":"" + }, + { + "uri":"DeleteGaussMySqlProxy.html", + "node_id":"deletegaussmysqlproxy.xml", + "product_code":"taurusdb", + "code":"47", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Disabling Database Proxy", + "githuburl":"" + }, + { + "uri":"ShowGaussMySqlProxyList.html", + "node_id":"showgaussmysqlproxylist.xml", + "product_code":"taurusdb", + "code":"48", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Database Proxy Instances", + "githuburl":"" + }, + { + "uri":"ShowGaussMySqlProxyFlavors.html", + "node_id":"showgaussmysqlproxyflavors.xml", + "product_code":"taurusdb", + "code":"49", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Database Proxy Specifications", + "githuburl":"" + }, + { + "uri":"ExpandGaussMySqlProxy.html", + "node_id":"expandgaussmysqlproxy.xml", + "product_code":"taurusdb", + "code":"50", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Adding Database Proxy Nodes", + "githuburl":"" + }, + { + "uri":"ChangeGaussMySqlProxySpecification.html", + "node_id":"changegaussmysqlproxyspecification.xml", + "product_code":"taurusdb", + "code":"51", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Changing Specifications of a Database Proxy Instance", + "githuburl":"" + }, + { + "uri":"SetGaussMySqlProxyWeight.html", + "node_id":"setgaussmysqlproxyweight.xml", + "product_code":"taurusdb", + "code":"52", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Assigning Read Weights", + "githuburl":"" + }, + { + "uri":"topic_300000007.html", + "node_id":"topic_300000007.xml", + "product_code":"taurusdb", + "code":"53", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Log Management", + "githuburl":"" + }, + { + "uri":"ListGaussMySqlErrorLog.html", + "node_id":"listgaussmysqlerrorlog.xml", + "product_code":"taurusdb", + "code":"54", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Database Error Logs", + "githuburl":"" + }, + { + "uri":"ListGaussMySqlSlowLog.html", + "node_id":"listgaussmysqlslowlog.xml", + "product_code":"taurusdb", + "code":"55", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Database Slow Logs", + "githuburl":"" + }, + { + "uri":"topic_300000009.html", + "node_id":"topic_300000009.xml", + "product_code":"taurusdb", + "code":"56", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"ListInstanceTags.html", + "node_id":"listinstancetags.xml", + "product_code":"taurusdb", + "code":"57", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Resource Tags", + "githuburl":"" + }, + { + "uri":"ListProjectTags.html", + "node_id":"listprojecttags.xml", + "product_code":"taurusdb", + "code":"58", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Project Tags", + "githuburl":"" + }, + { + "uri":"BatchTagAction.html", + "node_id":"batchtagaction.xml", + "product_code":"taurusdb", + "code":"59", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Adding or Deleting Tags in Batches", + "githuburl":"" + }, + { + "uri":"topic_300000012.html", + "node_id":"topic_300000012.xml", + "product_code":"taurusdb", + "code":"60", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"SQL Statement Concurrency Control", + "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", + "doc_type":"api", + "kw":"Enabling or Disabling SQL Statement Concurrency Control,SQL Statement Concurrency Control,API Refere", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Enabling or Disabling SQL Statement Concurrency Control", + "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", + "doc_type":"api", + "kw":"Querying Whether SQL Statement Concurrency Control Is Enabled,SQL Statement Concurrency Control,API ", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Whether SQL Statement Concurrency Control 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", + "doc_type":"api", + "kw":"Configuring Concurrency Control Rules of SQL Statements,SQL Statement Concurrency Control,API Refere", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Configuring Concurrency Control Rules of SQL Statements", + "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", + "doc_type":"api", + "kw":"Querying Concurrency Control Rules of SQL Statements,SQL Statement Concurrency Control,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Concurrency Control Rules of SQL Statements", + "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 ", + "doc_type":"api", + "kw":"Deleting Concurrency Control Rules of SQL Statements,SQL Statement Concurrency Control,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Deleting Concurrency Control Rules of SQL Statements", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0014.html", + "node_id":"gaussdb_04_0014.xml", + "product_code":"taurusdb", + "code":"66", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Task Center", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Task Center", + "githuburl":"" + }, + { + "uri":"ShowGaussMySqlJobInfo.html", + "node_id":"showgaussmysqljobinfo.xml", + "product_code":"taurusdb", + "code":"67", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Obtaining Information About a Task with a Specified ID", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0000.html", + "node_id":"gaussdb_11_0000.xml", + "product_code":"taurusdb", + "code":"68", + "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)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"APIs (Unavailable Soon)", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0001.html", + "node_id":"gaussdb_11_0001.xml", + "product_code":"taurusdb", + "code":"69", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Version Information About a DB Engine", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0002.html", + "node_id":"gaussdb_11_0002.xml", + "product_code":"taurusdb", + "code":"70", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Database Specifications", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0003.html", + "node_id":"gaussdb_11_0003.xml", + "product_code":"taurusdb", + "code":"71", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Instance Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Instance Management", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0004.html", + "node_id":"gaussdb_11_0004.xml", + "product_code":"taurusdb", + "code":"72", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Creating a DB Instance", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0005.html", + "node_id":"gaussdb_11_0005.xml", + "product_code":"taurusdb", + "code":"73", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying DB Instances", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0006.html", + "node_id":"gaussdb_11_0006.xml", + "product_code":"taurusdb", + "code":"74", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Details of a DB Instance", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0007.html", + "node_id":"gaussdb_11_0007.xml", + "product_code":"taurusdb", + "code":"75", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Deleting a DB Instance", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0015.html", + "node_id":"gaussdb_11_0015.xml", + "product_code":"taurusdb", + "code":"76", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Creating a Read Replica", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0016.html", + "node_id":"gaussdb_11_0016.xml", + "product_code":"taurusdb", + "code":"77", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Deleting a Read Replica", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0018.html", + "node_id":"gaussdb_11_0018.xml", + "product_code":"taurusdb", + "code":"78", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Changing a DB Instance Name", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0019.html", + "node_id":"gaussdb_11_0019.xml", + "product_code":"taurusdb", + "code":"79", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Resetting a Database Password", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0020.html", + "node_id":"gaussdb_11_0020.xml", + "product_code":"taurusdb", + "code":"80", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Changing DB Instance Specifications", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0021.html", + "node_id":"gaussdb_11_0021.xml", + "product_code":"taurusdb", + "code":"81", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Backup Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Backup Management", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0022.html", + "node_id":"gaussdb_11_0022.xml", + "product_code":"taurusdb", + "code":"82", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Creating a Manual Backup", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0023.html", + "node_id":"gaussdb_11_0023.xml", + "product_code":"taurusdb", + "code":"83", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Backups", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0024.html", + "node_id":"gaussdb_11_0024.xml", + "product_code":"taurusdb", + "code":"84", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying an Automated Backup Policy", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0025.html", + "node_id":"gaussdb_11_0025.xml", + "product_code":"taurusdb", + "code":"85", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Modifying the Backup Policy", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0026.html", + "node_id":"gaussdb_11_0026.xml", + "product_code":"taurusdb", + "code":"86", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Parameter Template Management", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0027.html", + "node_id":"gaussdb_11_0027.xml", + "product_code":"taurusdb", + "code":"87", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Parameter Templates", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0028.html", + "node_id":"gaussdb_11_0028.xml", + "product_code":"taurusdb", + "code":"88", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Quota Management", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0029.html", + "node_id":"gaussdb_11_0029.xml", + "product_code":"taurusdb", + "code":"89", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Querying Enterprise Project Resource Quotas of a Tenant", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0030.html", + "node_id":"gaussdb_11_0030.xml", + "product_code":"taurusdb", + "code":"90", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Configuring Enterprise Project Resource Quotas of a Tenant", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0031.html", + "node_id":"gaussdb_11_0031.xml", + "product_code":"taurusdb", + "code":"91", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Modifying Enterprise Project Resource Quotas of a Tenant", + "githuburl":"" + }, + { + "uri":"gaussdb_11_0032.html", + "node_id":"gaussdb_11_0032.xml", + "product_code":"taurusdb", + "code":"92", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Obtaining Information About a Task with a Specified ID", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0000.html", + "node_id":"gaussdb_10_0000.xml", + "product_code":"taurusdb", + "code":"93", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Appendix", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0001.html", + "node_id":"gaussdb_10_0001.xml", + "product_code":"taurusdb", + "code":"94", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Abnormal Request Results", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0002.html", + "node_id":"gaussdb_10_0002.xml", + "product_code":"taurusdb", + "code":"95", + "des":"The following table describes status codes.", + "doc_type":"api", + "kw":"Status Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0003.html", + "node_id":"gaussdb_10_0003.xml", + "product_code":"taurusdb", + "code":"96", + "des":"The following table describes error codes.", + "doc_type":"api", + "kw":"Error Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0004.html", + "node_id":"gaussdb_10_0004.xml", + "product_code":"taurusdb", + "code":"97", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Obtaining a Project ID", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0006.html", + "node_id":"gaussdb_10_0006.xml", + "product_code":"taurusdb", + "code":"98", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"TaurusDB Metrics", + "githuburl":"" + }, + { + "uri":"changeHistory.html", + "node_id":"changehistory.xml", + "product_code":"taurusdb", + "code":"99", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"taurusdb" + } + ], + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/taurusdb/api-ref/BatchTagAction.html b/docs/taurusdb/api-ref/BatchTagAction.html new file mode 100644 index 000000000..3b005022a --- /dev/null +++ b/docs/taurusdb/api-ref/BatchTagAction.html @@ -0,0 +1,235 @@ + + +

Adding or Deleting Tags in Batches

+

Function

This API is used to add tags to or delete tags from a specified DB instance in batches. Before calling this API:

+ +
+

URI

POST /v3/{project_id}/instances/{instance_id}/tags/action

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

Yes

+

String

+

Action. Value:

+
  • create
  • delete
+

tags

+

Yes

+

Array of TagItem objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 TagItem

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key. It contains a maximum of 36 Unicode characters and cannot be null, an empty string, or a space. Only digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-) are allowed.

+

value

+

No

+

String

+

Tag value. It contains a maximum of 43 Unicode characters. It can be an empty string but cannot be a space. Only digits, uppercase letters, lowercase letters, underscores (_), periods (.), and hyphens (-) are allowed.

+
  • If action is set to create, this parameter is mandatory.
  • If action is set to delete and value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key.
+
+
+
+

Response Parameters

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

+
+

Example Response

Status code: 200

+

Success.

+

None

+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/taurusdb/api-ref/CLASS.TXT.json b/docs/taurusdb/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..d43caf1b4 --- /dev/null +++ b/docs/taurusdb/api-ref/CLASS.TXT.json @@ -0,0 +1,893 @@ +[ + { + "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":"Before You Start", + "uri":"gaussdb_00_0011.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"TaurusDB is a MySQL-compatible, enterprise-grade distributed database service. It decouples compute from storage and supports up to 128 TB of storage per instance. With T", + "product_code":"taurusdb", + "title":"Overview", + "uri":"gaussdb_00_0001.html", + "doc_type":"api", + "p_code":"1", + "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.", + "product_code":"taurusdb", + "title":"API Calling", + "uri":"gaussdb_00_0002.html", + "doc_type":"api", + "p_code":"1", + "code":"3" + }, + { + "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", + "product_code":"taurusdb", + "title":"Endpoints", + "uri":"gaussdb_00_0003.html", + "doc_type":"api", + "p_code":"1", + "code":"4" + }, + { + "desc":"The number of DB instances that you can create is determined by your quota. To view or increase the quota, see \"Managing Quotas\" in TaurusDB User Guide.For more constrain", + "product_code":"taurusdb", + "title":"Constraints", + "uri":"gaussdb_00_0004.html", + "doc_type":"api", + "p_code":"1", + "code":"5" + }, + { + "desc":"DomainA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user p", + "product_code":"taurusdb", + "title":"Concepts", + "uri":"gaussdb_00_0005.html", + "doc_type":"api", + "p_code":"1", + "code":"6" + }, + { + "desc":"With TaurusDB APIs, you can query, set, and modify resource quotas.", + "product_code":"taurusdb", + "title":"API Overview", + "uri":"gaussdb_02_0000.html", + "doc_type":"api", + "p_code":"", + "code":"7" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"taurusdb", + "title":"API Usage Guidelines", + "uri":"gaussdb_03_0000.html", + "doc_type":"api", + "p_code":"", + "code":"8" + }, + { + "desc":"This section describes the structure of a REST API, and uses the IAM API for obtaining a user token as an example to describe how to call an API. The obtained token is us", + "product_code":"taurusdb", + "title":"Making an API Request", + "uri":"gaussdb_03_0005.html", + "doc_type":"api", + "p_code":"8", + "code":"9" + }, + { + "desc":"Token authentication must be performed to call APIs.Authentication using tokens: General requests are authenticated using tokens.The validity period of a token is 24 hour", + "product_code":"taurusdb", + "title":"Authentication", + "uri":"gaussdb_03_0001.html", + "doc_type":"api", + "p_code":"8", + "code":"10" + }, + { + "desc":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits ranging from 1xx to", + "product_code":"taurusdb", + "title":"Response", + "uri":"gaussdb_03_0006.html", + "doc_type":"api", + "p_code":"8", + "code":"11" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"taurusdb", + "title":"APIs (Recommended)", + "uri":"gaussdb_04_0000.html", + "doc_type":"api", + "p_code":"", + "code":"12" + }, + { + "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 Version Queries", + "uri":"en-us_topic_0000002235108869.html", + "doc_type":"api", + "p_code":"12", + "code":"13" + }, + { + "desc":"This API is used to query API versions. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /NoneStatus code: 2", + "product_code":"taurusdb", + "title":"Querying API Versions", + "uri":"en-us_topic_0000002235229005.html", + "doc_type":"api", + "p_code":"13", + "code":"14" + }, + { + "desc":"This API is used to query a specified API version. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /{versio", + "product_code":"taurusdb", + "title":"Querying a Specified API Version", + "uri":"en-us_topic_0000002200308556.html", + "doc_type":"api", + "p_code":"13", + "code":"15" + }, + { + "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 ", + "product_code":"taurusdb", + "title":"Querying Version Information About a DB Engine", + "uri":"gaussdb_04_0001.html", + "doc_type":"api", + "p_code":"12", + "code":"16" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Database Specifications", + "uri":"gaussdb_04_0002.html", + "doc_type":"api", + "p_code":"12", + "code":"17" + }, + { + "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":"Managing DB Instances", + "uri":"gaussdb_04_0003.html", + "doc_type":"api", + "p_code":"12", + "code":"18" + }, + { + "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.POST /v3/{project_id}", + "product_code":"taurusdb", + "title":"Creating a DB Instance", + "uri":"gaussdb_04_0004.html", + "doc_type":"api", + "p_code":"18", + "code":"19" + }, + { + "desc":"This API is used to query DB instances according to search criteria. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpo", + "product_code":"taurusdb", + "title":"Querying DB Instances", + "uri":"gaussdb_04_0005.html", + "doc_type":"api", + "p_code":"18", + "code":"20" + }, + { + "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.DELETE /v3/{project_i", + "product_code":"taurusdb", + "title":"Deleting a DB Instance", + "uri":"gaussdb_04_0007.html", + "doc_type":"api", + "p_code":"18", + "code":"21" + }, + { + "desc":"This API is used to query the details of a specified DB instance. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint", + "product_code":"taurusdb", + "title":"Querying Details of a DB Instance", + "uri":"gaussdb_04_0006.html", + "doc_type":"api", + "p_code":"18", + "code":"22" + }, + { + "desc":"This API is used to create a read replica. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/{project_id}/", + "product_code":"taurusdb", + "title":"Creating a Read Replica", + "uri":"gaussdb_04_0015.html", + "doc_type":"api", + "p_code":"18", + "code":"23" + }, + { + "desc":"This API is used to delete a read replica. For multi-AZ deployment, the primary node and remaining read replicas must be located in different AZs after read replicas are ", + "product_code":"taurusdb", + "title":"Deleting a Read Replica", + "uri":"gaussdb_04_0016.html", + "doc_type":"api", + "p_code":"18", + "code":"24" + }, + { + "desc":"This API is used to change a DB instance name. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.PUT /v3/{project_i", + "product_code":"taurusdb", + "title":"Changing a DB Instance Name", + "uri":"gaussdb_04_0018.html", + "doc_type":"api", + "p_code":"18", + "code":"25" + }, + { + "desc":"This API is used to reset a database password. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/{project_", + "product_code":"taurusdb", + "title":"Resetting a Database Password", + "uri":"gaussdb_04_0019.html", + "doc_type":"api", + "p_code":"18", + "code":"26" + }, + { + "desc":"This API is used to change DB instance specifications. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/{", + "product_code":"taurusdb", + "title":"Changing DB Instance Specifications", + "uri":"gaussdb_04_0020.html", + "doc_type":"api", + "p_code":"18", + "code":"27" + }, + { + "desc":"This API is used to enable and disable Monitoring by Seconds, and change its collection period. Before calling this API, you can:Learn how to authorize and authenticate i", + "product_code":"taurusdb", + "title":"Changing the Collection Period of Monitoring by Seconds", + "uri":"UpdateInstanceMonitor.html", + "doc_type":"api", + "p_code":"18", + "code":"28" + }, + { + "desc":"This API is used to query the collection period of Monitoring by Seconds. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region an", + "product_code":"taurusdb", + "title":"Querying the Collection Period of Monitoring by Seconds", + "uri":"ShowInstanceMonitorExtend.html", + "doc_type":"api", + "p_code":"18", + "code":"29" + }, + { + "desc":"This API is used to change the database port of a DB instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.", + "product_code":"taurusdb", + "title":"Changing a Database Port", + "uri":"UpdateGaussMySqlInstancePort.html", + "doc_type":"api", + "p_code":"18", + "code":"30" + }, + { + "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":"Backup Management", + "uri":"gaussdb_06_0002.html", + "doc_type":"api", + "p_code":"12", + "code":"31" + }, + { + "desc":"This API is used to create a manual backup. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.POST /v3/{project_id}", + "product_code":"taurusdb", + "title":"Creating a Manual Backup", + "uri":"gaussdb_06_0003.html", + "doc_type":"api", + "p_code":"31", + "code":"32" + }, + { + "desc":"This API is used to query backups according to search criteria. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.G", + "product_code":"taurusdb", + "title":"Querying Backups", + "uri":"gaussdb_06_0004.html", + "doc_type":"api", + "p_code":"31", + "code":"33" + }, + { + "desc":"This API is used to query an automated backup policy. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.GET /v3/{pr", + "product_code":"taurusdb", + "title":"Querying an Automated Backup Policy", + "uri":"gaussdb_06_0005.html", + "doc_type":"api", + "p_code":"31", + "code":"34" + }, + { + "desc":"This API is used to modify an automated backup policy. Before using this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.PUT /v3/{p", + "product_code":"taurusdb", + "title":"Modifying an Automated Backup Policy", + "uri":"gaussdb_06_0006.html", + "doc_type":"api", + "p_code":"31", + "code":"35" + }, + { + "desc":"This API is used to delete a manual backup. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region and endpoint.DELETE /v3/{project", + "product_code":"taurusdb", + "title":"Deleting a Manual Backup", + "uri":"DeleteGaussMySqlBackup.html", + "doc_type":"api", + "p_code":"31", + "code":"36" + }, + { + "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":"Parameter Template Management", + "uri":"gaussdb_04_0008.html", + "doc_type":"api", + "p_code":"12", + "code":"37" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Parameter Templates", + "uri":"gaussdb_04_0009.html", + "doc_type":"api", + "p_code":"37", + "code":"38" + }, + { + "desc":"This API is used to obtain parameter information of a specified DB instance. Before calling this API:Learn how to authorize and authenticate it.Obtain the required region", + "product_code":"taurusdb", + "title":"Obtaining Parameter Information of a Specified DB Instance", + "uri":"ListInstanceConfigurations.html", + "doc_type":"api", + "p_code":"37", + "code":"39" + }, + { + "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":"Quota Management", + "uri":"gaussdb_04_0010.html", + "doc_type":"api", + "p_code":"12", + "code":"40" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Resource Quotas", + "uri":"gaussdb_04_0011.html", + "doc_type":"api", + "p_code":"40", + "code":"41" + }, + { + "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", + "product_code":"taurusdb", + "title":"Configuring Resource Quotas", + "uri":"gaussdb_04_0012.html", + "doc_type":"api", + "p_code":"40", + "code":"42" + }, + { + "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 ", + "product_code":"taurusdb", + "title":"Modifying Resource Quotas", + "uri":"gaussdb_04_0013.html", + "doc_type":"api", + "p_code":"40", + "code":"43" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying the DB Instance Quotas of a Tenant", + "uri":"ShowGaussMySqlProjectQuotas.html", + "doc_type":"api", + "p_code":"40", + "code":"44" + }, + { + "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":"Database Proxy", + "uri":"topic_300000006.html", + "doc_type":"api", + "p_code":"12", + "code":"45" + }, + { + "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/{", + "product_code":"taurusdb", + "title":"Enabling Database Proxy", + "uri":"CreateGaussMySqlProxy.html", + "doc_type":"api", + "p_code":"45", + "code":"46" + }, + { + "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", + "product_code":"taurusdb", + "title":"Disabling Database Proxy", + "uri":"DeleteGaussMySqlProxy.html", + "doc_type":"api", + "p_code":"45", + "code":"47" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Database Proxy Instances", + "uri":"ShowGaussMySqlProxyList.html", + "doc_type":"api", + "p_code":"45", + "code":"48" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Database Proxy Specifications", + "uri":"ShowGaussMySqlProxyFlavors.html", + "doc_type":"api", + "p_code":"45", + "code":"49" + }, + { + "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", + "product_code":"taurusdb", + "title":"Adding Database Proxy Nodes", + "uri":"ExpandGaussMySqlProxy.html", + "doc_type":"api", + "p_code":"45", + "code":"50" + }, + { + "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 ", + "product_code":"taurusdb", + "title":"Changing Specifications of a Database Proxy Instance", + "uri":"ChangeGaussMySqlProxySpecification.html", + "doc_type":"api", + "p_code":"45", + "code":"51" + }, + { + "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", + "product_code":"taurusdb", + "title":"Assigning Read Weights", + "uri":"SetGaussMySqlProxyWeight.html", + "doc_type":"api", + "p_code":"45", + "code":"52" + }, + { + "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":"Log Management", + "uri":"topic_300000007.html", + "doc_type":"api", + "p_code":"12", + "code":"53" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Database Error Logs", + "uri":"ListGaussMySqlErrorLog.html", + "doc_type":"api", + "p_code":"53", + "code":"54" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Database Slow Logs", + "uri":"ListGaussMySqlSlowLog.html", + "doc_type":"api", + "p_code":"53", + "code":"55" + }, + { + "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":"Tag Management", + "uri":"topic_300000009.html", + "doc_type":"api", + "p_code":"12", + "code":"56" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Resource Tags", + "uri":"ListInstanceTags.html", + "doc_type":"api", + "p_code":"56", + "code":"57" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Project Tags", + "uri":"ListProjectTags.html", + "doc_type":"api", + "p_code":"56", + "code":"58" + }, + { + "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", + "product_code":"taurusdb", + "title":"Adding or Deleting Tags in Batches", + "uri":"BatchTagAction.html", + "doc_type":"api", + "p_code":"56", + "code":"59" + }, + { + "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", + "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", + "product_code":"taurusdb", + "title":"Querying Whether SQL Statement Concurrency Control Is Enabled", + "uri":"ShowSqlFilterControl.html", + "doc_type":"api", + "p_code":"60", + "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", + "product_code":"taurusdb", + "title":"Configuring Concurrency Control Rules of SQL Statements", + "uri":"SetSqlFilterRule.html", + "doc_type":"api", + "p_code":"60", + "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", + "product_code":"taurusdb", + "title":"Querying Concurrency Control Rules of SQL Statements", + "uri":"ShowSqlFilterRule.html", + "doc_type":"api", + "p_code":"60", + "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 ", + "product_code":"taurusdb", + "title":"Deleting Concurrency Control Rules of SQL Statements", + "uri":"DeleteSqlFilterRule.html", + "doc_type":"api", + "p_code":"60", + "code":"65" + }, + { + "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":"Task Center", + "uri":"gaussdb_04_0014.html", + "doc_type":"api", + "p_code":"12", + "code":"66" + }, + { + "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", + "product_code":"taurusdb", + "title":"Obtaining Information About a Task with a Specified ID", + "uri":"ShowGaussMySqlJobInfo.html", + "doc_type":"api", + "p_code":"66", + "code":"67" + }, + { + "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":"APIs (Unavailable Soon)", + "uri":"gaussdb_11_0000.html", + "doc_type":"api", + "p_code":"", + "code":"68" + }, + { + "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 ", + "product_code":"taurusdb", + "title":"Querying Version Information About a DB Engine", + "uri":"gaussdb_11_0001.html", + "doc_type":"api", + "p_code":"68", + "code":"69" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Database Specifications", + "uri":"gaussdb_11_0002.html", + "doc_type":"api", + "p_code":"68", + "code":"70" + }, + { + "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":"Instance Management", + "uri":"gaussdb_11_0003.html", + "doc_type":"api", + "p_code":"68", + "code":"71" + }, + { + "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:", + "product_code":"taurusdb", + "title":"Creating a DB Instance", + "uri":"gaussdb_11_0004.html", + "doc_type":"api", + "p_code":"71", + "code":"72" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying DB Instances", + "uri":"gaussdb_11_0005.html", + "doc_type":"api", + "p_code":"71", + "code":"73" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Details of a DB Instance", + "uri":"gaussdb_11_0006.html", + "doc_type":"api", + "p_code":"71", + "code":"74" + }, + { + "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", + "product_code":"taurusdb", + "title":"Deleting a DB Instance", + "uri":"gaussdb_11_0007.html", + "doc_type":"api", + "p_code":"71", + "code":"75" + }, + { + "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", + "product_code":"taurusdb", + "title":"Creating a Read Replica", + "uri":"gaussdb_11_0015.html", + "doc_type":"api", + "p_code":"71", + "code":"76" + }, + { + "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", + "product_code":"taurusdb", + "title":"Deleting a Read Replica", + "uri":"gaussdb_11_0016.html", + "doc_type":"api", + "p_code":"71", + "code":"77" + }, + { + "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", + "product_code":"taurusdb", + "title":"Changing a DB Instance Name", + "uri":"gaussdb_11_0018.html", + "doc_type":"api", + "p_code":"71", + "code":"78" + }, + { + "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", + "product_code":"taurusdb", + "title":"Resetting a Database Password", + "uri":"gaussdb_11_0019.html", + "doc_type":"api", + "p_code":"71", + "code":"79" + }, + { + "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", + "product_code":"taurusdb", + "title":"Changing DB Instance Specifications", + "uri":"gaussdb_11_0020.html", + "doc_type":"api", + "p_code":"71", + "code":"80" + }, + { + "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":"Backup Management", + "uri":"gaussdb_11_0021.html", + "doc_type":"api", + "p_code":"68", + "code":"81" + }, + { + "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", + "product_code":"taurusdb", + "title":"Creating a Manual Backup", + "uri":"gaussdb_11_0022.html", + "doc_type":"api", + "p_code":"81", + "code":"82" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Backups", + "uri":"gaussdb_11_0023.html", + "doc_type":"api", + "p_code":"81", + "code":"83" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying an Automated Backup Policy", + "uri":"gaussdb_11_0024.html", + "doc_type":"api", + "p_code":"81", + "code":"84" + }, + { + "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", + "product_code":"taurusdb", + "title":"Modifying the Backup Policy", + "uri":"gaussdb_11_0025.html", + "doc_type":"api", + "p_code":"81", + "code":"85" + }, + { + "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":"Parameter Template Management", + "uri":"gaussdb_11_0026.html", + "doc_type":"api", + "p_code":"68", + "code":"86" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Parameter Templates", + "uri":"gaussdb_11_0027.html", + "doc_type":"api", + "p_code":"86", + "code":"87" + }, + { + "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":"Quota Management", + "uri":"gaussdb_11_0028.html", + "doc_type":"api", + "p_code":"68", + "code":"88" + }, + { + "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", + "product_code":"taurusdb", + "title":"Querying Enterprise Project Resource Quotas of a Tenant", + "uri":"gaussdb_11_0029.html", + "doc_type":"api", + "p_code":"88", + "code":"89" + }, + { + "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", + "product_code":"taurusdb", + "title":"Configuring Enterprise Project Resource Quotas of a Tenant", + "uri":"gaussdb_11_0030.html", + "doc_type":"api", + "p_code":"88", + "code":"90" + }, + { + "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", + "product_code":"taurusdb", + "title":"Modifying Enterprise Project Resource Quotas of a Tenant", + "uri":"gaussdb_11_0031.html", + "doc_type":"api", + "p_code":"88", + "code":"91" + }, + { + "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", + "product_code":"taurusdb", + "title":"Obtaining Information About a Task with a Specified ID", + "uri":"gaussdb_11_0032.html", + "doc_type":"api", + "p_code":"68", + "code":"92" + }, + { + "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":"Appendix", + "uri":"gaussdb_10_0000.html", + "doc_type":"api", + "p_code":"", + "code":"93" + }, + { + "desc":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringReturned error code when a task submission exception occurs. For details, see", + "product_code":"taurusdb", + "title":"Abnormal Request Results", + "uri":"gaussdb_10_0001.html", + "doc_type":"api", + "p_code":"93", + "code":"94" + }, + { + "desc":"The following table describes status codes.", + "product_code":"taurusdb", + "title":"Status Codes", + "uri":"gaussdb_10_0002.html", + "doc_type":"api", + "p_code":"93", + "code":"95" + }, + { + "desc":"The following table describes error codes.", + "product_code":"taurusdb", + "title":"Error Codes", + "uri":"gaussdb_10_0003.html", + "doc_type":"api", + "p_code":"93", + "code":"96" + }, + { + "desc":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first. Two methods are available:Obtaining the Project ID ", + "product_code":"taurusdb", + "title":"Obtaining a Project ID", + "uri":"gaussdb_10_0004.html", + "doc_type":"api", + "p_code":"93", + "code":"97" + }, + { + "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", + "product_code":"taurusdb", + "title":"TaurusDB Metrics", + "uri":"gaussdb_10_0006.html", + "doc_type":"api", + "p_code":"93", + "code":"98" + }, + { + "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":"Change History", + "uri":"changeHistory.html", + "doc_type":"api", + "p_code":"", + "code":"99" + } +] \ No newline at end of file diff --git a/docs/taurusdb/api-ref/ChangeGaussMySqlProxySpecification.html b/docs/taurusdb/api-ref/ChangeGaussMySqlProxySpecification.html new file mode 100644 index 000000000..c9149b1f7 --- /dev/null +++ b/docs/taurusdb/api-ref/ChangeGaussMySqlProxySpecification.html @@ -0,0 +1,204 @@ + + +

Changing Specifications of a Database Proxy Instance

+

Function

This API is used to change specifications of a database proxy instance. Before calling this API:

+ +
+

URI

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/flavor

+ +
+ + + + + + + + + + + + + + + + + + + + + +
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

+

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

+

proxy_id

+

Yes

+

String

+

Database proxy ID, which is compliant with the UUID format.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

flavor_ref

+

Yes

+

String

+

ID of the new flavor.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+

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

+PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/flavor
+{
+  "flavor_ref" :"gaussdb.proxy.xlarge.x86.2"
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Database Proxy
+
+
+ diff --git a/docs/taurusdb/api-ref/CreateGaussMySqlProxy.html b/docs/taurusdb/api-ref/CreateGaussMySqlProxy.html new file mode 100644 index 000000000..32e2cf924 --- /dev/null +++ b/docs/taurusdb/api-ref/CreateGaussMySqlProxy.html @@ -0,0 +1,276 @@ + + +

Enabling Database Proxy

+

Function

This API is used to enable database proxy in ELB mode. Before using this API:

+ +
+

URI

POST /v3/{project_id}/instances/{instance_id}/proxy

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

flavor_ref

+

Yes

+

String

+

Proxy specification code.

+

node_num

+

Yes

+

Integer

+

Number of proxy instance nodes. The value is an integer from 2 to 32.

+

proxy_name

+

No

+

String

+

Proxy instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

+

proxy_mode

+

No

+

String

+

Proxy instance type. The default type is readwrite.

+

Valid value:

+
  • readwrite
  • readonly
+

nodes_read_weight

+

No

+

Array of NodesWeight objects

+

Read weight of the node.

+

If proxy_mode is set to readonly, you can assign weights only for read replicas.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 NodesWeight

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Node ID.

+

weight

+

No

+

Integer

+

Weight assigned to the node. Value: 0 to 1000.

+
+
+
+

Response Parameters

Status code: 201

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy
+{
+  "flavor_ref" : "gaussdb.mysql.large.x86.4",
+  "node_num" : 2,
+  "proxy_name" : "taurusdb-proxy",
+  "proxy_mode" : "readonly",
+  "nodes_read_weight" : [ {
+    "id" : "45021bf73a244312a3f2af95092feeecno07",
+    "weight" : 50
+  }, {
+    "id" : "d78a65690cea4af5ad14585e110ff89bno07",
+    "weight" : 400
+  } ]
+}
+
+

Example Response

Status code: 201

+

Success.

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Database Proxy
+
+
+ diff --git a/docs/taurusdb/api-ref/DeleteGaussMySqlBackup.html b/docs/taurusdb/api-ref/DeleteGaussMySqlBackup.html new file mode 100644 index 000000000..c24e24174 --- /dev/null +++ b/docs/taurusdb/api-ref/DeleteGaussMySqlBackup.html @@ -0,0 +1,175 @@ + + +

Deleting a Manual Backup

+

Function

This API is used to delete a manual backup. Before calling this API:

+ +
+

URI

DELETE /v3/{project_id}/backups/{backup_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region.

+

backup_id

+

Yes

+

String

+

Backup file ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameter

Parameter

+

Type

+

Description

+

backup_id

+

String

+

Backup ID.

+

backup_name

+

String

+

Backup name.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameter

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameter

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/backups/1fe4feaab48f11e6654hfa163eba87e4b66
+
+

Example Response

Status code: 200

+

Success.

+
{ 
+  "backup_id" : "b1182ccdda034f2b9535f3dca5c47e71br07", 
+  "backup_name" : "backup-f3c1" 
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/taurusdb/api-ref/DeleteGaussMySqlProxy.html b/docs/taurusdb/api-ref/DeleteGaussMySqlProxy.html new file mode 100644 index 000000000..c34dd20fd --- /dev/null +++ b/docs/taurusdb/api-ref/DeleteGaussMySqlProxy.html @@ -0,0 +1,194 @@ + + +

Disabling Database Proxy

+

Function

This API is used to disable database proxy. Before using this API:

+ +
+

URI

DELETE /v3/{project_id}/instances/{instance_id}/proxy

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

proxy_ids

+

No

+

Array of strings

+

Proxy instance IDs. If only one proxy instance is created, this parameter is not required. If multiple proxy instances are created, this parameter must be specified.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+

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

DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy
+{
+  "proxy_ids" : [ "151c14381ac14ecfb9703a745b992677po01" ]
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Database Proxy
+
+
+ diff --git a/docs/taurusdb/api-ref/DeleteSqlFilterRule.html b/docs/taurusdb/api-ref/DeleteSqlFilterRule.html new file mode 100644 index 000000000..5ae167c6d --- /dev/null +++ b/docs/taurusdb/api-ref/DeleteSqlFilterRule.html @@ -0,0 +1,280 @@ + + +

Deleting Concurrency Control Rules of SQL Statements

+

Function

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

+ +
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

sql_filter_rules

+

Yes

+

Array of DeleteNodeSqlFilterRuleInfo objects

+

Concurrency control rules of SQL statements for nodes.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 DeleteNodeSqlFilterRuleInfo

Parameter

+

Mandatory

+

Type

+

Description

+

node_id

+

Yes

+

String

+

Node ID.

+

rules

+

Yes

+

Array of DeleteNodeSqlFilterRule objects

+

Concurrency control rules of SQL statements.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 DeleteNodeSqlFilterRule

Parameter

+

Mandatory

+

Type

+

Description

+

sql_type

+

Yes

+

String

+

SQL statement type.

+

Valid value:

+
  • SELECT
  • UPDATE
  • DELETE
+

patterns

+

Yes

+

Array of strings

+

Concurrency control rules of SQL statements.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

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

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Deleting concurrency control rules of SQL statements

+
+DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules
+{
+  "sql_filter_rules" : [ {
+    "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07",
+    "rules" : [ {
+      "sql_type" : "SELECT",
+      "patterns" : [ "select~from~t1", "select~from~t2" ]
+    }, {
+      "sql_type" : "UPDATE",
+      "patterns" : [ "udpate~t3~where~id" ]
+    } ]
+  }, {
+    "node_id" : "b234a5645eb2c4ji3b9372342f5362397no07",
+    "rules" : [ {
+      "sql_type" : "SELECT",
+      "patterns" : [ "select~from~t1", "select~from~t2" ]
+    }, {
+      "sql_type" : "DELETE",
+      "patterns" : [ "delete~t3~where~id" ]
+    } ]
+  } ]
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: SQL Statement Concurrency Control
+
+
+ diff --git a/docs/taurusdb/api-ref/ExpandGaussMySqlProxy.html b/docs/taurusdb/api-ref/ExpandGaussMySqlProxy.html new file mode 100644 index 000000000..b2c8c894e --- /dev/null +++ b/docs/taurusdb/api-ref/ExpandGaussMySqlProxy.html @@ -0,0 +1,205 @@ + + +

Adding Database Proxy Nodes

+

Function

This API is used to add database proxy nodes.

+ +
+

URI

POST /v3/{project_id}/instances/{instance_id}/proxy/enlarge

+ +
+ + + + + + + + + + + + + + + + +
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

+

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

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

node_num

+

Yes

+

Integer

+

The number of proxy nodes to be added. The value is an integer from 1 to 30. Restrictions: The total number of proxy nodes for an instance is no more than 32.

+

proxy_id

+

No

+

String

+

ID of the proxy instance. If only one proxy instance is created, this parameter is not required. If multiple proxy instances are created, you must configure this parameter.

+
+
+
+

Response Parameters

Status code: 201

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+

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

+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge
+{
+  "node_num" : 2,
+  "proxy_id" : "151c14381ac14ecfb9703a745b992677po01"
+}
+
+

Example Response

Status code: 201

+

Success.

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Database Proxy
+
+
+ diff --git a/docs/taurusdb/api-ref/ListGaussMySqlErrorLog.html b/docs/taurusdb/api-ref/ListGaussMySqlErrorLog.html new file mode 100644 index 000000000..ec1acf16f --- /dev/null +++ b/docs/taurusdb/api-ref/ListGaussMySqlErrorLog.html @@ -0,0 +1,294 @@ + + +

Querying Database Error Logs

+

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}

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

start_date

+

Yes

+

String

+

Start time in the "yyyy-mm-ddThh:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

end_date

+

Yes

+

String

+

End time in the "yyyy-mm-ddThh:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

Only error logs generated within the last month can be queried.

+

offset

+

No

+

Integer

+

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

+

No

+

Integer

+

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.

+

level

+

No

+

String

+

Log level. The default value is ALL. Valid value:

+
  • ALL
  • INFO
  • WARNING
  • ERROR
  • FATAL
  • NOTE
+

node_id

+

Yes

+

String

+

Node ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

error_log_list

+

Array of MysqlErrorLogList objects

+

Error log details.

+

total_record

+

Integer

+

Total number of records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 MysqlErrorLogList

Parameter

+

Type

+

Description

+

node_id

+

String

+

Node ID.

+

time

+

String

+

Time in the UTC format.

+

level

+

String

+

Log level.

+
  • ALL
  • INFO
  • WARNING
  • ERROR
  • FATAL
  • NOTE
+

content

+

String

+

Error log content.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/errorlog?offset=0&limit=1&level=ERROR&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "error_log_list" : [ {
+    "node_id" : "cc07c60e94ec4575989840e648fb4f66no07",
+    "time" : "2022-07-17T07:34:33",
+    "level" : "ERROR",
+    "content" : "[MY013508] [Repl] do failed: 1"
+  } ],
+ "total_record":1
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/taurusdb/api-ref/ListGaussMySqlSlowLog.html b/docs/taurusdb/api-ref/ListGaussMySqlSlowLog.html new file mode 100644 index 000000000..0c7070f97 --- /dev/null +++ b/docs/taurusdb/api-ref/ListGaussMySqlSlowLog.html @@ -0,0 +1,365 @@ + + +

Querying Database Slow Logs

+

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}

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

start_date

+

Yes

+

String

+

Start time in the "yyyy-mm-ddThh:mm:ssZ" format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

end_date

+

Yes

+

String

+

End time in the "yyyy-mm-ddThh:mm:ssZ" format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

Only error logs generated within the last month can be queried.

+

offset

+

No

+

Integer

+

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

+

No

+

Integer

+

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.

+

type

+

No

+

String

+

Statement type. The default value All. If this parameter is left empty, all statement types are queried. Valid value:

+
  • ALL
  • INSERT
  • UPDATE
  • SELECT
  • DELETE
  • CREATE
  • DROP
  • ALTER
+

node_id

+

Yes

+

String

+

Node ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

slow_log_list

+

Array of MysqlSlowLogList objects

+

Error log details.

+

long_query_time

+

String

+

Slow query log threshold.

+

total_record

+

Integer

+

Total number of records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 MysqlSlowLogList

Parameter

+

Type

+

Description

+

node_id

+

String

+

Node ID.

+

count

+

String

+

Number of executions.

+

time

+

String

+

Execution time.

+

lock_time

+

String

+

Lock wait time.

+

rows_sent

+

String

+

Number of sent rows.

+

rows_examined

+

String

+

Number of scanned rows.

+

database

+

String

+

Database which slow logs belong to.

+

users

+

String

+

Account.

+

query_sample

+

String

+

Execution syntax.

+

type

+

String

+

Statement type.

+

start_time

+

String

+

Start time in the UTC format.

+

client_ip

+

String

+

IP address.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/slowlog?offset=0&limit=1&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07&type=INSERT
+
+

Example Response

Status code: 200

+
Success.
{
+  "slow_log_list" : [ {
+    "node_id" : "cc07c60e94ec4575989840e648fb4f66no07",
+    "count" : 1,
+    "time" : "1.04899 s",
+    "lock_time" : "0.00003 s",
+    "rows_sent" : 0,
+    "rows_examined" : 0,
+    "database" : "gaussdb-mysql",
+    "users" : "root",
+    "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);",
+    "type" : "INSERT",
+    "start_time" : "2022-07-11T00:00:00+0800",
+    "client_ip" : "192.*.*.1"
+  } ],
+  "long_query_time" : 10,
+  "total_record" : 1
+}
+
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/taurusdb/api-ref/ListInstanceConfigurations.html b/docs/taurusdb/api-ref/ListInstanceConfigurations.html new file mode 100644 index 000000000..27e500656 --- /dev/null +++ b/docs/taurusdb/api-ref/ListInstanceConfigurations.html @@ -0,0 +1,424 @@ + + +

Obtaining Parameter Information of a Specified DB Instance

+

Function

This API is used to obtain parameter information of a specified DB instance. Before calling this API:

+ +
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

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

+

instance_id

+

Yes

+

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

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

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

+

limit

+

No

+

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

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

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

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

configurations

+

ParameterConfigurationInfo object

+

Explanation:

+

Instance parameter template information.

+

total_count

+

Long

+

Explanation:

+

Total number of instance parameters.

+

Value range:

+

≥0

+

parameter_values

+

Array of ParameterValuesInfo objects

+

Explanation:

+

Instance parameter information.

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

Parameter

+

Type

+

Description

+

datastore_version_name

+

String

+

Explanation:

+

DB version name.

+

Value range:

+

2.0

+

datastore_name

+

String

+

Explanation:

+

DB engine name in the parameter template.

+

Value range:

+

taurus

+

created

+

String

+

Explanation:

+

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

+

String

+

Explanation:

+

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

+

Type

+

Description

+

name

+

String

+

Explanation:

+

Parameter name.

+

Value range:

+

None

+

value

+

String

+

Explanation:

+

Parameter value.

+

Value range:

+

None

+

restart_required

+

Boolean

+

Explanation:

+

Whether a reboot is required.

+

Value range:

+
  • false: No
  • true: Yes
+

readonly

+

Boolean

+

Explanation:

+

Whether the parameter is read-only.

+

Value range:

+
  • false: No
  • true: Yes
+

value_range

+

String

+

Explanation:

+

Value range.

+

Value range:

+

None

+

type

+

String

+

Explanation:

+

Parameter type.

+

Value range:

+
  • string
  • integer
  • boolean
  • list
  • float
+

description

+

String

+

Explanation:

+

Parameter description.

+

Value range:

+

None

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Obtaining parameter information of a specified DB instance

+
+GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/configurations
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "configurations" : {
+    "datastore_version_name" : "2.0",
+    "datastore_name" : "taurus",
+    "created" : "2022-10-29T09:38:36+0000",
+    "updated" : "2022-10-29T09:38:36+0000"
+  },
+  "total_count" : 125,
+  "parameter_values" : [ {
+    "name" : "auto_increment_increment",
+    "value" : "1",
+    "restart_required" : false,
+    "readonly" : false,
+    "value_range" : "1-65535",
+    "type" : "integer",
+    "description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
+  }, {
+    "name" : "auto_increment_offset",
+    "value" : "1",
+    "restart_required" : false,
+    "readonly" : false,
+    "value_range" : "1-65535",
+    "type" : "integer",
+    "description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/taurusdb/api-ref/ListInstanceTags.html b/docs/taurusdb/api-ref/ListInstanceTags.html new file mode 100644 index 000000000..31e6c1ba8 --- /dev/null +++ b/docs/taurusdb/api-ref/ListInstanceTags.html @@ -0,0 +1,241 @@ + + +

Querying Resource Tags

+

Function

This API is used to query tags of a specified instance. Before calling this API:

+ +
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

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

+

No

+

Integer

+

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.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total_count

+

Integer

+

Total number of records.

+

tags

+

Array of ResourceTagItem objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 ResourceTagItem

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+

value

+

String

+

Tag value.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Querying resource tags

+
GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags?offset=0&limit=2
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "total_count" : 2,
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/taurusdb/api-ref/ListProjectTags.html b/docs/taurusdb/api-ref/ListProjectTags.html new file mode 100644 index 000000000..ab3c164bf --- /dev/null +++ b/docs/taurusdb/api-ref/ListProjectTags.html @@ -0,0 +1,232 @@ + + +

Querying Project Tags

+

Function

This API is used to query all tags of instances in a specified project. Before using this API:

+ +
+

URI

GET /v3/{project_id}/tags

+ +
+ + + + + + + + + + + +
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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

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

+

No

+

Integer

+

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.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total_count

+

Integer

+

Total number of records.

+

tags

+

Array of ProjectTagItem objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 ProjectTagItem

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+

values

+

Array of strings

+

Tag value.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Querying tags in a specified project

+
GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/tags?offset=0&limit=2
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "total_count" : 2,
+  "tags" : [ {
+    "key" : "key1",
+    "values" : [ "value1", "value2" ]
+  }, {
+    "key" : "key2",
+    "values" : [ "value3", "value4" ]
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/taurusdb/api-ref/PARAMETERS.txt b/docs/taurusdb/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/taurusdb/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/taurusdb/api-ref/SetGaussMySqlProxyWeight.html b/docs/taurusdb/api-ref/SetGaussMySqlProxyWeight.html new file mode 100644 index 000000000..44168b8e9 --- /dev/null +++ b/docs/taurusdb/api-ref/SetGaussMySqlProxyWeight.html @@ -0,0 +1,244 @@ + + +

Assigning Read Weights

+

Function

This API is used to assign read weights for nodes. Being using this API:

+ +
+

URI

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/weight

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region.

+

instance_id

+

Yes

+

String

+

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

+

proxy_id

+

Yes

+

String

+

Database proxy ID, which is compliant with the UUID format.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

master_weight

+

No

+

Integer

+

Weight of the primary node.

+

readonly_nodes

+

No

+

Array of TaurusModifyProxyWeightReadonlyNode objects

+

Weight information of the read replicas.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 TaurusModifyProxyWeightReadonlyNode

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Read replica ID.

+

weight

+

No

+

Integer

+

Weight of the read replica.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

+PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight
+{
+  "master_weight" : 100
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87c11411890"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Database Proxy
+
+
+ diff --git a/docs/taurusdb/api-ref/SetSqlFilterRule.html b/docs/taurusdb/api-ref/SetSqlFilterRule.html new file mode 100644 index 000000000..a2ecb0fe9 --- /dev/null +++ b/docs/taurusdb/api-ref/SetSqlFilterRule.html @@ -0,0 +1,327 @@ + + +

Configuring Concurrency Control Rules of SQL Statements

+

Function

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

+ +
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

sql_filter_rules

+

Yes

+

Array of NodeSqlFilterRuleInfo objects

+

Concurrency control rules of SQL statements for nodes.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 NodeSqlFilterRuleInfo

Parameter

+

Mandatory

+

Type

+

Description

+

node_id

+

Yes

+

String

+

Node ID.

+

rules

+

Yes

+

Array of NodeSqlFilterRule objects

+

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

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 NodeSqlFilterRule

Parameter

+

Mandatory

+

Type

+

Description

+

sql_type

+

Yes

+

String

+

SQL statement type.

+

Valid value:

+
  • SELECT
  • UPDATE
  • DELETE
+

patterns

+

Yes

+

Array of NodeSqlFilterRulePattern objects

+

Concurrency control rules of SQL statements.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 NodeSqlFilterRulePattern

Parameter

+

Mandatory

+

Type

+

Description

+

pattern

+

Yes

+

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 (~).

+

max_concurrency

+

Yes

+

Integer

+

Maximum number of concurrent SQL statements. Value: a non-negative integer.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

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

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Configuring concurrency control rules of SQL statements

+
+PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules
+{
+  "sql_filter_rules" : [ {
+    "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07",
+    "rules" : [ {
+      "sql_type" : "SELECT",
+      "patterns" : [ {
+        "pattern" : "select~from~t1",
+        "max_concurrency" : 0
+      }, {
+        "pattern" : "select~from~t3~where~id",
+        "max_concurrency" : 10
+      } ]
+    }, {
+      "sql_type" : "UPDATE",
+      "patterns" : [ {
+        "pattern" : "update~t3~where~id",
+        "max_concurrency" : 10
+      } ]
+    } ]
+  }, {
+    "node_id" : "b234a5645eb2c4ji3b9372342f5362397no07",
+    "rules" : [ {
+      "sql_type" : "SELECT",
+      "patterns" : [ {
+        "pattern" : "select~from~t3~where~id",
+        "max_concurrency" : 10
+      } ]
+    }, {
+      "sql_type" : "DELETE",
+      "patterns" : [ {
+        "pattern" : "delete~t3~where~id",
+        "max_concurrency" : 10
+      } ]
+    } ]
+  } ]
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: SQL Statement Concurrency Control
+
+
+ diff --git a/docs/taurusdb/api-ref/ShowGaussMySqlJobInfo.html b/docs/taurusdb/api-ref/ShowGaussMySqlJobInfo.html new file mode 100644 index 000000000..218bb5e9e --- /dev/null +++ b/docs/taurusdb/api-ref/ShowGaussMySqlJobInfo.html @@ -0,0 +1,315 @@ + + +

Obtaining Information About a Task with a Specified ID

+

Function

This API is used to obtain information about a TaurusDB task with a specified ID in the task center. Before calling this API:

+ +
+

Constraints

+
+

URI

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

+ +
+ + + + + + + + + + + +
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.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

Yes

+

String

+

Task ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameter

Parameter

+

Type

+

Description

+

job

+

GetJobInfoDetail object

+

Task information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 GetJobInfoDetail

Parameter

+

Type

+

Description

+

id

+

String

+

Task ID.

+

name

+

String

+

Task name.

+

status

+

String

+

Task execution status.

+

Value:

+
  • Running: The task is being executed.
  • Completed: The task is successfully executed.
  • Failed: The task fails to be executed.
+

Valid value:

+
  • Running
  • Completed
  • Failed
+

created

+

String

+

Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

The value is empty unless the DB instance creation is complete.

+

ended

+

String

+

End time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

The value is empty unless the DB instance creation is complete.

+

process

+

String

+

Task execution progress. The execution progress (such as 60%) is displayed only when the task is being executed. Otherwise, "" is returned.

+

instance

+

GetJobInstanceInfoDetail object

+

DB instance information of the task with the specified ID.

+

entities

+

Object

+

Displayed information varies depending on tasks.

+

fail_reason

+

String

+

Task failure information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 GetJobInstanceInfoDetail

Parameter

+

Type

+

Description

+

id

+

String

+

DB instance ID.

+

name

+

String

+

DB instance name.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514
+
+

Example Response

Status code: 200

+

In the response example, some tasks in the task center are used as examples.

+
+

Success.

+
{
+  "job" : {
+    "id" : "a9767ede-fe0f-4888-9003-e843a4c90514",
+    "name" : "CreateMysqlInstance",
+    "status" : "Completed",
+    "created" : "2018-08-06T10:41:14+0800",
+    "ended" : "2018-08-06T16:41:14+0000",
+    "process" : "",
+    "instance" : {
+      "id" : "a48e43ff268f4c0e879652d65e63d0fbin07",
+      "name" : "DO-NOT-TOUCH-mgr2-mysql-single"
+    },
+    "entities" : {
+      "instance" : {
+        "endpoint" : "192.168.1.203:3306",
+        "type" : "Cluster",
+        "datastore" : {
+          "type" : "gaussdb-mysql",
+          "version" : "8.0"
+        }
+      },
+      "resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ]
+    }
+  }
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Task Center
+
+
+ diff --git a/docs/taurusdb/api-ref/ShowGaussMySqlProjectQuotas.html b/docs/taurusdb/api-ref/ShowGaussMySqlProjectQuotas.html new file mode 100644 index 000000000..e66e7e9f7 --- /dev/null +++ b/docs/taurusdb/api-ref/ShowGaussMySqlProjectQuotas.html @@ -0,0 +1,245 @@ + + +

Querying the DB Instance Quotas of a Tenant

+

Function

This API is used to obtain the resource quotas of a specified tenant. Before using this API:

+ +
+

URI

GET /v3/{project_id}/project-quotas

+ +
+ + + + + + + + + + + +
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.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

No

+

String

+

Resource type used to filter quotas. Its value can be instance.

+

Valid value:

+
  • instance
+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

quotas

+

project-quotas object

+

Tenant instance quota information.

+
+
+ +
+ + + + + + + + + +
Table 5 project-quotas

Parameter

+

Type

+

Description

+

resources

+

Array of resource objects

+

Resource list objects.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 resource

Parameter

+

Type

+

Description

+

type

+

String

+

Quota of a specified type.

+
  • instance: indicates the DB instance quota.
+

Valid value:

+
  • instance
+

used

+

Integer

+

Number of created resources.

+

quota

+

Integer

+

Maximum resource quota.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/project-quotas?type=instance
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "quotas" : {
+    "resources" : [ {
+      "type" : "instance,",
+      "used" : "4,",
+      "quota" : 50
+    } ]
+  }
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Quota Management
+
+
+ diff --git a/docs/taurusdb/api-ref/ShowGaussMySqlProxyFlavors.html b/docs/taurusdb/api-ref/ShowGaussMySqlProxyFlavors.html new file mode 100644 index 000000000..6b23ddc0a --- /dev/null +++ b/docs/taurusdb/api-ref/ShowGaussMySqlProxyFlavors.html @@ -0,0 +1,261 @@ + + +

Querying Database Proxy Specifications

+

Function

This API is used to query database proxy specifications. Before using this API:

+ +
+

URI

GET /v3/{project_id}/instances/{instance_id}/proxy/flavors

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

proxy_flavor_groups

+

Array of MysqlProxyFlavorGroups objects

+

Specification group information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 MysqlProxyFlavorGroups

Parameter

+

Type

+

Description

+

group_type

+

String

+

Specification group type. It can be x86.

+

proxy_flavors

+

Array of MysqlProxyComputeFlavor objects

+

Proxy specifications.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 MysqlProxyComputeFlavor

Parameter

+

Type

+

Description

+

vcpus

+

String

+

Number of vCPUs. For example, the value 1 indicates 1 vCPU.

+

ram

+

String

+

Memory size in GB.

+

db_type

+

String

+

Database type.

+

id

+

String

+

Proxy specification ID.

+

spec_code

+

String

+

Proxy specification code.

+

az_status

+

Object

+

AZ status. key indicates the AZ ID and value indicates the status of the AZ where the proxy specifications reside. The value can be normal or unsupported.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

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

Example Response

Status code: 200

+

Success.

+
{
+  "proxy_flavor_groups" : {
+    "group_type" : "X86",
+    "proxy_flavors" : {
+      "id" : "19be4c5d-d363-3342-bdbc-0dd9dbf7fafe",
+      "spec_code" : "gaussdb.proxy.large.x86.2",
+      "vcpus" : 2,
+      "ram" : 4,
+      "db_type" : "Proxy",
+      "az_status" : {
+        "az1" : "normal"
+      },
+      "region_status" : "normal"
+    }
+  }
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Database Proxy
+
+
+ diff --git a/docs/taurusdb/api-ref/ShowGaussMySqlProxyList.html b/docs/taurusdb/api-ref/ShowGaussMySqlProxyList.html new file mode 100644 index 000000000..9f65ab1ce --- /dev/null +++ b/docs/taurusdb/api-ref/ShowGaussMySqlProxyList.html @@ -0,0 +1,540 @@ + + +

Querying Database Proxy Instances

+

Function

This API is used to query database proxy instances. Before calling this API:

+ +
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

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

+

No

+

Integer

+

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

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameter

Parameter

+

Type

+

Description

+

proxy_list

+

Array of MysqlShowProxyResponseV3 objects

+

Proxy instances.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 MysqlShowProxyResponseV3

Parameter

+

Type

+

Description

+

proxy

+

MysqlProxyV3 object

+

Proxy instance information.

+

master_node

+

MysqlProxyNodeV3 object

+

Primary node information.

+

readonly_nodes

+

Array of MysqlProxyNodeV3 objects

+

Read replica information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 MysqlProxyV3

Parameter

+

Type

+

Description

+

pool_id

+

String

+

Proxy instance ID.

+

status

+

String

+

Operating status of the proxy instance. It can be either of the following:

+
  • ACTIVE: The database proxy is normal.
  • FAILED: The database proxy fails to be created.
  • DELETED: The database proxy is deleted.
  • ABNORMAL: The database proxy is abnormal.
  • ENABLING PROXY: The database proxy is being enabled.
  • DISABLING PROXY: The database proxy is being disabled.
  • ADDING PROXY NODE: Nodes are being added to the database proxy.
  • DELETING READ REPLICAS FROM PROXY: Read replicas are being removed from the database proxy.
  • ADDING READ REPLICAS TO PROXY: Read replicas are being added to the database proxy.
  • CHANGING WEIGHT: The weights of read replicas for the database proxy are being changed.
+

address

+

String

+

Proxy read/write splitting address.

+

port

+

Integer

+

Proxy port information.

+

pool_status

+

String

+

Proxy instance status. Value: ACTIVE, ABNORMAL, FAILED, or DELETED.

+

delay_threshold_in_seconds

+

Integer

+

Delay threshold in seconds.

+

elb_vip

+

String

+

Virtual IP address in ELB mode.

+

eip

+

String

+

EIP information.

+

vcpus

+

String

+

Number of vCPUs of the proxy instance.

+

ram

+

String

+

Memory size of the proxy instance.

+

node_num

+

Integer

+

Number of proxy nodes.

+

mode

+

String

+

Primary/standby proxy. The value is Cluster.

+

nodes

+

Array of MysqlProxyNodes objects

+

Proxy node information.

+

flavor_ref

+

String

+

Proxy specifications.

+

name

+

String

+

Proxy instance name.

+

transaction_split

+

String

+

Whether the proxy transaction splitting is enabled. Value: ON or OFF.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 MysqlProxyNodes

Parameter

+

Type

+

Description

+

id

+

String

+

Proxy node ID.

+

status

+

String

+

Proxy node status. Value: ACTIVE, ABNORMAL, BUILD, or FAILED.

+

name

+

String

+

Proxy node name.

+

role

+

String

+

Role of the proxy node. It can be master or slave.

+

az_code

+

String

+

AZ.

+

frozen_flag

+

Integer

+

Whether the proxy node is frozen. It can be 0 (unfrozen), 1 (frozen), or 2 (deleted after being frozen).

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 MysqlProxyNodeV3

Parameter

+

Type

+

Description

+

id

+

String

+

Node ID.

+

instance_id

+

String

+

DB instance ID.

+

status

+

String

+

Node status.

+

name

+

String

+

Node name.

+

weight

+

Integer

+

Read weight of the node.

+

availability_zone

+

Array of MysqlProxyAvailable objects

+

AZ information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 MysqlProxyAvailable

Parameter

+

Type

+

Description

+

code

+

String

+

AZ code.

+

description

+

String

+

AZ description.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxies?offset=0&limit=10
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "proxy_list" : [ {
+    "proxy" : {
+      "pool_id" : "2e7cf21d14794bafab623a334efd9ad8po01",
+      "status" : "ACTIVE",
+      "address" : "192.168.125.69",
+      "port" : 3306,
+      "pool_status" : "ACTIVE",
+      "delay_threshold_in_seconds" : 30,
+      "elb_vip" : "192.168.125.60",
+      "eip" : "192.168.125.50",
+      "vcpus" : 4,
+      "ram" : 8,
+      "node_num" : 2,
+      "mode" : "Cluster",
+      "nodes" : [ {
+        "id" : "db53a238a02240c49365e72e284a4890pn01",
+        "name" : "PROXY-2e7cf21d14794bafab623a334efd9ad8po01_0",
+        "role" : "master",
+        "az_code" : "eu-de-01",
+        "status" : "ACTIVE",
+        "frozen_flag" : 0
+      } ],
+      "name" : "proxy-name",
+      "flavor_ref":"gaussdb.proxy.large.x86.2",
+      "transaction_split":"OFF"
+    },
+    "master_node" : {
+      "id" : "c01a5645eb2c4fb6a9373542f5366e50no07",
+      "instance_id" : "096c0fc43e804757b59946b80dc27f8bin07",
+      "status" : "ACTIVE",
+      "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01",
+      "weight" : 0,
+      "availability_zone" : [{
+        "code" : "eu-de-01",
+        "description": "AZ1"
+      }]
+    },
+    "readonly_nodes" : {
+      "id" : "d23535333138462880bfa1838fdfced2no07",
+      "instance_id" : "7a871d6d494e4327ad2e326afb591108in07",
+      "status" : "ACTIVE",
+      "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node02",
+      "weight" : 100,
+      "availability_zone" : [{
+        "code" : "eu-de-01",
+        "description": "AZ1"
+      }]
+    }
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Database Proxy
+
+
+ diff --git a/docs/taurusdb/api-ref/ShowInstanceMonitorExtend.html b/docs/taurusdb/api-ref/ShowInstanceMonitorExtend.html new file mode 100644 index 000000000..2ba9faa8e --- /dev/null +++ b/docs/taurusdb/api-ref/ShowInstanceMonitorExtend.html @@ -0,0 +1,179 @@ + + +

Querying the Collection Period of Monitoring by Seconds

+

Function

This API is used to query the collection period of Monitoring by Seconds. Before calling this API:

+ +
+

URI

GET /v3/{project_id}/instances/{instance_id}/monitor-policy

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

monitor_switch

+

Boolean

+

Whether to enable Monitoring by Seconds. true indicates that the function is enabled, and false indicates that the function is disabled.

+

period

+

Integer

+

Collection period. This parameter is returned only when monitor_switch is set to true.

+
  • 1: The collection period is 1s.
  • 5: The collection period is 5s.
+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Querying the collection period of Monitoring by Seconds for an instance

+
GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "monitor_switch" : true,
+  "period" : "1"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/ShowSqlFilterControl.html b/docs/taurusdb/api-ref/ShowSqlFilterControl.html new file mode 100644 index 000000000..bba03ef93 --- /dev/null +++ b/docs/taurusdb/api-ref/ShowSqlFilterControl.html @@ -0,0 +1,171 @@ + + +

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:

+ +
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

x-auth-token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

switch_status

+

String

+

Whether SQL Statement Concurrency Control is enabled.

+

Value:

+
  • ON: enabled
  • OFF: disabled
+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Querying whether SQL Statement Concurrency Control is enabled

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

Example Response

Status code: 200

+

Success.

+
{
+  "switch_status" : "ON"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: SQL Statement Concurrency Control
+
+
+ diff --git a/docs/taurusdb/api-ref/ShowSqlFilterRule.html b/docs/taurusdb/api-ref/ShowSqlFilterRule.html new file mode 100644 index 000000000..6010fc36e --- /dev/null +++ b/docs/taurusdb/api-ref/ShowSqlFilterRule.html @@ -0,0 +1,287 @@ + + +

Querying Concurrency Control Rules of SQL Statements

+

Function

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

+ +
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

node_id

+

Yes

+

String

+

Node ID.

+

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.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

node_id

+

String

+

Node ID.

+

sql_filter_rules

+

Array of SqlFilterRule objects

+

Concurrency control rules of SQL statements.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 SqlFilterRule

Parameter

+

Type

+

Description

+

sql_type

+

String

+

SQL statement type.

+

Valid value:

+
  • SELECT
  • UPDATE
  • DELETE
+

patterns

+

Array of SqlFilterRulePattern objects

+

Concurrency control rules of SQL statements.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 SqlFilterRulePattern

Parameter

+

Type

+

Description

+

pattern

+

String

+

A concurrency control rule of SQL statements.

+

max_concurrency

+

Integer

+

Maximum number of concurrent SQL statements.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Querying concurrency control rules of SQL statements

+
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
+    }, {
+      "pattern" : "select~from~t2~where~id",
+      "max_concurrency" : 10
+    } ]
+  }, {
+    "sql_type" : "UDPATE",
+    "patterns" : [ {
+      "pattern" : "update~t1",
+      "max_concurrency" : 0
+    }, {
+      "pattern" : "update~t2~where~id",
+      "max_concurrency" : 10
+    } ]
+  }, {
+    "sql_type" : "DELETE",
+    "patterns" : [ {
+      "pattern" : "delete~from",
+      "max_concurrency" : 0
+    } ]
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: SQL Statement Concurrency Control
+
+
+ diff --git a/docs/taurusdb/api-ref/UpdateGaussMySqlInstancePort.html b/docs/taurusdb/api-ref/UpdateGaussMySqlInstancePort.html new file mode 100644 index 000000000..02d8e7b9e --- /dev/null +++ b/docs/taurusdb/api-ref/UpdateGaussMySqlInstancePort.html @@ -0,0 +1,195 @@ + + +

Changing a Database Port

+

Function

This API is used to change the database port of a DB instance. Before calling this API:

+ +
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region.

+

instance_id

+

Yes

+

String

+

Instance ID of a tenant in a project.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

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

Parameter

+

Mandatory

+

Type

+

Description

+

port

+

Yes

+

Integer

+

Port number.

+

Value range: 1024 to 65535, excluding 5342 to 5345, 12017, 20000, 20201, 20202, and 33062.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameter

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+

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

PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/port
+
+{
+  "port" : 8836
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/UpdateInstanceMonitor.html b/docs/taurusdb/api-ref/UpdateInstanceMonitor.html new file mode 100644 index 000000000..8a84600eb --- /dev/null +++ b/docs/taurusdb/api-ref/UpdateInstanceMonitor.html @@ -0,0 +1,209 @@ + + +

Changing the Collection Period of Monitoring by Seconds

+

Function

This API is used to enable and disable Monitoring by Seconds, and change its collection period. Before calling this API, you can:

+ +
+

URI

PUT /v3/{project_id}/instances/{instance_id}/monitor-policy

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

monitor_switch

+

Yes

+

Boolean

+

Whether to enable Monitoring by Seconds. true indicates that the function is enabled, and false indicates that the function is disabled.

+

period

+

No

+

Integer

+

Collection period. This parameter is available only when monitor_switch is set to true. The default value is 5s. This parameter is not displayed when monitor_switch is set to false.

+

1: indicates that the collection period is 1s. 5: indicates that the collection period is 5s.

+

Valid value:

+
  • 1
  • 5
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Taskflow ID for modifying Monitoring by Seconds

+
+
+

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 the collection period of Monitoring by Seconds for an instance. The current collection period to 1s.

+
+PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy
+{
+  "monitor_switch" : true,
+  "period" : 1
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "6b7dd5d4-4590-4f14-b164-a8737ce071d5"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/UpdateSqlFilterControl.html b/docs/taurusdb/api-ref/UpdateSqlFilterControl.html new file mode 100644 index 000000000..4d2f6c57c --- /dev/null +++ b/docs/taurusdb/api-ref/UpdateSqlFilterControl.html @@ -0,0 +1,200 @@ + + +

Enabling or Disabling SQL Statement Concurrency Control

+

Function

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

+ +
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

switch_status

+

Yes

+

String

+

Whether SQL Statement Concurrency Control is enabled. Value:

+
  • ON: enabled
  • OFF: disabled
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

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

+
+
+

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

+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: SQL Statement Concurrency Control
+
+
+ diff --git a/docs/taurusdb/api-ref/changeHistory.html b/docs/taurusdb/api-ref/changeHistory.html new file mode 100644 index 000000000..4e03b1f67 --- /dev/null +++ b/docs/taurusdb/api-ref/changeHistory.html @@ -0,0 +1,84 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Released On

+

Description

+

2025-03-27

+

Modified the following content:

+ +

2025-03-10

+

Added the following content:

+ +

2024-04-15

+

Added the following content:

+ +

2024-02-28

+

Modified the following content:

+

Added precautions in Configuring Resource Quotas and Modifying Resource Quotas.

+

2023-10-25

+

Modified the following content:

+

Modified the response parameters and examples in Deleting a Manual Backup.

+

2023-10-20

+

Modified the following content:

+

Added the total_count field to the example response in Querying Resource Quotas.

+

Added the following description for the nodes_read_weight field in Enabling Database Proxy: If proxy_mode is set to readonly, you can assign weights only for read replicas.

+

2023-07-12

+

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
+

2023-04-06

+

Modified the following content:

+ +

2022-11-30

+

Modified the following content:

+

Added the following APIs:

+ +

2020-12-09

+

Modified the following content:

+

Optimized the content for API usage.

+

Modified the spec_code description parameter in Querying Database Specifications.

+

2020-05-30

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/taurusdb/api-ref/en-us_image_0000001427231638.png b/docs/taurusdb/api-ref/en-us_image_0000001427231638.png new file mode 100644 index 000000000..d4a37a976 Binary files /dev/null and b/docs/taurusdb/api-ref/en-us_image_0000001427231638.png differ diff --git a/docs/taurusdb/api-ref/en-us_image_0000001828921437.png b/docs/taurusdb/api-ref/en-us_image_0000001828921437.png new file mode 100644 index 000000000..1dd126c17 Binary files /dev/null and b/docs/taurusdb/api-ref/en-us_image_0000001828921437.png differ diff --git a/docs/taurusdb/api-ref/en-us_image_0000001828922089.png b/docs/taurusdb/api-ref/en-us_image_0000001828922089.png new file mode 100644 index 000000000..c0a3ca118 Binary files /dev/null and b/docs/taurusdb/api-ref/en-us_image_0000001828922089.png differ diff --git a/docs/taurusdb/api-ref/en-us_topic_0000002200308556.html b/docs/taurusdb/api-ref/en-us_topic_0000002200308556.html new file mode 100644 index 000000000..33a5fff21 --- /dev/null +++ b/docs/taurusdb/api-ref/en-us_topic_0000002200308556.html @@ -0,0 +1,146 @@ + + +

Querying a Specified API Version

+

Function

This API is used to query a specified API version. Before calling this API:

+ +
+

URI

GET /{version_id}

+ +
+ + + + + + + + + + + +
Table 1 URI parameter

Parameter

+

Mandatory

+

Type

+

Description

+

version_id

+

Yes

+

String

+

API version.

+

Values:

+
  • v3
  • v3.1
+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameter

Parameter

+

Type

+

Description

+

version

+

Array of OpenApiVersion objects

+

Version details.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 OpenApiVersion

Parameter

+

Type

+

Description

+

id

+

Object

+

Version number, for example, v3.

+

links

+

Array of OpenApiLinks objects

+

API URL.

+

status

+

String

+

Version status.

+

Values:

+
  • CURRENT: The version is the primary version.
  • SUPPORTED: The version is an earlier version, but it is still supported.
  • DEPRECATED: The version is a deprecated version, which may be deleted later.
+

updated

+

String

+

Version release time in UTC. For example, the release time of v3 is 2020-10-29T03:30:42Z.

+

min_version

+

String

+

If the APIs of this version support microversions, the earliest microversion is returned. If not, an empty value is returned.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 OpenApiLinks

Parameter

+

Type

+

Description

+

href

+

Object

+

API URL. The value is "".

+

rel

+

Object

+

Its value is self, indicating that href is a local link.

+
+
+
+

Example Request

None

+
+

Example Response

None

+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: API Version Queries
+
+
+ diff --git a/docs/taurusdb/api-ref/en-us_topic_0000002235108869.html b/docs/taurusdb/api-ref/en-us_topic_0000002235108869.html new file mode 100644 index 000000000..466b74efb --- /dev/null +++ b/docs/taurusdb/api-ref/en-us_topic_0000002235108869.html @@ -0,0 +1,21 @@ + + + +

API Version Queries

+ +

+
+ +
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/en-us_topic_0000002235229005.html b/docs/taurusdb/api-ref/en-us_topic_0000002235229005.html new file mode 100644 index 000000000..b4c1cff96 --- /dev/null +++ b/docs/taurusdb/api-ref/en-us_topic_0000002235229005.html @@ -0,0 +1,121 @@ + + +

Querying API Versions

+

Function

This API is used to query API versions. Before calling this API:

+ +
+

URI

GET /

+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 1 Response body parameter

Parameter

+

Type

+

Description

+

versions

+

Array of OpenApiVersion objects

+

Version list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 OpenApiVersion

Parameter

+

Type

+

Description

+

id

+

Object

+

Version number, for example, v3.

+

links

+

Array of OpenApiLinks objects

+

API URL.

+

status

+

String

+

Version status.

+

Values:

+
  • CURRENT: The version is the primary version.
  • SUPPORTED: The version is an earlier version, but it is still supported.
  • DEPRECATED: The version is a deprecated version, which may be deleted later.
+

updated

+

String

+

Version release time in UTC. For example, the release time of v3 is 2020-10-29T03:30:42Z.

+

min_version

+

String

+

If the APIs of this version support microversions, the earliest microversion is returned. If not, an empty value is returned.

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 OpenApiLinks

Parameter

+

Type

+

Description

+

href

+

Object

+

API URL. The value is "".

+

rel

+

Object

+

Its value is self, indicating that href is a local link.

+
+
+
+

Example Request

None

+
+

Example Response

None

+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: API Version Queries
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_00_0001.html b/docs/taurusdb/api-ref/gaussdb_00_0001.html new file mode 100644 index 000000000..d29ac7614 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_00_0001.html @@ -0,0 +1,15 @@ + + +

Overview

+

TaurusDB is a MySQL-compatible, enterprise-grade distributed database service. It decouples compute from storage and supports up to 128 TB of storage per instance. With TaurusDB, there is no need to deal with sharding, and no need to worry about data loss. It provides the high availability and superior performance of commercial databases at the price of open-source databases.

+

Data Function Virtualization (DFV) is a high-performance and high-reliability distributed storage system that is vertically integrated with databases. Storage clusters are deployed in pools to improve storage utilization.

+
+

This document describes how to use application programming interfaces (APIs) to perform operations on DB instances. For details about all supported operations, see API Overview.

+

If you plan to access TaurusDB through an API, ensure that you are familiar with TaurusDB concepts. For details, see Introduction in TaurusDB User Guide.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_00_0002.html b/docs/taurusdb/api-ref/gaussdb_00_0002.html new file mode 100644 index 000000000..382e52148 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_00_0002.html @@ -0,0 +1,11 @@ + + +

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.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_00_0003.html b/docs/taurusdb/api-ref/gaussdb_00_0003.html new file mode 100644 index 000000000..fbbb485ff --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_00_0003.html @@ -0,0 +1,11 @@ + + +

Endpoints

+

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_00_0004.html b/docs/taurusdb/api-ref/gaussdb_00_0004.html new file mode 100644 index 000000000..b0c7af31a --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_00_0004.html @@ -0,0 +1,11 @@ + + +

Constraints

+
+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_00_0005.html b/docs/taurusdb/api-ref/gaussdb_00_0005.html new file mode 100644 index 000000000..d2cc62e03 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_00_0005.html @@ -0,0 +1,18 @@ + + +

Concepts

+
+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_00_0011.html b/docs/taurusdb/api-ref/gaussdb_00_0011.html new file mode 100644 index 000000000..76eef16f1 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_00_0011.html @@ -0,0 +1,19 @@ + + +

Before You Start

+
+
+ +
+ diff --git a/docs/taurusdb/api-ref/gaussdb_02_0000.html b/docs/taurusdb/api-ref/gaussdb_02_0000.html new file mode 100644 index 000000000..d3baa1f77 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_02_0000.html @@ -0,0 +1,66 @@ + + +

API Overview

+

With TaurusDB APIs, you can query, set, and modify resource quotas.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Type

+

Description

+

DB engine version query

+

Query the DB version information of a specified DB engine.

+

DB specifications query

+

Query the DB specifications of a specified DB engine version.

+

DB instance management

+

Create instances, query instance lists, query instance details, delete instances, create read replicas, delete read replicas, change instance names, reset database passwords, and change instance specifications.

+

Backup management

+

Create manual backups, query backup lists, query automated backup policies, and modify automated backup policies.

+

Parameter template management

+

Query parameter templates.

+

Quota management

+

Query, set, and modify resource quotas.

+

Database proxy

+

Query database proxy information and specifications, and enable or disable database proxy.

+

Log management

+

Obtain log information, including database error logs and slow logs.

+

Tag management

+

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

+

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 new file mode 100644 index 000000000..87f435490 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_03_0000.html @@ -0,0 +1,15 @@ + + +

API Usage Guidelines

+
+
+ +
+ diff --git a/docs/taurusdb/api-ref/gaussdb_03_0001.html b/docs/taurusdb/api-ref/gaussdb_03_0001.html new file mode 100644 index 000000000..e53f30f0f --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_03_0001.html @@ -0,0 +1,47 @@ + + +

Authentication

+

Token authentication must be performed to call APIs.

+

Authentication using tokens: General requests are authenticated using tokens.

+

Token-based Authentication

The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.

+
+

A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.

+
{ 
+     "auth": { 
+         "identity": { 
+             "methods": [ 
+                 "password" 
+             ], 
+             "password": { 
+                 "user": { 
+                     "name": "username", 
+                     "password": "********", 
+                     "domain": { 
+                         "name": "domainname" 
+                     } 
+                 } 
+             } 
+         }, 
+         "scope": { 
+             "project": { 
+                 "name": "xxxxxxxx" 
+             } 
+         } 
+     } 
+ }
+
+

In Making an API Request, the process of calling the API used to obtain a user token is described.

+

After a token is obtained, add the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:

+
1
+2
Content-Type: application/json
+X-Auth-Token: ABCDEFJ....
+
+
+
+
+
+
+
Parent topic: API Usage Guidelines
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_03_0005.html b/docs/taurusdb/api-ref/gaussdb_03_0005.html new file mode 100644 index 000000000..ad0f8a6d3 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_03_0005.html @@ -0,0 +1,178 @@ + + +

Making an API Request

+

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 used to authenticate the calling of other APIs.

+

Request URI

A request URI consists of the following:

+

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

+

Although a request URI is included in a request header, most programming languages or frameworks require the request URI to be separately transmitted, rather than being conveyed in a request message.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters in a URI

Parameter

+

Description

+

URI-scheme

+

Protocol used to transmit requests. All APIs use HTTPS.

+

Endpoint

+

Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints.

+

resource-path

+

Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.

+

query-string

+

Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ? limit=10 indicates that a maximum of 10 data records will be displayed.

+
+
+

To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.

+
+
+

Request Methods

The HTTP protocol defines the following request methods that can be used to send a request to the server: +
+ + + + + + + + + + + + + +
Table 2 HTTP methods

Method

+

Description

+

GET

+

Requests the server to return specified resources.

+

PUT

+

Requests the server to update specified resources.

+

POST

+

Requests the server to add resources or perform special operations.

+
+
+
+

For example, in the case 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. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Common request headers

Name

+

Description

+

Mandatory

+

Example

+

Host

+

Specifies the requested server information, which can be obtained from the URL of the service API. The value is in the hostname[:port] format. If the port number is not specified, the default port is used. The default port number for https is 443.

+

No

+

This parameter is mandatory for AK/SK authentication.

+

code.test.com

+

or

+

code.test.com:443

+

Content-Type

+

Specifies the MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+

Yes

+

application/json

+

Content-Length

+

Specifies the length of the request body. The unit is byte.

+

No

+

3495

+

X-Project-Id

+

Specifies the project ID. Obtain the project ID by following the instructions in Obtaining a Project ID.

+

No

+

e9993fc787d94b6c886cbaa340f9c0f4

+

X-Auth-Token

+

Specifies the user token.

+

The user token is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

After the request is processed, the value of X-Subject-Token in the message header is the token value.

+

No

+

This parameter is mandatory for token authentication.

+

The following is part of an example token:

+

MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

+
+
+
+

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.

+
+
+
+Content-Type: application/json
+
+{
+    "auth": {
+        "identity": {
+            "methods": [
+                "password"
+            ],
+            "password": {
+                "user": {
+                    "name": "username",
+                    "password": "********",
+                    "domain": {
+                        "name": "domainname"
+                    }
+                }
+            }
+        },
+        "scope": {
+            "project": {
+                "name": "xxxxxxxxxxxxxxxxxx"
+            }
+        }
+    }
+}
+

If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.

+
+
+
+
+
Parent topic: API Usage Guidelines
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_03_0006.html b/docs/taurusdb/api-ref/gaussdb_03_0006.html new file mode 100644 index 000000000..9772ba99c --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_03_0006.html @@ -0,0 +1,39 @@ + + +

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.

+
+

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
+
+

(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.

+
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",
+        "methods": [
+            "password"
+        ],
+        "catalog": [
+            {
+                "endpoints": [
+                    {
+                        "region_id": "az-01",
+......
+
+
If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
{
+	"error_code": "AS.0001",
+	"error_msg": "The format of message is error"
+}
+
+

In the response body, error_code is an error code, and error_msg provides information about the error.

+
+
+
+
+
Parent topic: API Usage Guidelines
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0000.html b/docs/taurusdb/api-ref/gaussdb_04_0000.html new file mode 100644 index 000000000..1783ffd57 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0000.html @@ -0,0 +1,33 @@ + + +

APIs (Recommended)

+
+
+ +
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0001.html b/docs/taurusdb/api-ref/gaussdb_04_0001.html new file mode 100644 index 000000000..d0f02d5e6 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0001.html @@ -0,0 +1,197 @@ + + +

Querying Version Information About a DB Engine

+

Function

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

+ +
+

URI

GET /v3/{project_id}/datastores/{database_name}

+ +
+ + + + + + + + + + + + + + + + +
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.

+

database_name

+

Yes

+

String

+

DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

datastores

+

Array of MysqlEngineVersionInfo objects

+

DB versions.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 MysqlEngineVersionInfo

Parameter

+

Type

+

Description

+

id

+

String

+

DB version ID. Its value is unique.

+

name

+

String

+

DB version number. Only the major version number with two digits is returned.

+
+
+

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

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

Example Response

Status code: 200

+

Success.

+
{
+  "datastores" : [ {
+    "id" : "87620726-6802-46c0-9028-a8785e1f1921",
+    "name" : "8.0"
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0002.html b/docs/taurusdb/api-ref/gaussdb_04_0002.html new file mode 100644 index 000000000..984ef8d40 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0002.html @@ -0,0 +1,291 @@ + + +

Querying Database Specifications

+

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}

+ +
+ + + + + + + + + + + + + + + + +
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.

+

database_name

+

Yes

+

String

+

DB engine.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

version_name

+

No

+

String

+

DB version number. To obtain this value, see Querying Version Information About a DB Engine.

+

Currently, only MySQL 8.0 is supported.

+

availability_zone_mode

+

Yes

+

String

+

AZ mode. Its value can be single or multi and is case-insensitive.

+

spec_code

+

No

+

String

+

Specification code.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

flavors

+

Array of MysqlFlavorsInfo objects

+

DB instance specifications.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 MysqlFlavorsInfo

Parameter

+

Type

+

Description

+

vcpus

+

String

+

Number of vCPUs. For example, the value 1 indicates 1 vCPU.

+

ram

+

String

+

Memory size in GB.

+

type

+

String

+

Specification type. The value is x86.

+

id

+

String

+

Specification ID. The value must be unique.

+

spec_code

+

String

+

Resource specification code. Its value is same as the value of flavor_ref. Example: gaussdb.mysql.xlarge.x86.8.

+

version_name

+

String

+

DB version number.

+

instance_mode

+

String

+

DB instance type. Currently, its value can only be Cluster.

+

az_status

+

Map<String,String>

+

Specification status in an AZ.

+
  • normal: The specifications are available.
  • unsupported: The specifications are not supported.
  • sellout: The specifications are sold out.
+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.x86.8&availability_zone_mode=single
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "flavors" : [ {
+    "vcpus" : "4",
+    "ram" : "32",
+    "type" : "x86",
+    "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
+    "spec_code" : "gaussdb.mysql.xlarge.x86.8",
+    "instance_mode" : "Cluster",
+    "version_name" : "8.0",
+    "az_status" : {
+      "eu-de-01" : "normal",
+      "eu-de-02" : "normal"
+    }
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0003.html b/docs/taurusdb/api-ref/gaussdb_04_0003.html new file mode 100644 index 000000000..f18dd9592 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0003.html @@ -0,0 +1,38 @@ + + +

Managing DB Instances

+

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0004.html b/docs/taurusdb/api-ref/gaussdb_04_0004.html new file mode 100644 index 000000000..c7833d774 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0004.html @@ -0,0 +1,738 @@ + + +

Creating a DB Instance

+

Function

This API is used to create a DB instance. Before calling this API:

+ +
+

URI

POST /v3/{project_id}/instances

+ +
+ + + + + + + + + + + +
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.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

charge_info

+

No

+

MysqlChargeInfo object

+

Billing mode.

+

region

+

Yes

+

String

+

Region ID.

+

The value cannot be empty. To obtain this value, see Regions and Endpoints.

+

name

+

Yes

+

String

+

DB instance name.

+

DB instances of the same type can have same names under the same tenant.

+

The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_).

+

datastore

+

Yes

+

MysqlDatastore object

+

Database information.

+

mode

+

Yes

+

String

+

DB instance type. Its value is Cluster.

+

flavor_ref

+

Yes

+

String

+

Specification code.

+

vpc_id

+

Yes

+

String

+

VPC ID. To obtain this value, use either of the following methods:

+
  • Method 1: Log in to the VPC console and view the VPC ID on the VPC details page.
  • Method 2: See "Querying VPCs" in the Virtual Private Cloud API Reference.
+

subnet_id

+

Yes

+

String

+

Network ID. To obtain this value, use either of the following methods:

+
  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
  • Method 2: See "Querying Subnets" in the Virtual Private Cloud API Reference.
+

security_group_id

+

No

+

String

+

Security group ID.

+

If network ACL is enabled, this parameter cannot be specified. If network ACL is disabled, this parameter is mandatory.

+
  • Method 1: Log in to VPC console. Choose Access Control > Security Groups in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.
  • Method 2: See "Querying Security Groups" in the Virtual Private Cloud API Reference.
+

configuration_id

+

No

+

String

+

Parameter template ID.

+

password

+

Yes

+

String

+

Database password. The password consists of 8 to 32 characters and contains at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^*-_=+?,()&). You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid.

+

backup_strategy

+

No

+

MysqlBackupStrategy object

+

Automated backup policy.

+

time_zone

+

No

+

String

+

Time zone. The default time zone is UTC.

+

availability_zone_mode

+

Yes

+

String

+

AZ type. The value can be single or multi.

+

master_availability_zone

+

No

+

String

+

Primary AZ.

+
  • If availability_zone_mode is set to multi, this parameter is mandatory.
  • If availability_zone_mode is set to single, this parameter cannot be specified.
+

slave_count

+

Yes

+

Integer

+

Number of read replicas. A maximum of nine read replicas can be created at a time.

+

tags

+

No

+

Array of MysqlTags objects

+

Tag list. DB instances are created based on tag keys and values.

+
  • {key} indicates the tag key. It must be unique and cannot be empty.
  • {value} indicates the tag value, which can be empty.
+

To create DB instances with multiple tag keys and values, separate key-value pairs with commas (,). Up to 10 key-value pairs can be added.

+

enterprise_project_id

+

No

+

String

+

Enterprise project ID. This parameter is mandatory when the enterprise project is enabled.

+

dedicated_resource_id

+

No

+

String

+

Dedicated resource pool ID. This parameter is displayed only when the dedicated resource pool is enabled.

+
+
+ +
+ + + + + + + + + + + +
Table 4 MysqlChargeInfo

Parameter

+

Mandatory

+

Type

+

Description

+

charge_mode

+

Yes

+

String

+

Billing mode.

+

Value: postPaid

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 MysqlDatastore

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

DB engine. Currently, only gaussdb-mysql is supported.

+

version

+

Yes

+

String

+

DB version.

+

For details about supported DB versions, see Querying Version Information About a DB Engine.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 MysqlBackupStrategy

Parameter

+

Mandatory

+

Type

+

Description

+

start_time

+

Yes

+

String

+

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.

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

Example value:

+
  • 21:00-22:00
+

keep_days

+

No

+

String

+

Automated backup retention days. Value: 1-732.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 7 MysqlTags

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key. It contains a maximum of 36 Unicode characters.

+

The value cannot be an empty string, a space, or left blank.

+

Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

+

value

+

Yes

+

String

+

Tag value. It contains a maximum of 43 Unicode characters.

+

It can be an empty string.

+

Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

instance

+

MysqlInstanceResponse object

+

DB instance information.

+

job_id

+

String

+

DB instance creation task ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 MysqlInstanceResponse

Parameter

+

Type

+

Description

+

id

+

String

+

DB instance ID.

+

name

+

String

+

DB instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_).

+

status

+

String

+

DB instance status.

+

datastore

+

MysqlDatastore object

+

Database information.

+

mode

+

String

+

DB instance type. Its value is Cluster.

+

configuration_id

+

String

+

Parameter template ID.

+

port

+

String

+

Database port.

+

backup_strategy

+

MysqlBackupStrategy object

+

Automated backup policy.

+

region

+

String

+

Region ID, which is the same as the request parameter.

+

availability_zone_mode

+

String

+

AZ mode, which is the same as the request parameter.

+

master_availability_zone

+

String

+

Primary AZ ID.

+

vpc_id

+

String

+

VPC ID, which is the same as the request parameter.

+

security_group_id

+

String

+

Security group ID, which is the same as the request parameter.

+

subnet_id

+

String

+

Subnet ID, which is the same as the request parameter.

+

flavor_ref

+

String

+

Specification code, which is the same as the request parameter.

+

charge_info

+

MysqlChargeInfo object

+

Billing mode.

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 MysqlDatastore

Parameter

+

Type

+

Description

+

type

+

String

+

DB engine. Currently, only gaussdb-mysql is supported.

+

version

+

String

+

DB version.

+

To obtain details about supported DB engine versions, call the API for querying the DB engine versions.

+
+
+ +
+ + + + + + + + + + + + + +
Table 11 MysqlBackupStrategy

Parameter

+

Type

+

Description

+

start_time

+

String

+

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.
+

keep_days

+

String

+

Automated backup retention days. Value: 1-732.

+
+
+ +
+ + + + + + + + + +
Table 12 MysqlChargeInfo

Parameter

+

Type

+

Description

+

charge_mode

+

String

+

Billing mode.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 13 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 14 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Creating a DB instance

+
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances 
+{
+  "name" : "taurusdb-instance1",
+  "region" : "eu-de",
+  "charge_info" : {
+    "charge_mode" : "postPaid"
+  },
+  "datastore" : {
+    "type" : "gaussdb-mysql",
+    "version" : "8.0"
+  },
+  "mode" : "Cluster",
+  "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
+  "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
+  "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
+  "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
+  "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07",
+  "password" : "xxxxxx",
+  "backup_strategy" : {
+    "start_time" : "08:00-09:00"
+  },
+  "availability_zone_mode" : "single",
+  "slave_count" : 1,
+  "enterprise_project_id" : 0
+}
+
+

Example Response

Status code: 201

+

Success.

+
{
+  "instance" : {
+    "id" : "5eebbb4c0f9f4a99b42ed1b6334569aain07",
+    "name" : "taurusdb-instance1",
+    "region" : "eu-de",
+    "charge_info" : {
+      "charge_mode" : "postPaid"
+    },
+    "datastore" : {
+      "type" : "gaussdb-mysql",
+      "version" : "8.0"
+    },
+    "mode" : "Cluster",
+    "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
+    "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
+    "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
+    "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
+    "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07",
+    "backup_strategy" : {
+      "start_time" : "08:00-09:00",
+      "keep_days" : 7
+    },
+    "availability_zone_mode" : "single",
+    "slave_count" : 1
+  },
+  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0005.html b/docs/taurusdb/api-ref/gaussdb_04_0005.html new file mode 100644 index 000000000..104c9aa1d --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0005.html @@ -0,0 +1,619 @@ + + +

Querying DB Instances

+

Function

This API is used to query DB instances according to search criteria. Before using this API:

+ +
+

URI

GET /v3/{project_id}/instances

+ +
+ + + + + + + + + + + +
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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

DB instance ID. The asterisk (*) is reserved for the system. If the DB instance ID starts with *, it indicates that fuzzy match is performed based on the value following *. Otherwise, the exact match is performed based on the DB instance ID. The value cannot contain only asterisks (*).

+

name

+

No

+

String

+

DB instance name. The asterisk (*) is reserved for the system. If the instance name starts with *, it indicates that fuzzy match is performed based on the value following *. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (*).

+

type

+

No

+

String

+

DB instance type to be queried. Currently, its value can only be Cluster.

+

datastore_type

+

No

+

String

+

DB type. Currently, only gaussdb-mysql is supported.

+

vpc_id

+

No

+

String

+

VPC ID.

+

subnet_id

+

No

+

String

+

Network ID of the subnet.

+

private_ip

+

No

+

String

+

Private IP address.

+

offset

+

No

+

Integer

+

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

+

No

+

Integer

+

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.

+

tags

+

No

+

String

+

Query based on the DB instance tag key and value. {key} indicates the tag key, and {value} indicates the tag value. To query DB instances with multiple tag keys and values, separate key-value pairs with commas (,). The key must be unique. Multiple keys are in AND relationship.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instances

+

Array of MysqlInstanceListInfo objects

+

DB instance list information.

+

total_count

+

Integer

+

Total number of records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 MysqlInstanceListInfo

Parameter

+

Type

+

Description

+

id

+

String

+

DB instance ID.

+

name

+

String

+

DB instance name.

+

status

+

String

+

DB instance status.

+

private_ips

+

Array of strings

+

Private IP address for write. It is a blank string until an ECS is created.

+

public_ips

+

Array of strings

+

Public IP addresses.

+

port

+

String

+

Database port.

+

type

+

String

+

DB instance type. The value is Cluster.

+

region

+

String

+

Region where the DB instance is deployed.

+

datastore

+

MysqlDatastore object

+

Database information.

+

created

+

String

+

Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. The value is empty unless the DB instance creation is complete.

+

updated

+

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.

+

db_user_name

+

String

+

Default username.

+

vpc_id

+

String

+

VPC ID.

+

subnet_id

+

String

+

Network ID of the subnet.

+

security_group_id

+

String

+

Security group ID.

+

flavor_ref

+

String

+

Specification code.

+

flavor_info

+

MysqlFlavorInfo object

+

Flavor information.

+

volume

+

MysqlVolumeInfo object

+

Storage disk information.

+

backup_strategy

+

MysqlBackupStrategy object

+

Automated backup policy.

+

time_zone

+

String

+

Time zone.

+

dedicated_resource_id

+

String

+

Dedicated resource pool ID. This parameter is returned only when the DB instance belongs to a dedicated resource pool.

+

tags

+

Array of InstanceTagItem objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 MysqlDatastoreWithKernelVersion

Parameter

+

Type

+

Description

+

type

+

String

+

DB engine. Currently, only gaussdb-mysql is supported.

+

version

+

String

+

DB version.

+

To obtain details about supported DB engine versions, call the API for querying the DB engine versions.

+

kernel_version

+

String

+

Database kernel version.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 MysqlFlavorInfo

Parameter

+

Type

+

Description

+

vcpus

+

String

+

Number of vCPUs.

+

ram

+

String

+

Memory size in GB.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 MysqlVolumeInfo

Parameter

+

Type

+

Description

+

type

+

String

+

Disk type.

+

size

+

String

+

Used disk size in GB.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 MysqlBackupStrategy

Parameter

+

Type

+

Description

+

start_time

+

String

+

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.
+

keep_days

+

String

+

Automated backup retention days. Value: 1-732.

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 InstanceTagItem

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+

value

+

String

+

Tag value.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Querying DB instances

+
GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances?id=d738399de028480fabb2b8120d4e01a4in07&name=taurusdb-instance01&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=3cedfc54-b105-4652-a4e0-847b11576b58&subnet_id=c1cfa53c-65d3-431e-8552-326bf310c7ad&private_ip=192.168.0.142&offset=0&limit=10&tags=Key1=Value1
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "total_count" : 1,
+  "instances" : [ {
+    "id" : "d738399de028480fabb2b8120d4e01a4in07",
+    "name" : "taurusdb-instance01",
+    "status" : "ACTIVE",
+    "port" : 3306,
+    "type" : "Cluster",
+    "private_ips" : [ "192.168.0.142" ],
+    "db_user_name" : "root",
+    "region" : "eu-de",
+    "datastore" : {
+      "type" : "gaussdb-mysql",
+      "version" : "8.0",
+      "kernel_version" : "2.0.28.7"
+    },
+    "created" : "2018-08-20T02:33:49_0800",
+    "updated" : "2018-08-20T02:33:49_0800",
+    "volume" : {
+      "type" : "POOL",
+      "size" : 100
+    },
+    "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
+    "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
+    "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
+    "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
+    "flavor_info" : {
+      "vcpus" : 4,
+      "ram" : 32
+    },
+    "backup_strategy" : {
+      "start_time" : "19:00-20:00",
+      "keep_days" : 7
+    },
+    "charge_info" : {
+      "charge_mode" : "postPaid"
+    },
+    "enterprise_project_id" : 0,
+    "time_zone" : "UTC",
+    "tags": [{ 
+       "key":"Key",
+       "value":"Value1" 
+     }]
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0006.html b/docs/taurusdb/api-ref/gaussdb_04_0006.html new file mode 100644 index 000000000..9869c3329 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0006.html @@ -0,0 +1,805 @@ + + +

Querying Details of a DB Instance

+

Function

This API is used to query the details of a specified DB instance. Before using this API:

+ +
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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

+

DB instance ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

instance

+

MysqlInstanceInfoDetail object

+

DB instance information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MysqlInstanceInfoDetail

Parameter

+

Type

+

Description

+

id

+

String

+

DB instance ID.

+

name

+

String

+

DB instance name.

+

project_id

+

String

+

Project ID of a tenant in a region.

+

status

+

String

+

DB instance status.

+

Valid value:

+

If the value is BUILD, the DB instance is being created.

+

If the value is ACTIVE, the DB instance is normal.

+

If the value is FAILED, the DB instance is abnormal.

+

If the value is FROZEN, the DB instance is frozen.

+

If the value is MODIFYING, the DB instance is being scaled up.

+

If the value is REBOOTING, the DB instance is being rebooted.

+

If the value is RESTORING, the DB instance is being restored.

+

If the value is MODIFYING INSTANCE TYPE, the DB instance is changing from primary to standby.

+

If the value is SWITCHOVER, the primary/standby switchover is being performed.

+

If the value is MIGRATING, the DB instance is being migrated.

+

If the value is BACKING UP, the DB instance is being backed up.

+

If the value is MODIFYING DATABASE PORT, the database port is being changed.

+

If the value is STORAGE FULL, the DB instance storage space is full.

+

port

+

String

+

Database port.

+

alias

+

String

+

DB instance remarks.

+

type

+

String

+

DB instance type. The value is Cluster.

+

charge_info

+

MysqlInstanceChargeInfo object

+

Billing mode, which is yearly/monthly or pay-per-use (default setting).

+

node_count

+

Integer

+

Number of nodes.

+

datastore

+

MysqlDatastore object

+

Database information.

+

backup_used_space

+

Double

+

Used backup space in GB.

+

created

+

String

+

Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. The value is empty unless the DB instance creation is complete.

+

updated

+

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.

+

private_write_ips

+

Array of strings

+

Private IP address for write.

+

public_ips

+

String

+

Public IP address of the DB instance.

+

db_user_name

+

String

+

Default username.

+

vpc_id

+

String

+

VPC ID.

+

subnet_id

+

String

+

Network ID of the subnet.

+

security_group_id

+

String

+

Security group ID.

+

configuration_id

+

String

+

ID of the parameter template used for creating a DB instance or ID of the latest parameter template that is applied to an instance.

+

backup_strategy

+

MysqlBackupStrategy object

+

Automated backup policy.

+

nodes

+

Array of MysqlInstanceNodeInfo objects

+

Node information.

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

time_zone

+

String

+

Time zone.

+

az_mode

+

String

+

AZ type. It can be single or multi.

+

master_az_code

+

String

+

Primary AZ.

+

maintenance_window

+

String

+

Maintenance window in the UTC format.

+

tags

+

Array of MysqlTags objects

+

Tags for managing DB instances.

+

dedicated_resource_id

+

String

+

Dedicated resource pool ID. This parameter is returned only when the DB instance belongs to a dedicated resource pool.

+

proxies

+

Array of MysqlProxyInfo objects

+

Proxy information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 MysqlInstanceChargeInfo

Parameter

+

Type

+

Description

+

charge_mode

+

String

+

Billing mode.

+

order_id

+

String

+

Order ID.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 MysqlDatastoreWithKernelVersion

Parameter

+

Type

+

Description

+

type

+

String

+

DB engine. Currently, only gaussdb-mysql is supported.

+

version

+

String

+

DB version.

+

To obtain details about supported DB engine versions, call the API for querying the DB engine versions.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 MysqlBackupStrategy

Parameter

+

Type

+

Description

+

start_time

+

String

+

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.
+

keep_days

+

String

+

Automated backup retention days. Value: 1-732.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 MysqlInstanceNodeInfo

Parameter

+

Type

+

Description

+

id

+

String

+

DB instance ID.

+

name

+

String

+

Node name.

+

type

+

String

+

Node type, which can be master or slave.

+

status

+

String

+

Node status.

+

port

+

Integer

+

Database port.

+

private_read_ips

+

Array of strings

+

Private IP address for read of the node.

+

volume

+

MysqlInstanceNodeVolumeInfo object

+

Storage disk information.

+

az_code

+

String

+

AZ.

+

region_code

+

String

+

Region where the DB instance is located.

+

created

+

String

+

Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. The value is empty unless the DB instance creation is complete.

+

updated

+

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.

+

flavor_id

+

String

+

Specification ID.

+

flavor_ref

+

String

+

Specification code.

+

max_connections

+

String

+

Maximum number of connections.

+

vcpus

+

String

+

Number of vCPUs.

+

ram

+

String

+

Memory size in GB.

+

need_restart

+

Boolean

+

Whether to reboot the DB instance for the parameter modifications to take effect.

+

priority

+

Integer

+

Failover priority.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 9 MysqlInstanceNodeVolumeInfo

Parameter

+

Type

+

Description

+

type

+

String

+

Disk type.

+

used

+

String

+

Used disk size in GB.

+

size

+

Long

+

Disk size of the yearly/monthly DB instance in GB

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 MysqlTags

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key. The value can contain a maximum of 36 Unicode characters. The value cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

+

value

+

String

+

Tag value. It contains a maximum of 43 Unicode characters. The value can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 11 MysqlProxyInfo

Parameter

+

Type

+

Description

+

pool_id

+

String

+

Proxy instance ID.

+

name

+

String

+

Proxy instance name.

+

address

+

String

+

Proxy read/write splitting address.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 13 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Querying instance details

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

Example Response

Status code: 201

+

Success.

+
{
+  "instance" : {
+    "id" : "436aaafb689c4250a9a5bb33cb271e8cin07",
+    "name" : "taurusdb-instance01",
+    "alias" : "",
+    "status" : "ACTIVE",
+    "project_id" : "97b026aa9cc4417888c14c84a1ad9860",
+    "enterprise_project_id" : 0,
+    "type" : "Cluster",
+    "charge_info" : {
+      "charge_mode" : "postPaid",
+      "order_id" : ""
+    },
+    "node_count" : 2,
+    "datastore" : {
+      "type" : "gaussdb-mysql",
+      "version" : "8.0",
+      "kernel_version" : "2.0.29.1"
+    },
+    "created" : "2022-07-14T16:26:58+0800",
+    "updated" : "2022-07-18T14:20:33+0800",
+    "public_ips" : [ "10.154.219.187" ],
+    "private_write_ips" : [ "192.168.0.142" ],
+    "db_user_name" : "root",
+    "port" : 3306,
+    "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
+    "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
+    "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
+    "backup_strategy" : {
+      "start_time" : "19:00-20:00",
+      "keep_days" : 7
+    },
+    "nodes" : [ {
+      "id" : "799a0f2fa49a4151bf9f7063c1fbba36no07",
+      "name" : "taurusdb-d616-lb07_node01",
+      "type" : "master",
+      "status" : "ACTIVE",
+      "port" : 3306,
+      "private_read_ips" : [ "192.168.0.163" ],
+      "volume" : {
+        "type" : "POOL",
+        "used" : 0.07
+      },
+      "az_code" : "eu-de-01",
+      "region_code" : "eu-de",
+      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
+      "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
+      "max_connections" : 10000,
+      "vcpus" : 4,
+      "ram" : 32,
+      "need_restart" : false,
+      "priority" : 1,
+      "created" : "2022-07-14T16:26:58+0800",
+      "updated" : "2022-07-18T09:24:18+0800"
+    }, {
+      "id" : "799a0f2fa49a4151bf9f7063c1fbba35no07",
+      "name" : "taurusdb-d616-lb07_node02",
+      "type" : "slave",
+      "status" : "ACTIVE",
+      "port" : 3306,
+      "private_read_ips" : [ "192.168.0.162" ],
+      "volume" : {
+        "type" : "POOL",
+        "used" : 0.07
+      },
+      "az_code" : "eu-de-01",
+      "region_code" : "eu-de",
+      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
+      "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
+      "max_connections" : 10000,
+      "vcpus" : 4,
+      "ram" : 32,
+      "need_restart" : false,
+      "priority" : 1,
+      "created" : "2022-07-14T16:26:58+0800",
+      "updated" : "2022-07-18T09:36:18+0800"
+    } ],
+    "time_zone" : "UTC+08:00",
+    "backup_used_space" : 0.24,
+    "az_mode" : "single",
+    "master_az_code" : "eu-de-01",
+    "maintenance_window" : "18:00-22:00",
+    "tags" : [ ],
+    "configuration_id" : "53570e0de54e40c5a15f331aa5sd2176pr07",
+    "dedicated_resource_id" : "",
+    "proxies" : [ {
+      "pool_id" : "dab1cfc5150c4d1ca0e8c6596bfc0d8cpo01",
+      "address" : "192.168.10.76",
+      "name" : "proxy-name"
+    } ]
+  }
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0007.html b/docs/taurusdb/api-ref/gaussdb_04_0007.html new file mode 100644 index 000000000..28a71aeb4 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0007.html @@ -0,0 +1,168 @@ + + +

Deleting a DB Instance

+

Function

This API is used to delete a DB instance. Before calling this API:

+ +
+

URI

DELETE /v3/{project_id}/instances/{instance_id}

+ +
+ + + + + + + + + + + + + + + + +
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

+

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

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

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

Example Response

Status code: 500

+

Server error.

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0008.html b/docs/taurusdb/api-ref/gaussdb_04_0008.html new file mode 100644 index 000000000..83b29ec3e --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0008.html @@ -0,0 +1,17 @@ + + +

Parameter Template Management

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0009.html b/docs/taurusdb/api-ref/gaussdb_04_0009.html new file mode 100644 index 000000000..e1c7b745c --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0009.html @@ -0,0 +1,288 @@ + + +

Querying Parameter Templates

+

Function

This API is used to obtain parameter templates, including all databases' default and custom parameter templates. Before calling this API:

+ +
+

URI

GET /v3/{project_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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

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

+

No

+

Integer

+

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.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

configurations

+

Array of ConfigurationSummary objects

+

Parameter template information.

+

total_count

+

Integer

+

Total number of parameter templates.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ConfigurationSummary

Parameter

+

Type

+

Description

+

id

+

String

+

Parameter template ID.

+

name

+

String

+

Parameter template name.

+

description

+

String

+

Parameter template description.

+

datastore_version_name

+

String

+

Engine version

+

datastore_name

+

String

+

Engine name.

+

created

+

String

+

Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

updated

+

String

+

Update time in the "yyyy-MM-ddTHH:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

user_defined

+

Boolean

+

Whether the parameter template is a custom template.

+
  • false: The parameter template is a default template.
  • true: The parameter template is a custom template.
+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/configurations
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "total_count" : 1,
+  "configurations" : [ {
+    "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07",
+    "name" : "configuration_test",
+    "description" : "configuration_test",
+    "datastore_version_name" : "8.0",
+    "datastore_name" : "GaussDB(for MySQL)",
+    "created" : "2019-05-15T11:53:34+0000",
+    "updated" : "2019-05-15T11:53:34+0000",
+    "user_defined" : true
+  }, {
+    "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07",
+    "name" : "Default-TaurusDB V2.0",
+    "description" : "Default parameter template for TaurusDB",
+    "datastore_version_name" : "8.0",
+    "datastore_name" : "GaussDB(for MySQL)",
+    "created" : "2019-05-27T03:38:51+0000",
+    "updated" : "2019-05-27T03:38:51+0000",
+    "user_defined" : false
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0010.html b/docs/taurusdb/api-ref/gaussdb_04_0010.html new file mode 100644 index 000000000..4bba95585 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0010.html @@ -0,0 +1,21 @@ + + +

Quota Management

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0011.html b/docs/taurusdb/api-ref/gaussdb_04_0011.html new file mode 100644 index 000000000..a16e81864 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0011.html @@ -0,0 +1,285 @@ + + +

Querying Resource Quotas

+

Function

This API is used to obtain the resource quotas of a specified enterprise project. Before using this API:

+ +
+

URI

GET /v3/{project_id}/quotas

+ +
+ + + + + + + + + + + +
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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

String

+

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. Value: 0 to 10000

+

limit

+

No

+

String

+

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

+

enterprise_project_name

+

No

+

String

+

Enterprise project name.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

quota_list

+

Array of quota objects

+

Resource list objects.

+

total_count

+

Integer

+

Number of quota records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 quota

Parameter

+

Type

+

Description

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

enterprise_project_name

+

String

+

Enterprise project name.

+

instance_quota

+

Integer

+

Quota of the DB instance quantity.

+

vcpus_quota

+

Integer

+

Quota of vCPUs.

+

ram_quota

+

Integer

+

Memory quota in GB.

+

availability_instance_quota

+

Integer

+

Remaining quota of DB instances.

+

availability_vcpus_quota

+

Integer

+

Remaining quota of vCPUs.

+

availability_ram_quota

+

Integer

+

Remaining memory quota.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "quota_list" : [ {
+    "enterprise_project_id" : "0",
+    "enterprise_project_name" : "default",
+    "instance_quota" : 20,
+    "vcpus_quota" : 20,
+    "ram_quota" : 40,
+    "availability_instance_quota" : 1,
+    "availability_vcpus_quota" : 4,
+    "availability_ram_quota" : 8
+  } ],
+  "total_count":1
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Quota Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0012.html b/docs/taurusdb/api-ref/gaussdb_04_0012.html new file mode 100644 index 000000000..4d8396002 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0012.html @@ -0,0 +1,252 @@ + + +

Configuring Resource Quotas

+

Function

This API is used to configure resource quotas for a specified enterprise project. Before using this API:

+ +
+

Precautions

Before using this API, ensure that the enterprise project has been enabled and you have the gaussdb:quota:modify permission.

+
+

URI

POST /v3/{project_id}/quotas

+ +
+ + + + + + + + + + + +
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.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

quota_list

+

Yes

+

Array of setQuota objects

+

Quota details. Up to 10 quota records can be configured at a time.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 setQuota

Parameter

+

Mandatory

+

Type

+

Description

+

enterprise_project_id

+

Yes

+

String

+

Enterprise project ID.

+

enterprise_project_name

+

Yes

+

String

+

Enterprise project name.

+

instance_quota

+

Yes

+

Integer

+

Quota of the DB instance quantity. Value: 0 to 100000. (If there are already DB instances created, this parameter value must be greater than the number of existing instances.)

+

vcpus_quota

+

Yes

+

Integer

+

Quota of vCPUs. Value: 0 to 2147483646. (If there are already DB instances created, this parameter value must be greater than the number of used vCPUs.)

+

ram_quota

+

Yes

+

Integer

+

Memory quota in GB. Value: 0 to 2147483646. (If there are already DB instances created, this parameter value must be greater than the used memory size.)

+
+
+
+

Response Parameters

Status code: 201

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

Parameter

+

Type

+

Description

+

quota_list

+

Array of setQuota objects

+

Configured quota information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 setQuota

Parameter

+

Type

+

Description

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

enterprise_project_name

+

String

+

Enterprise project name.

+

instance_quota

+

Integer

+

Quota of the DB instance quantity.

+

vcpus_quota

+

Integer

+

Quota of vCPUs.

+

ram_quota

+

Integer

+

Memory quota in GB.

+
+
+
+

Example Request

+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas
+{
+  "quota_list" : [ {
+    "enterprise_project_id" : "0",
+    "enterprise_project_name" : "default",
+    "instance_quota" : 20,
+    "vcpus_quota" : 20,
+    "ram_quota" : 40
+  } ]
+}
+
+

Example Response

Status code: 201

+

Success.

+
{
+  "quota_list" : [ {
+    "enterprise_project_id" : "0",
+    "enterprise_project_name" : "default",
+    "instance_quota" : 20,
+    "vcpus_quota" : 20,
+    "ram_quota" : 40
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Quota Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0013.html b/docs/taurusdb/api-ref/gaussdb_04_0013.html new file mode 100644 index 000000000..2093b2f62 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0013.html @@ -0,0 +1,306 @@ + + +

Modifying Resource Quotas

+

Function

This API is used to modify the resource quota of a specified enterprise project.

+ +
+

Precautions

Before using this API, ensure that the enterprise project has been enabled and you have the gaussdb:quota:modify permission.

+
+

URI

PUT /v3/{project_id}/quotas

+ +
+ + + + + + + + + + + +
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.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

quota_list

+

Yes

+

Array of setQuota objects

+

Enterprise project resource quotas to be updated. A maximum of 10 quotas can be updated at a time.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 setQuota

Parameter

+

Mandatory

+

Type

+

Description

+

enterprise_project_id

+

Yes

+

String

+

Enterprise project ID.

+

enterprise_project_name

+

Yes

+

String

+

Enterprise project name.

+

instance_quota

+

Yes

+

Integer

+

Quota of the DB instance quantity. Value: 0 to 100000. (If there are already instances created, this parameter value must be greater than the number of existing instances.)

+

vcpus_quota

+

Yes

+

Integer

+

Quota of vCPUs. Value: 0 to 2147483646. (If there are already instances created, this parameter value must be greater than the number of used vCPUs.)

+

ram_quota

+

Yes

+

Integer

+

Memory quota in GB. Value: 0 to 2147483646. (If there are already instances created, this parameter value must be greater than the used memory size.)

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

quota_list

+

Array of setQuota objects

+

Configured quota information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 setQuota

Parameter

+

Type

+

Description

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

enterprise_project_name

+

String

+

Enterprise project name.

+

instance_quota

+

Integer

+

Quota of the DB instance quantity.

+

vcpus_quota

+

Integer

+

Quota of vCPUs.

+

ram_quota

+

Integer

+

Memory quota in GB.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

+PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas
+{
+  "quota_list" : [ {
+    "enterprise_project_id" : "0",
+    "enterprise_project_name" : "default",
+    "instance_quota" : 20,
+    "vcpus_quota" : 20,
+    "ram_quota" : 40
+  } ]
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "quota_list" : [ {
+    "enterprise_project_id" : "0",
+    "enterprise_project_name" : "default",
+    "instance_quota" : 20,
+    "vcpus_quota" : 20,
+    "ram_quota" : 40
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Quota Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0014.html b/docs/taurusdb/api-ref/gaussdb_04_0014.html new file mode 100644 index 000000000..4266c27f0 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0014.html @@ -0,0 +1,15 @@ + + +

Task Center

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0015.html b/docs/taurusdb/api-ref/gaussdb_04_0015.html new file mode 100644 index 000000000..dfff359ec --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0015.html @@ -0,0 +1,213 @@ + + +

Creating a Read Replica

+

Function

This API is used to create a read replica. Before using this API:

+ +
+

URI

POST /v3/{project_id}/instances/{instance_id}/nodes/enlarge

+ +
+ + + + + + + + + + + + + + + + +
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

+

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

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

priorities

+

Yes

+

Array of integers

+

Failover priority of a read replica. Failover priority ranges from 1 for the first priority to 16 for the last priority. This priority determines the order in which read replicas are promoted when recovering from a primary node failure. Read replicas with the same priority have a same probability of being promoted to the new primary node.

+
+
+
+

Response Parameters

Status code: 201

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

Parameter

+

Type

+

Description

+

instance_id

+

String

+

DB instance ID.

+

node_names

+

Array of strings

+

Node name list

+

job_id

+

String

+

Read replica creation task ID.

+

This parameter is returned only when a pay-per-use read replica is created.

+
+
+

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

Creating a read replica

+
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge
+{
+  "priorities" : [ 1, 2 ]
+}
+
+

Example Response

Status code: 201

+

Success.

+
{
+  "instance_id" : "ba62a0b83a1b42bfab275829d86ac0fdin07",
+  "node_names" : [ "taurusdb-ccf5_node03" ],
+  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0016.html b/docs/taurusdb/api-ref/gaussdb_04_0016.html new file mode 100644 index 000000000..13d07748e --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0016.html @@ -0,0 +1,177 @@ + + +

Deleting a Read Replica

+

Function

This API is used to delete a read replica. For multi-AZ deployment, the primary node and remaining read replicas must be located in different AZs after read replicas are deleted. Before calling this API:

+ +
+

URI

DELETE /v3/{project_id}/instances/{instance_id}/nodes/{node_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
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

+

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

+

node_id

+

Yes

+

String

+

Node ID, which is compliant with the UUID format.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

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

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0018.html b/docs/taurusdb/api-ref/gaussdb_04_0018.html new file mode 100644 index 000000000..ea95856ae --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0018.html @@ -0,0 +1,197 @@ + + +

Changing a DB Instance Name

+

Function

This API is used to change a DB instance name. Before using this API:

+ +
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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

+

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

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

DB instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID for changing a DB instance name.

+
+
+

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

Changing a DB Instance Name

+
+PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name
+{
+  "name" : "taurusdb-name"
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+

+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0019.html b/docs/taurusdb/api-ref/gaussdb_04_0019.html new file mode 100644 index 000000000..7d73b419c --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0019.html @@ -0,0 +1,174 @@ + + +

Resetting a Database Password

+

Function

This API is used to reset a database password. Before using this API:

+ +
+

URI

POST /v3/{project_id}/instances/{instance_id}/password

+ +
+ + + + + + + + + + + + + + + + +
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

+

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

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

password

+

Yes

+

String

+

Database password. The password consists of 8 to 32 characters and contains at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^*-_=+?,()&). You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid.

+
+
+
+

Response Parameters

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Resetting a database password

+
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password
+{
+  "password" : "Test_345612"
+}
+
+

Example Response

Status code: 200

+

Success.

+

None

+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_04_0020.html b/docs/taurusdb/api-ref/gaussdb_04_0020.html new file mode 100644 index 000000000..e23ecfd63 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_04_0020.html @@ -0,0 +1,221 @@ + + +

Changing DB Instance Specifications

+

Function

This API is used to change DB instance specifications. Before using this API:

+ +
+

URI

POST /v3/{project_id}/instances/{instance_id}/action

+ +
+ + + + + + + + + + + + + + + + +
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

+

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

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

resize_flavor

+

Yes

+

MysqlResizeFlavor object

+

Specification change information.

+
+
+ +
+ + + + + + + + + + + +
Table 4 MysqlResizeFlavor

Parameter

+

Mandatory

+

Type

+

Description

+

spec_code

+

Yes

+

String

+

Specification code.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Job ID for changing DB instance specifications.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Changing instance specifications

+
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action
+{
+  "resize_flavor" : {
+    "spec_code" : "gaussdb.mysql.xlarge.x86.8"
+  }
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_06_0002.html b/docs/taurusdb/api-ref/gaussdb_06_0002.html new file mode 100644 index 000000000..fad618267 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_06_0002.html @@ -0,0 +1,23 @@ + + +

Backup Management

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_06_0003.html b/docs/taurusdb/api-ref/gaussdb_06_0003.html new file mode 100644 index 000000000..773d4633c --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_06_0003.html @@ -0,0 +1,290 @@ + + +

Creating a Manual Backup

+

Function

This API is used to create a manual backup. Before using this API:

+ +
+

URI

POST /v3/{project_id}/backups/create

+ +
+ + + + + + + + + + + +
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.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

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

+

name

+

Yes

+

String

+

Backup name. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

+

description

+

No

+

String

+

Backup description. It contains a maximum of 256 characters and cannot contain the special characters (>!<"&'=)

+
+
+
+

Response Parameters

Status code: 201

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

Parameter

+

Type

+

Description

+

backup

+

backup object

+

Backup information.

+

job_id

+

String

+

Task ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 backup

Parameter

+

Type

+

Description

+

id

+

String

+

Backup ID.

+

name

+

String

+

Backup name.

+

description

+

String

+

Backup description.

+

begin_time

+

String

+

Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.

+

status

+

String

+

Backup status. Value:

+
  • BUILDING: Backup in progress
  • COMPLETED: Backup completed
  • FAILED: Backup failed
  • AVAILABLE: Backup available
+

Valid value:

+
  • BUILDING
  • COMPLETED
  • FAILED
  • AVAILABLE
+

type

+

String

+

Backup type. Value:

+

manual: manual full backup

+

Valid value:

+

manual

+

instance_id

+

String

+

DB instance ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Creating a Manual Backup

+
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create
+{
+  "instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07",
+  "name" : "backup-1",
+  "description": "Manual backup"
+}
+
+

Example Response

Status code: 201

+

Success.

+
{
+  "backup" : {
+    "id" : "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
+    "name" : "backup-1",
+    "description": "Manual backup"
+    "begin_time" : "2020-07-07T01:17:05+0800",
+    "status" : "BUILDING",
+    "type" : "manual",
+    "instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07"
+  },
+  "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_06_0004.html b/docs/taurusdb/api-ref/gaussdb_06_0004.html new file mode 100644 index 000000000..14885a1ff --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_06_0004.html @@ -0,0 +1,383 @@ + + +

Querying Backups

+

Function

This API is used to query backups according to search criteria. Before using this API:

+ +
+

URI

GET /v3/{project_id}/backups

+ +
+ + + + + + + + + + + +
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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

No

+

String

+

DB instance ID.

+

backup_id

+

No

+

String

+

Backup ID.

+

backup_type

+

No

+

String

+

Backup type. Value:

+

auto: automated full backup

+

manual: manual full backup

+

offset

+

No

+

String

+

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

+

No

+

String

+

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.

+

begin_time

+

No

+

String

+

Query start time. 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.

+

end_time

+

No

+

String

+

Query end time. The format is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

backups

+

Array of backups objects

+

Backup information.

+

total_count

+

Long

+

Total number of backup files.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 backups

Parameter

+

Type

+

Description

+

id

+

String

+

Backup ID.

+

name

+

String

+

Backup name.

+

begin_time

+

String

+

Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

end_time

+

String

+

Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

status

+

String

+

Backup status. Value:

+
  • BUILDING: Backup in progress
  • COMPLETED: Backup completed
  • FAILED: Backup failed
  • AVAILABLE: Backup available
+

Valid value:

+
  • BUILDING
  • COMPLETED
  • FAILED
  • AVAILABLE
+

take_up_time

+

Integer

+

Backup duration in minutes.

+

type

+

String

+

Backup type. Value:

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

Valid value:

+
  • auto
  • manual
+

size

+

Long

+

Backup size in MB.

+

datastore

+

MysqlDatastore object

+

Database information.

+

instance_id

+

String

+

DB instance ID.

+

description

+

String

+

Description of the backup file.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 MysqlDatastore

Parameter

+

Type

+

Description

+

type

+

String

+

DB engine. Currently, only gaussdb-mysql is supported.

+

version

+

String

+

DB version.

+

To obtain details about supported DB engine versions, call the API for querying the DB engine versions.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

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

Example Response

Status code: 200

+
Success.
{
+  "backups" : [ {
+    "id" : "c0c9f155c7b7423a9d30f0175998b63bbr01",
+    "name" : "TaurusDB-e747-20200705185048266",
+    "begin_time" : "2020-07-06T10:41:14+0800",
+    "end_time" : "2020-07-16T10:41:14+0800",
+    "take_up_time" : 2,
+    "status" : "COMPLETED",
+    "type" : "auto",
+    "size" : 2803,
+    "datastore" : {
+      "type" : "gaussdb-mysql",
+      "version" : "8.0"
+    },
+    "instance_id" : "c0c9f155c7b7423a9d30f0175998b63bbr01"
+    
+  } ],
+  "total_count" : 1
+}
+
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_06_0005.html b/docs/taurusdb/api-ref/gaussdb_06_0005.html new file mode 100644 index 000000000..e7804fcb1 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_06_0005.html @@ -0,0 +1,209 @@ + + +

Querying an Automated Backup Policy

+

Function

This API is used to query an automated backup policy. Before using this API:

+ +
+

URI

GET /v3/{project_id}/instances/{instance_id}/backups/policy

+ +
+ + + + + + + + + + + + + + + + +
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

+

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

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

backup_policy

+

BackupPolicy object

+

Backup policy information.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 BackupPolicy

Parameter

+

Type

+

Description

+

keep_days

+

Integer

+

Backup retention days. Value: 1 to 732

+

Minimum value: 1

+

Maximum value: 732

+

start_time

+

String

+

Backup time window. Automated backups will be triggered during the backup time window.

+

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

+

period

+

String

+

Backup cycle configuration. Data will be automatically backed up on the selected days every week.

+

Value range: The value is a number separated by commas (,), indicating the days of the week.

+
+
+

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

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups/policy
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "backup_policy" : {
+    "keep_days" : "7,",
+    "start_time" : "19:00-20:00",
+    "period" : "1,2"
+   }
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_06_0006.html b/docs/taurusdb/api-ref/gaussdb_06_0006.html new file mode 100644 index 000000000..2c56b5078 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_06_0006.html @@ -0,0 +1,275 @@ + + +

Modifying an Automated Backup Policy

+

Function

This API is used to modify an automated backup policy. Before using this API:

+ +
+

URI

PUT /v3/{project_id}/instances/{instance_id}/backups/policy/update

+ +
+ + + + + + + + + + + + + + + + +
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

+

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

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

backup_policy

+

Yes

+

MysqlBackupPolicy object

+

Database information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MysqlBackupPolicy

Parameter

+

Mandatory

+

Type

+

Description

+

start_time

+

Yes

+

String

+

Backup time window. Automated backups will be triggered during the backup time window.

+

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.

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

Example value:

+

21:00-22:00

+

keep_days

+

Yes

+

Integer

+

Backup retention days.

+

Value: 1 to 732

+

period

+

Yes

+

String

+

Backup cycle configuration. Data will be automatically backed up on the selected days every week.

+

Value range: The value is a number separated by commas (,), indicating the days of the week.

+

For example, the value 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.

+

retention_num_backup_level-1

+

No

+

Integer

+

Number of retained level-1 backups. The default value is 0. This parameter is mandatory when the level-1 backup function is enabled. This parameter is unavailable when the level-1 backup function is disabled. Value:

+
  • 0
  • 1
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

status

+

String

+

Backup status. Value:

+
  • BUILDING: modification in progress
  • COMPLETED: modification completed
  • FAILED: modification failed
+

instance_id

+

String

+

DB instance ID.

+

instance_name

+

String

+

DB instance name.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Modifying a backup policy

+
+PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update
+{
+  "backup_policy" : {
+    "keep_days" : 7,
+    "start_time" : "19:00-20:00",
+    "period" : "1,2,3,4,5"
+  }
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "status" : "COMPLETED",
+  "instance_id" : "ef25188419f941309882d2986b2210b9in07",
+  "instance_name" : "TaurusDB"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_10_0000.html b/docs/taurusdb/api-ref/gaussdb_10_0000.html new file mode 100644 index 000000000..08d78cdcd --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_10_0000.html @@ -0,0 +1,19 @@ + + +

Appendix

+
+
+ +
+ diff --git a/docs/taurusdb/api-ref/gaussdb_10_0001.html b/docs/taurusdb/api-ref/gaussdb_10_0001.html new file mode 100644 index 000000000..7ebf09421 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_10_0001.html @@ -0,0 +1,41 @@ + + +

Abnormal Request Results

+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_10_0002.html b/docs/taurusdb/api-ref/gaussdb_10_0002.html new file mode 100644 index 000000000..c276b4204 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_10_0002.html @@ -0,0 +1,328 @@ + + +

Status Codes

+

The following table describes status codes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Status codes

Status Code

+

Message

+

Description

+

100

+

Continue

+

The client should continue with its request.

+

This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server.

+

101

+

Switching Protocols

+

The protocol should be switched. The protocol can only be switched to a more advanced protocol.

+

For example, the current HTTP protocol is switched to a later version.

+

200

+

OK

+

Request succeeded.

+

201

+

Created

+

The request for creating a resource or task has been fulfilled.

+

202

+

Accepted

+

The request has been accepted, but the processing has not been completed.

+

203

+

Non-Authoritative Information

+

Unauthorized information. The request is successful.

+

204

+

NoContent

+

The server has successfully processed the request, but has not returned any content.

+

The status code is returned in response to an HTTP OPTIONS request.

+

205

+

Reset Content

+

The server has fulfilled the request, but the requester is required to reset the content.

+

206

+

Partial Content

+

The server has processed certain GET requests.

+

300

+

Multiple Choices

+

There are multiple options for the location of the requested resource. The response contains a list of resource characteristics and addresses from which the user or user agent (such as a browser) can choose the most appropriate one.

+

301

+

Moved Permanently

+

The requested resource has been assigned a new permanent URI, and the new URI is contained in the response.

+

302

+

Found

+

The requested resource was temporarily moved.

+

303

+

See Other

+

The response to the request can be found under a different URI and should be retrieved using a GET or POST method.

+

304

+

Not Modified

+

The requested resource has not been modified. In such a case, there is no need to retransmit the resource since the client still has a previously-downloaded copy.

+

305

+

Use Proxy

+

The requested resource must be accessed through a proxy.

+

306

+

Unused

+

The HTTP status code is no longer used.

+

400

+

BadRequest

+

Invalid request.

+

The client should not repeat the request without modifications.

+

401

+

Unauthorized

+

The status code is returned after the client provides the authentication information, indicating that the authentication information is incorrect or invalid.

+

402

+

Payment Required

+

This status code is reserved for future use.

+

403

+

Forbidden

+

The server understood the request, but is refusing to fulfill it.

+

The client should not repeat the request without modifications.

+

404

+

NotFound

+

The requested resource cannot be found.

+

The client should not repeat the request without modifications.

+

405

+

MethodNotAllowed

+

The method specified in the request is not supported for the requested resource.

+

The client should not repeat the request without modifications.

+

406

+

Not Acceptable

+

The server cannot fulfill the request according to the content characteristics of the request.

+

407

+

Proxy Authentication Required

+

This status code is similar to 401, but indicates that the client must first authenticate itself with the proxy.

+

408

+

Request Time-out

+

The server timed out waiting for the request.

+

The client may repeat the request without modifications at any later time.

+

409

+

Conflict

+

The request could not be processed due to a conflict.

+

This status code indicates that the resource that the client attempts to create already exits, or the request fails to be processed because of the update of the conflict request.

+

410

+

Gone

+

The requested resource is no longer available.

+

The requested resource has been deleted permanently.

+

411

+

Length Required

+

The server refuses to process the request without a defined Content-Length.

+

412

+

Precondition Failed

+

The server does not meet one of the preconditions that the requester puts on the request.

+

413

+

Request Entity Too Large

+

The request is larger than that a server is able to process. The server may close the connection to prevent the client from continuing the request. If the server temporarily cannot process the request, the response will contain a Retry-After header field.

+

414

+

Request-URI Too Large

+

The URI provided was too long for the server to process.

+

415

+

Unsupported Media Type

+

The server is unable to process the media format in the request.

+

416

+

Requested range not satisfied

+

The requested range is invalid.

+

417

+

Expectation Failed

+

The server fails to meet the requirements of the Expect request-header field.

+

422

+

UnprocessableEntity

+

The request is well-formed but is unable to be processed due to semantic errors.

+

429

+

TooManyRequests

+

The client has sent more requests than its rate limit is allowed within a given amount of time, or the server has received more requests than it is able to process within a given amount of time. In this case, it is advisable for the client to re-initiate requests after the time specified in the Retry-After header of the response expires.

+

500

+

InternalServerError

+

The server is able to receive the request but it could not understand the request.

+

501

+

Not Implemented

+

The server does not support the requested function.

+

502

+

Bad Gateway

+

The server acting as a gateway or proxy receives an invalid response from a remote server.

+

503

+

ServiceUnavailable

+

The requested service is invalid.

+

The client should not repeat the request without modifications.

+

504

+

ServerTimeout

+

The request cannot be fulfilled within a given time. The response will reach the client only if the request carries a timeout parameter.

+

505

+

HTTP Version not supported

+

The server does not support the HTTP protocol version used in the request.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_10_0003.html b/docs/taurusdb/api-ref/gaussdb_10_0003.html new file mode 100644 index 000000000..661ce15b5 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_10_0003.html @@ -0,0 +1,1655 @@ + + +

Error Codes

+

The following table describes error codes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Error codes

Status Code

+

Error Code

+

Error Message

+

Description

+

Troubleshooting

+

400

+

DBS.200001

+

Parameter error.

+

Parameter error.

+

Check whether the transferred parameters or URLs are correct.

+

400

+

DBS.200004

+

Parameter error.

+

Parameter error.

+

Check whether the transferred parameters or URLs are correct.

+

400

+

DBS.200006

+

The request is null. Enter a request parameter.

+

The request is null. Enter a request parameter.

+

Check whether any mandatory request parameter is empty.

+

400

+

DBS.200021

+

Invalid DB instance name.

+

Invalid DB instance name.

+

Check whether the instance name is correct.

+

400

+

DBS.200023

+

Storage space is out of range.

+

The storage space is out of range.

+

Check whether the storage space exceeds the allowed range.

+

400

+

DBS.200024

+

Invalid region.

+

Invalid region.

+

Check whether the region is correct and whether the region is available.

+

400

+

DBS.200025

+

Invalid AZ.

+

Invalid AZ.

+

Check whether the AZ name is correct and whether the AZ is available.

+

400

+

DBS.200026

+

Invalid storage type.

+

Invalid storage type.

+

Check whether the storage type is correct.

+

400

+

DBS.200027

+

Storage space must be a multiple of 10.

+

Storage space must be a multiple of 10.

+

Check whether the storage space is a multiple of 10.

+

400

+

DBS.200040

+

The DB engine or version is not supported.

+

The DB engine or version is not supported.

+

Check whether the DB engine and version match and meet the requirements.

+

400

+

DBS.200041

+

Invalid database version.

+

Invalid database version.

+

Check whether the database version is supported.

+

400

+

DBS.200042

+

The DB engine does not exist.

+

The DB engine does not exist.

+

Check whether the DB engine is supported by TaurusDB.

+

400

+

DBS.200043

+

Invalid synchronize model.

+

Invalid synchronize model.

+

Check whether the HA synchronization model meets the requirements.

+

400

+

DBS.200048

+

Invalid VPC ID.

+

Invalid VPC ID.

+

Check whether the VPC ID and name are correct and meet the requirements.

+

400

+

DBS.200049

+

Invalid subnet ID.

+

Invalid subnet ID.

+

Check whether the subnet ID and name are correct and meet the requirements.

+

400

+

DBS.200051

+

Invalid HA mode.

+

Invalid HA mode.

+

Check whether the HA mode meets the requirements.

+

400

+

DBS.200052

+

Invalid database root password.

+

Invalid database root password.

+

Check whether the username and password match and whether the password meets the requirements.

+

400

+

DBS.200053

+

The selected specifications do not exist.

+

The selected specifications do not exist.

+

Check whether the specifications are correct and available in the current AZ.

+

400

+

DBS.200054

+

Invalid specifications.

+

Invalid specifications.

+

Check whether the specifications are correct and available in the current AZ.

+

400

+

DBS.200056

+

The maximum number of nodes has been reached.

+

The maximum number of nodes has been reached.

+

Check whether the number of instance nodes reaches the upper limit.

+

400

+

DBS.200063

+

Invalid cluster mode.

+

Invalid cluster mode.

+

Check whether the cluster mode is valid.

+

400

+

DBS.200086

+

This operation is not allowed by the DB instance status.

+

This operation is not allowed by the DB instance status.

+

Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+

400

+

DBS.200087

+

The number of tags added for the DB instance has reached the quota.

+

The number of tags added for the DB instance has reached the quota.

+

Check whether the number of tags for the DB instance exceeds the upper limit.

+

400

+

DBS.200098

+

The tag already exists.

+

The tag already exists.

+

Check whether the tag exists.

+

400

+

DBS.200302

+

Storage space must be a multiple of 10.

+

Storage space must be a multiple of 10.

+

Check whether the storage space is a multiple of 10.

+

400

+

DBS.200306

+

The new storage space must be greater than or equal to the original storage space.

+

The new storage space must be at least the original storage space.

+

Check whether the storage space exceeds the upper limit.

+

400

+

DBS.200461

+

The parameter value is out of range.

+

The parameter value is out of range.

+

Check whether the port is valid.

+

400

+

DBS.200504

+

Invalid database version.

+

Invalid database version.

+

Check whether the database version is valid.

+

400

+

DBS.200543

+

The job does not exist.

+

The task does not exist.

+

Check whether the task ID is valid.

+

400

+

DBS.200823

+

The database does not exist.

+

The database does not exist.

+

Check whether the input database does not exist.

+

400

+

DBS.200824

+

The database account does not exist.

+

The database account does not exist.

+

Check whether the database account exists.

+

400

+

DBS.201014

+

This operation is not allowed by the DB instance status.

+

This operation is not allowed by the DB instance status.

+

Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+

400

+

DBS.201101

+

Invalid backup cycle.

+

Invalid backup cycle.

+

Check whether the backup cycle meets the requirements.

+

400

+

DBS.201103

+

Invalid backup start time.

+

Invalid backup start time.

+

Check whether the start time meets the requirement.

+

400

+

DBS.201106

+

Invalid retention days.

+

Invalid retention days.

+

Check whether the backup retention period meets the requirements.

+

400

+

DBS.201203

+

The backup file does not exist.

+

The backup file does not exist.

+

Check whether the backup exists and matches the instance.

+

400

+

DBS.201207

+

The DB engine or version is not supported.

+

The DB engine or version is not supported.

+

Check whether the DB engine is supported by TaurusDB.

+

400

+

DBS.201208

+

The operation is not allowed by the backup status.

+

The operation is not allowed by the backup status.

+

Check whether the status of the backup is Completed.

+

400

+

DBS.212002

+

Incorrect parameter group quota.

+

Incorrect parameter template quota.

+

The parameter template quota exceeds the upper limit. Delete unnecessary parameter templates and create a new one.

+

400

+

DBS.212003

+

Operation not allowed.

+

The operation is not allowed.

+

Default parameter templates cannot be reset or deleted.

+

400

+

DBS.212004

+

Parameter group update error.

+

The parameter template fails to be updated.

+

Check whether the parameter values to be changed are valid.

+

400

+

DBS.212005

+

The node does not belong to the group.

+

The node does not belong to the group.

+

Check whether the instance ID or node ID is correct.

+

400

+

DBS.212007

+

The DB engine does not exist.

+

The DB engine does not exist.

+

Check whether the DB engine exists.

+

400

+

DBS.212008

+

The DB engine is not supported.

+

The DB engine is not supported.

+

Check whether the DB engine is supported by TaurusDB.

+

400

+

DBS.212009

+

Task processing failed.

+

The task fails to be processed.

+

Contact customer service.

+

400

+

DBS.212010

+

The parameter group is being applied.

+

The parameter template is being applied.

+

Perform the operation after the application is complete.

+

400

+

DBS.212011

+

Application failed.

+

Failed to apply the parameter template.

+

Contact customer service.

+

400

+

DBS.212012

+

The parameter does not exist.

+

The parameter does not exist.

+

Check whether the parameter to be modified is correct.

+

400

+

DBS.212014

+

The node does not have a default parameter group.

+

The node does not have a default parameter template.

+

Check whether the node ID or parameter template ID is correct.

+

400

+

DBS.212015

+

Partial success.

+

Partial success.

+

Check whether the parameters to be modified are correct.

+

400

+

DBS.212016

+

Parameter update failed.

+

Parameter update failed.

+

Contact customer service.

+

400

+

DBS.212017

+

Invalid parameter.

+

Parameter error.

+

Check whether the parameter name is valid.

+

400

+

DBS.212025

+

Update failed.

+

Update failed.

+

Contact customer service.

+

400

+

DBS.212030

+

Parameter error.

+

Parameter error.

+

The parameter template name already exists.

+

400

+

DBS.212032

+

The parameter template has been applied.

+

The parameter template has been applied.

+

The parameter template has been applied and cannot be deleted.

+

400

+

DBS.212037

+

Parameters are incorrectly set.

+

Parameters are incorrectly configured.

+

Check whether the parameter values are valid or within the valid range.

+

400

+

DBS.270024

+

Proxy instance does not exist.

+

Proxy instance does not exist.

+

Check whether the tenant has the proxy instance, whether the input proxy instance ID is correct, and whether the proxy instance exists.

+

400

+

DBS.270025

+

Invalid weight.

+

Invalid weight.

+

Check whether the weight format and range are correct.

+

400

+

DBS.270026

+

Invalid proxy mode.

+

The database proxy type is invalid.

+

Check whether the database proxy type is correct.

+

400

+

DBS.270027

+

Select a proxy instance.

+

No database proxy instance is specified.

+

Check whether the database proxy instance ID is null.

+

400

+

DBS.280001

+

Parameter error.

+

Parameter error.

+

Check whether the transferred parameters or URLs are correct and meet the requirements.

+

400

+

DBS.280127

+

Invalid backup description.

+

Invalid backup description.

+

Check whether the backup description is correct and meets the requirements.

+

400

+

DBS.280128

+

The database name does not exist.

+

The database name does not exist.

+

Check whether the tenant has the DB instance, whether the DB instance name or ID is correct, and whether the DB instance exists.

+

400

+

DBS.280203

+

This is a weak password. Please enter a strong password.

+

This is a weak password. Enter a strong password.

+

Password is too easy to guess. Change it to a strong password.

+

400

+

DBS.280204

+

Invalid parameter.

+

Invalid parameter.

+

Check whether the parameter values are valid or within the valid range.

+

400

+

DBS.280214

+

The backup does not exist.

+

The backup does not exist.

+

Check whether the backup retention period is correct.

+

400

+

DBS.280216

+

Invalid backup start time.

+

Invalid backup start time.

+

Check whether the backup start time meets the requirements and whether the requirements between the backup start time and end time are correct.

+

400

+

DBS.280235

+

Invalid database type.

+

Invalid database type.

+

Check whether the DB engine is correct.

+

400

+

DBS.280237

+

Datastore not specified.

+

Datastore is not specified.

+

Check whether the DB engine is supported by TaurusDB.

+

400

+

DBS.280238

+

The DB engine or version is not supported.

+

The DB engine or version is not supported.

+

Check whether the DB engine and version match and meet the requirements.

+

400

+

DBS.280239

+

Invalid specifications.

+

Invalid specifications.

+

Check whether the specification code is correct, whether the specifications exist in the current AZ, and whether the specifications are supported.

+

400

+

DBS.280241

+

Invalid storage type.

+

Invalid storage type.

+

Check whether the storage type is correct and meets the requirements.

+

400

+

DBS.280242

+

Storage space is out of range.

+

The storage space is out of range.

+

Check whether the specified storage space is correct.

+

400

+

DBS.280246

+

Invalid database root password.

+

Invalid database root password.

+

Check whether the username and password match and whether the password meets the requirements.

+

400

+

DBS.280250

+

Invalid backup retention days.

+

Invalid backup retention days.

+

Check whether the backup data retention period is valid or within the valid range.

+

400

+

DBS.280251

+

Invalid backup cycle.

+

Invalid backup cycle.

+

Check whether the backup cycle is valid or within the valid range.

+

400

+

DBS.280253

+

Invalid backup start time.

+

Invalid backup start time.

+

Check whether the backup start time meets the requirements and whether the requirements between the backup start time and end time are correct.

+

400

+

DBS.280260

+

Invalid AZ mode.

+

Invalid AZ mode.

+

Check whether the AZ mode is valid.

+

400

+

DBS.280270

+

The parameter does not exist.

+

The parameter does not exist.

+

Check whether the parameters to be modified are correct.

+

400

+

DBS.280271

+

The parameter value is out of range.

+

The parameter value is out of range.

+

Check whether the parameter value is within the valid range.

+

400

+

DBS.280272

+

The tag key must be unique.

+

The tag key must be unique.

+

Check whether the new tag exists.

+

400

+

DBS.280277

+

Invalid object name.

+

Invalid backup name.

+

Check whether the backup name is correct and meets the requirements.

+

400

+

DBS.280285

+

Invalid AZ.

+

Invalid AZ.

+

Check whether the AZ name is correct and whether the AZ is available.

+

400

+

DBS.280288

+

Invalid FlavorRef.

+

Invalid flavor.

+

Check whether the flavor ID is null or a null string.

+

400

+

DBS.280311

+

Invalid storage space size.

+

Invalid storage space.

+

Check whether the specified storage space is correct and meets the requirements.

+

400

+

DBS.280325

+

Invalid storage information.

+

Invalid storage information.

+

Check whether the storage space or type is valid.

+

400

+

DBS.280342

+

Invalid cluster mode.

+

Invalid cluster mode.

+

Check whether the instance mode is correct and whether the instance mode matches the instance ID.

+

400

+

DBS.280364

+

Invalid database port.

+

Invalid database port.

+

Check whether the database port is available.

+

400

+

DBS.280402

+

Invalid HA mode.

+

Invalid HA mode.

+

Check whether the HA mode meets the requirements.

+

400

+

DBS.280404

+

Invalid DB instance ID or node ID format.

+

Invalid DB instance ID.

+

Check whether the instance ID is valid.

+

400

+

DBS.280434

+

Invalid specification code.

+

Invalid specification code.

+

Check whether the specification code complies with the rules, whether the specification exists, and whether the specification is available.

+

400

+

DBS.280439

+

Invalid records. Enter a positive integer less than 100.

+

Invalid value. Enter a positive integer of no more than 100.

+

Check whether the number of queried records is within the valid range.

+

400

+

DBS.280448

+

The storage type is sold out.

+

The storage type is sold out.

+

Check whether the current storage type is available.

+

400

+

DBS.280449

+

Operation not allowed on frozen objects.

+

Operation not allowed on frozen objects.

+

Check whether the instance is frozen and whether the current operation can be performed when the instance is frozen.

+

400

+

DBS.280450

+

The DB instance specifications are sold out.

+

The DB instance specifications are sold out.

+

Change the AZ or contact customer service.

+

400

+

DBS.290000

+

Parameter error.

+

Parameter error.

+

Check whether the transferred parameters or URLs are correct and meet the requirements.

+

400

+

DBS.290001

+

Invalid parameter letter case.

+

Invalid parameter letter case.

+

Check whether the parameter letter case is correct and meets the requirements.

+

403

+

DBS.200010

+

The DB instance ID or user ID may be null, or the operation is not authorized.

+

The DB instance ID or user ID may be null, or the operation is not authorized.

+

Check whether the input parameters are correct, whether the instance exists, and whether the tenant has unauthorized operations.

+

403

+

DBS.200044

+

Resource not found or permission denied.

+

Resource not found or permission denied.

+

Check whether the parameters are correctly configured, whether the access resources exist, and whether the tenant has the access permission.

+

403

+

DBS.200604

+

The DB instance ID or user ID may be null, or the operation is not authorized.

+

The DB instance ID or user ID may be null, or the operation is not authorized.

+

Check whether the input parameters are correct, whether the instance exists, and whether the tenant has unauthorized operations.

+

403

+

DBS.200810

+

You are not allowed to create databases on read replicas.

+

You are not allowed to create databases on read replicas.

+

Create databases on the primary node.

+

403

+

DBS.200819

+

You are not allowed to delete database users on read replicas.

+

You are not allowed to delete database users on read replicas.

+

Database users cannot be deleted from read replicas.

+

403

+

DBS.201003

+

Resource not found or permission denied.

+

Resource not found or permission denied.

+

Check whether the parameters are correctly configured, whether the access resources exist, and whether the tenant has the access permission.

+

403

+

DBS.280015

+

Resource not found or permission denied.

+

Resource not found or permission denied.

+

Check whether the parameters are correctly configured, whether the access resources exist, and whether the tenant has the access permission.

+

403

+

DBS.280056

+

Invalid token.

+

Invalid token.

+

Check whether the instance belongs to the tenant and whether the token has been obtained again.

+

404

+

DBS.200002

+

The DB instance does not exist.

+

The DB instance does not exist.

+

Check whether the instance and its ID are correct and whether the instance exists.

+

404

+

DBS.200008

+

The ECS information of the DB instance cannot be found.

+

The ECS information of the DB instance cannot be found.

+

Check whether the parameters are correctly configured and whether the instance status is normal.

+

404

+

DBS.200013

+

The original DB instance does not exist.

+

The original DB instance does not exist.

+

Check whether the instance and its ID are correct and whether the instance exists.

+

404

+

DBS.200045

+

The DB instance does not exist.

+

The DB instance does not exist.

+

Check whether the instance and its ID are correct and whether the instance exists.

+

404

+

DBS.200050

+

The security group does not exist or does not belong to the VPC.

+

The security group does not exist or does not belong to the VPC.

+

Check whether the security group ID is valid, whether the security group exists, and whether the private IP address for read of the node belongs to the security group.

+

404

+

DBS.200408

+

The DB instance does not exist.

+

The instance does not exist or has been deleted.

+

Check whether the instance and its ID are correct and whether the instance exists.

+

404

+

DBS.200470

+

The region or AZ does not exist.

+

The region or AZ does not exist.

+

Check whether the AZ is correct.

+

404

+

DBS.200501

+

The subnet does not exist or does not belong to the VPC.

+

The subnet does not exist or does not belong to the VPC.

+

Check whether the subnet ID and name exist and whether the subnet belongs to the VPC.

+

404

+

DBS.200503

+

The VPC does not exist or does not belong to the user.

+

The VPC does not exist or does not belong to the user.

+

Check whether the tenant has the VPC.

+

404

+

DBS.200602

+

The DB instance does not exist.

+

The DB instance does not exist.

+

Check whether the instance and its ID are correct and whether the instance exists.

+

404

+

DBS.201010

+

The backup information does not exist.

+

The backup information does not exist.

+

Check whether the backup exists and matches the instance.

+

404

+

DBS.201028

+

The DB instance does not exist.

+

The instance does not exist or has been deleted.

+

Check whether the instance and its ID are correct and whether the instance exists.

+

404

+

DBS.212001

+

The parameter group does not exist.

+

The parameter template does not exist.

+

Check whether the parameter template exists.

+

404

+

DBS.290002

+

The selected specifications do not exist.

+

The selected specifications do not exist.

+

Check whether the specifications are correct and available in the current AZ.

+

404

+

DBS.290005

+

The DB instance does not exist.

+

The DB instance does not exist.

+

Check whether the instance and its ID are correct and whether the instance exists.

+

404

+

DBS.290011

+

The DB instance does not exist.

+

The DB instance does not exist.

+

Check whether the instance and its ID are correct and whether the instance exists.

+

404

+

DBS.290013

+

Resource not found.

+

Resource not found.

+

Check whether the transferred parameters are correct and whether the DB instance exists.

+

409

+

DBS.200011

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+

409

+

DBS.200019

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+

409

+

DBS.200022

+

The DB instance name already exists.

+

The DB instance name already exists.

+

Check whether the instance name exists.

+

409

+

DBS.200047

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+

409

+

DBS.200316

+

This operation cannot be performed because the DB instance status is Storage full.

+

This operation cannot be performed because the DB instance status is Storage full.

+

Adjust the storage space.

+

409

+

DBS.200826

+

The database name already exists.

+

The database name already exists.

+

Check whether the database name is valid.

+

409

+

DBS.200827

+

The database user already exists.

+

The database user already exists.

+

Check whether the database user is valid.

+

409

+

DBS.200828

+

You are not allowed to create a database built-in account.

+

You are not allowed to create a database built-in account.

+

Check whether the database user is valid.

+

409

+

DBS.201202

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+

409

+

DBS.201205

+

Backup is in progress, please wait.

+

Backup is in progress.

+

Try again after the backup is complete.

+

409

+

DBS.212006

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+

409

+

DBS.280406

+

Operation not allowed by the DB instance type or status.

+

Operation not allowed by the DB instance type or status.

+

Check whether the instance type and instance status meet requirements.

+

413

+

DBS.200046

+

The number of DB instances has reached the quota.

+

The number of DB instances has reached the quota.

+

Contact the database administrator to adjust the quota.

+

413

+

DBS.290003

+

The number of DB instances has reached the quota.

+

The number of DB instances has reached the quota.

+

Contact the database administrator to adjust the quota.

+

422

+

DBS.212019

+

The parameter cannot be processed.

+

The parameter cannot be processed.

+

Check whether the parameter is valid.

+

500

+

DBS.108000

+

Server failure.

+

Server failure.

+

Contact customer service.

+

500

+

DBS.108002

+

Server failure.

+

Server failure.

+

Contact customer service.

+

500

+

DBS.108005

+

Server failure.

+

Server failure.

+

Contact customer service.

+

500

+

DBS.200005

+

Server failure.

+

Server failure.

+

Contact customer service.

+

500

+

DBS.200208

+

Server failure.

+

Server failure.

+

Contact customer service.

+

500

+

DBS.200811

+

Failed to create the database.

+

Failed to create the database.

+

Check whether resources are insufficient and then contact customer service.

+

500

+

DBS.200821

+

Failed to modify database user permissions.

+

Failed to modify database user permissions.

+

This operation is not allowed in the current instance status. Try again later.

+

500

+

DBS.213002

+

Failed to process the request.

+

Failed to process the request.

+

Internal service error. Contact customer service.

+

500

+

DBS.213004

+

Failed to process the request.

+

Failed to process the request.

+

Internal service error. Contact customer service.

+

500

+

DBS.290006

+

Failed to process the request.

+

Failed to process the request.

+

Internal service error. Contact customer service.

+

500

+

DBS.290015

+

Failed to process the request.

+

Failed to process the request.

+

Internal service error. Contact customer service.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_10_0004.html b/docs/taurusdb/api-ref/gaussdb_10_0004.html new file mode 100644 index 000000000..50568eb05 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_10_0004.html @@ -0,0 +1,43 @@ + + +

Obtaining a Project ID

+

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.

+

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

+
{
+    "projects": [
+        {
+            "domain_id": "65382450e8f64ac0870cd180d14e684b",
+            "is_domain": false,
+            "parent_id": "65382450e8f64ac0870cd180d14e684b",
+            "name": "project_name",
+            "description": "",
+            "links": {
+                "next": null,
+                "previous": null,
+                "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
+            },
+            "id": "a4a5d4098fb4474fa22cd05f897d6b99",
+            "enabled": true
+        }
+    ],
+    "links": {
+        "next": null,
+        "previous": null,
+        "self": "https://www.example.com/v3/projects"
+    }
+}
+
+

Obtain a Project ID from the Console

  1. Register yourself on the management console and log in to it.
  2. Move your pointer over the username and select My Credentials in the displayed drop-down list.

    On the My Credentials page, view project IDs in the project list.

    +
    Figure 1 Viewing project IDs
    +

+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_10_0006.html b/docs/taurusdb/api-ref/gaussdb_10_0006.html new file mode 100644 index 000000000..2b4feaf69 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_10_0006.html @@ -0,0 +1,758 @@ + + +

TaurusDB Metrics

+

Description

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 alarm information generated for TaurusDB.

+
+

Namespace

SYS.GAUSSDB

+
+

Metrics

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Metrics

Metric

+

Name

+

Description

+

Value Range

+

Remarks

+

gaussdb_mysql001_cpu_util

+

CPU Usage

+

CPU usage of the monitored object

+

0–100%

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql002_mem_util

+

Memory Usage

+

Memory usage of the monitored object

+

0–100%

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql004_bytes_in

+

Network Input Throughput

+

Incoming traffic in bytes per second

+

≥0 bytes/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql005_bytes_out

+

Network Output Throughput

+

Outgoing traffic in bytes per second

+

≥0 bytes/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql006_conn_count

+

Total Connections

+

Total number of connections that connect to the MySQL server

+

≥0 counts

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql007_conn_active_count

+

Current Active Connections

+

Number of active connections

+

≥0 counts

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql008_qps

+

QPS

+

Query times of SQL statements (including DDL, DML, SHOW, SET statements and storage procedures) per second

+

≥0 times/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql009_tps

+

TPS

+

Execution times of submitted and rollback transactions per second

+

≥0 times/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql010_innodb_buf_usage

+

Buffer Pool Usage

+

Ratio of used pages to total pages in the InnoDB buffer

+

0-1

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql011_innodb_buf_hit

+

Buffer Pool Hit Ratio

+

Ratio of read hits to read requests in the InnoDB buffer

+

0-1

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql012_innodb_buf_dirty

+

Buffer Pool Dirty Block Ratio

+

Ratio of dirty data to all data in the InnoDB buffer

+

0-1

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql013_innodb_reads

+

InnoDB Read Throughput

+

Number of read bytes per second in the InnoDB buffer

+

≥0 bytes/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql014_innodb_writes

+

InnoDB Write Throughput

+

Number of write bytes per second in the InnoDB buffer

+

≥0 bytes/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql017_innodb_log_write_req_count

+

InnoDB Log Write Requests per Second

+

Number of InnoDB log write requests per second

+

≥0 times/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql020_temp_tbl_count

+

Temporary Tables

+

Number of temporary tables automatically created on hard disks when MySQL statements are executed

+

≥ 0 counts

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql028_comdml_del_count

+

DELETE Statements per Second

+

Number of DELETE statements executed per second

+

≥ 0 counts/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql029_comdml_ins_count

+

INSERT Statements per Second

+

Number of INSERT statements executed per second

+

≥ 0 counts/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql030_comdml_ins_sel_count

+

INSERT_SELECT Statements per Second

+

Number of INSERT_SELECT statements executed per second

+

≥ 0 counts/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql031_comdml_rep_count

+

REPLACE Statements per Second

+

Number of REPLACE statements executed per second

+

≥ 0 counts/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql032_comdml_rep_sel_count

+

REPLACE_SELECTION Statements per Second

+

Number of REPLACE_SELECTION statements executed per second

+

≥ 0 counts/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql033_comdml_sel_count

+

SELECT Statements per Second

+

Number of SELECT statements executed per second

+

≥0 Counts/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql034_comdml_upd_count

+

UPDATE Statements per Second

+

Number of UPDATE statements executed per second

+

≥ 0 counts/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql035_innodb_del_row_count

+

Row Delete Frequency

+

Number of rows deleted from the InnoDB table per second

+

≥ 0 counts/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql036_innodb_ins_row_count

+

Row Insert Frequency

+

Number of rows inserted into the InnoDB table per second

+

≥ 0 counts/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql037_innodb_read_row_count

+

Row Read Frequency

+

Number of rows read from the InnoDB table per second

+

≥ 0 counts/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql038_innodb_upd_row_count

+

Row Update Frequency

+

Number of rows updated into the InnoDB table per second

+

≥ 0 counts/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql048_disk_used_size

+

Used Storage Space

+

Used storage space of the monitored object

+

0 GB-128 TB

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql072_conn_usage

+

Connection Usage

+

Percent of used MySQL connections to the total number of connections

+

0–100%

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql074_slow_queries

+

Slow Query Logs

+

Number of MySQL slow query logs generated per minute

+

≥ 0 counts/min

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql077_replication_delay

+

Replication Delay

+

Data replication latency between the primary node and read replicas

+

≥0 ms

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql104_dfv_write_delay

+

Storage Write Latency

+

Average latency of writing data to the storage layer in a specified period

+

≥0 ms

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql105_dfv_read_delay

+

Storage Read Latency

+

Average latency of reading data from the storage layer in a specified period

+

≥0 ms

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql106_innodb_row_lock_current_waits

+

InnoDB Row Locks

+

Number of row locks being waited by operations on the InnoDB table

+

≥ 0 counts

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql107_comdml_ins_and_ins_sel_count

+

INSERT and INSERT_SELECT Statements per Second

+

Number of INSERT and INSERT_SELECT statements executed per second

+

≥ 0 counts/s

+

Monitored object: ECS

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql108_com_commit_count

+

COMMIT Statements per Second

+

Number of COMMIT statements executed per second

+

≥0 Counts/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql109_com_rollback_count

+

ROLLBACK Statements per Second

+

Number of ROLLBACK statements executed per second

+

≥ 0 counts/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql110_innodb_bufpool_reads

+

InnoDB Storage Layer Read Requests per Second

+

Number of times that InnoDB reads data from the storage layer per second

+

≥ 0 counts/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql111_innodb_bufpool_read_requests

+

InnoDB Read Requests per Second

+

Number of InnoDB read requests per second

+

≥ 0 counts/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql114_innodb_bufpool_read_ahead

+

InnoDB Bufpool Read Ahead

+

Number of pages read into the InnoDB buffer pool by the read-ahead background thread

+

≥0 counts

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql115_innodb_bufpool_read_ahead_evicted

+

InnoDB Bufpool Read Ahead Evicted

+

Number of pages read into the InnoDB buffer pool by the read-ahead background thread that were subsequently evicted without having been accessed by queries

+

≥0 counts

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql116_innodb_bufpool_read_ahead_rnd

+

InnoDB Bufpool Read Ahead Rnd

+

Number of random read-aheads initiated by InnoDB

+

≥0 counts

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql117_innodb_pages_read

+

InnoDB Pages Read

+

Number of pages read from the InnoDB buffer pool by operations on InnoDB tables

+

≥0 counts

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql118_innodb_pages_written

+

InnoDB Pages Written

+

Number of pages written by operations on InnoDB tables

+

≥0 counts

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql019_innodb_log_writess

+

InnoDB Log Writes

+

Number of physical writes to the InnoDB redo log file

+

≥0 counts

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql342_iostat_iops_write

+

I/O Write IOPS

+

Number of disk writes per second

+

≥0 counts/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql344_iostat_iops_read

+

I/O Read IOPS

+

Number of disk reads per second

+

≥0 counts/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql346_iostat_throughput_write

+

I/O Write Bandwidth

+

Disk write bandwidth per second

+

≥0 bytes/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql348_iostat_throughput_read

+

I/O Read Bandwidth

+

Disk read bandwidth per second

+

≥0 bytes/s

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

gaussdb_mysql119_disk_used_ratio

+

Disk Usage

+

Disk usage of the monitored object

+

0–100%

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

1 minute

+

gaussdb_mysql120_innodb_buffer_pool_bytes_data

+

Total Bytes of Buffer Pool

+

Total number of bytes in the InnoDB buffer pool containing data

+

≥0 bytes

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

1 minute

+

gaussdb_mysql121_innodb_row_lock_time

+

Row Lock Time

+

Total time spent in acquiring row locks for InnoDB tables

+

≥0 ms

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

1 minute

+

gaussdb_mysql122_innodb_row_lock_waits

+

Row Lock Waits

+

Number of times operations on InnoDB tables had to wait for a row lock

+

≥ 0 counts/min

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

1 minute

+

gaussdb_mysql123_sort_range

+

Sorts Using Ranges

+

Number of sorts that were done using ranges

+

≥ 0 counts/min

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

1 minute

+

gaussdb_mysql124_sort_rows

+

Sorted Rows

+

Number of sorted rows

+

≥ 0 counts/min

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

1 minute

+

gaussdb_mysql125_sort_scan

+

Sorts by Scanning Tables

+

Number of sorts that were done by scanning tables.

+

≥0 Counts/min

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

1 minute

+

gaussdb_mysql126_table_open_cache_hits

+

Hits for Open Tables Cache Lookups

+

Number of hits for open tables cache lookups

+

≥ 0 counts/min

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

1 minute

+

gaussdb_mysql127_table_open_cache_misses

+

Misses for Open Tables Cache Lookups

+

Number of misses for open tables cache lookups

+

≥ 0 counts/min

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

1 minute

+

gaussdb_mysql128_long_trx_count

+

Long-Running Transactions

+

Number of long transactions that are not closed

+

≥0 counts

+

Monitored object: database

+

Monitored instance type: TaurusDB instance

+

150s

+
+
+
+

Dimension

+
+ + + + + + + + + + +

Key

+

Value

+

gaussdb_mysql_instance_id

+

TaurusDB instance ID.

+

gaussdb_mysql_node_id

+

Node ID of a TaurusDB instance.

+
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0000.html b/docs/taurusdb/api-ref/gaussdb_11_0000.html new file mode 100644 index 000000000..d503727bc --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0000.html @@ -0,0 +1,23 @@ + + +

APIs (Unavailable Soon)

+
+
+ +
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0001.html b/docs/taurusdb/api-ref/gaussdb_11_0001.html new file mode 100644 index 000000000..a93261e8f --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0001.html @@ -0,0 +1,202 @@ + + +

Querying Version Information About a DB Engine

+

Function

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

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameter

Parameter

+

Type

+

Description

+

datastores

+

Array of MysqlEngineVersionInfo objects

+

DB versions.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 MysqlEngineVersionInfo

Parameter

+

Type

+

Description

+

id

+

String

+

DB version ID. Its value is unique.

+

name

+

String

+

DB version number. Only the major version number with two digits is returned.

+
+
+

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

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

Example Response

Status code: 200

+

Success.

+
{
+  "datastores" : [ {
+    "id" : "87620726-6802-46c0-9028-a8785e1f1921",
+    "name" : "8.0"
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: APIs (Unavailable Soon)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0002.html b/docs/taurusdb/api-ref/gaussdb_11_0002.html new file mode 100644 index 000000000..83c80714d --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0002.html @@ -0,0 +1,290 @@ + + +

Querying Database Specifications

+

Function

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

+ +
+

URI

+ +
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 3 Response body parameter

Parameter

+

Type

+

Description

+

flavors

+

Array of MysqlFlavorsInfo objects

+

Instance specifications.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MysqlFlavorsInfo

Parameter

+

Type

+

Description

+

vcpus

+

String

+

Number of vCPUs. For example, the value 1 indicates 1 vCPU.

+

ram

+

String

+

Memory size in GB.

+

type

+

String

+

Specification type. The value is x86.

+

id

+

String

+

Specification ID. The value must be unique.

+

spec_code

+

String

+

Resource specification code. Its value is same as the value of flavor_ref.

+

Example: gaussdb.mysql.xlarge.x86.8.

+

version_name

+

String

+

DB version number.

+

instance_mode

+

String

+

DB instance type. Currently, only the cluster type is supported.

+

az_status

+

Map<String,String>

+

Specification status in an AZ.

+
  • normal: The specifications are available.
  • unsupported: The specifications are not supported.
  • sellout: The specifications are sold out.
+
+
+

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

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

Example Response

Status code: 202

+

Success.

+
{
+  "flavors" : [ {
+    "vcpus" : "4",
+    "ram" : "32",
+    "type" : "x86",
+    "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
+    "spec_code" : "gaussdb.mysql.xlarge.x86.8",
+    "instance_mode" : "Cluster",
+    "version_name" : "8.0",
+    "az_status" : {
+      "eu-de-01" : "normal"
+    }
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: APIs (Unavailable Soon)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0003.html b/docs/taurusdb/api-ref/gaussdb_11_0003.html new file mode 100644 index 000000000..aee9a70e0 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0003.html @@ -0,0 +1,31 @@ + + +

Instance Management

+
+
+ + +
+
Parent topic: APIs (Unavailable Soon)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0004.html b/docs/taurusdb/api-ref/gaussdb_11_0004.html new file mode 100644 index 000000000..1d49b07b5 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0004.html @@ -0,0 +1,816 @@ + + +

Creating a DB Instance

+

Function

This API is used to create a DB instance. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

charge_info

+

No

+

MysqlChargeInfo object

+

Billing mode, which is pay-per-use (default setting).

+

region

+

Yes

+

String

+

Region ID.

+

The value cannot be empty. To obtain this value, see Regions and Endpoints.

+

name

+

Yes

+

String

+

DB instance name.

+

Instances of the same type can have same names under the same tenant.

+

The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_).

+

datastore

+

Yes

+

MysqlDatastore object

+

Database information.

+

mode

+

Yes

+

String

+

DB instance type, which is case-insensitive. Currently, only the cluster type is supported.

+

flavor_ref

+

Yes

+

String

+

Specification code. For details, see Querying Database Specifications.

+

vpc_id

+

Yes

+

String

+

VPC ID. To obtain this value, use either of the following methods:

+
  • Method 1: Log in to the VPC console and view the VPC ID on the VPC details page.
  • Method 2: See "Querying VPCs" in the Virtual Private Cloud API Reference.
+

subnet_id

+

Yes

+

String

+

Network ID. To obtain this value, use either of the following methods:

+
  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
  • Method 2: See "Querying Subnets" in the Virtual Private Cloud API Reference.
+

security_group_id

+

No

+

String

+

Security group ID.

+

If the network ACL is enabled for the subnet used by the created instance, this parameter is optional. If the network ACL is not enabled, this parameter is mandatory.

+
  • Method 1: Log in to VPC console. Choose Access Control > Security Groups in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.
  • Method 2: See "Querying Security Groups" in the Virtual Private Cloud API Reference.
+

configuration_id

+

No

+

String

+

Parameter template ID.

+

password

+

Yes

+

String

+

Database password.

+

Values:

+

The password consists of 8 to 32 characters and contains at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#%^*-_=+?).

+

You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid.

+

backup_strategy

+

No

+

MysqlBackupStrategy object

+

Automated backup policy.

+

time_zone

+

No

+

String

+

UTC time zone.

+
  • If this parameter is not specified, UTC is used by default.
  • If this parameter is specified, the value ranges from UTC-12:00 to UTC+12:00 at the full hour. For example, the parameter can be UTC+08:00 rather than UTC+08:30.
+

availability_zone_mode

+

Yes

+

String

+

AZ type. The value can be Single or multi.

+

master_availability_zone

+

If availability_zone_mode is set to multi, this parameter is mandatory.

+

If availability_zone_mode is set to single, this parameter cannot be specified.

+

String

+

Primary AZ.

+

slave_count

+

Yes

+

Integer

+

Number of created read replicas. Value: 1 to 9. An instance contains up to 15 read replicas.

+

tags

+

No

+

Array of MysqlTags objects

+

Tag list. Instances are created based on tag keys and values.

+
  • {key} indicates the tag key. It must be unique and cannot be empty.
  • {value} indicates the tag value, which can be empty.
+

To create instances with multiple tag keys and values, separate key-value pairs with commas (,). Up to 10 key-value pairs can be added.

+

enterprise_project_id

+

No

+

String

+

Enterprise project ID. This parameter is mandatory when the enterprise project is enabled.

+

dedicated_resource_id

+

No

+

String

+

Dedicated resource pool ID. This parameter is displayed only when the dedicated resource pool is enabled.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 MysqlChargeInfo

Parameter

+

Mandatory

+

Type

+

Description

+

charge_mode

+

Yes

+

String

+

Billing mode.

+

Value: postPaid

+

period_type

+

No

+

String

+

Subscription period.

+

Values:

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

    This parameter is valid and mandatory if charge_mode is set to prePaid.

    +
    +
+

period_num

+

No

+

Integer

+

Subscription duration. This parameter is valid and mandatory if charge_mode is set to prePaid.

+

Values:

+
  • When period_type is set to month, the parameter value ranges from 1 to 9.
  • When period_type is set to year, the parameter value ranges from 1 to 3.
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 MysqlDatastore

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

DB engine. Currently, only gaussdb-mysql is supported.

+

version

+

Yes

+

String

+

DB version.

+

For details about supported DB versions, see Querying Version Information About a DB Engine.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 MysqlBackupStrategy

Parameter

+

Mandatory

+

Type

+

Description

+

start_time

+

Yes

+

String

+

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.

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

Example value:

+

21:00-22:00

+

keep_days

+

No

+

String

+

Automated backup retention days. Value: 1-732.

+
+
+ +
+ + + + + + + + + + + +
Table 7 MysqlVolume

Parameter

+

Mandatory

+

Type

+

Description

+

size

+

Yes

+

Integer

+

Disk size. The default value is 40 GB.

+

Value: 40 to 128000. The value must be a multiple of 10.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 8 MysqlTags

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key. It contains a maximum of 36 Unicode characters. The value cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

+

value

+

Yes

+

String

+

Tag value. It contains a maximum of 43 Unicode characters. It can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

instance

+

MysqlInstanceResponse object

+

Instance information.

+

job_id

+

String

+

DB instance creation task ID.

+

This parameter is returned only when pay-per-use DB instances are created.

+

order_id

+

String

+

Order ID. This parameter is returned only when yearly/monthly instances are created.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 MysqlInstanceResponse

Parameter

+

Type

+

Description

+

id

+

String

+

Instance ID.

+

name

+

String

+

DB instance name. Instances of the same type can have same names under the same tenant.

+

The name consists of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_).

+

status

+

String

+

Instance status. Value: creating.

+

datastore

+

MysqlDatastore object

+

Database information.

+

mode

+

String

+

DB instance type. Currently, only the cluster type is supported.

+

configuration_id

+

String

+

Parameter template ID.

+

port

+

String

+

Database port, which is the same as the request parameter.

+

backup_strategy

+

MysqlBackupStrategy object

+

Automated backup policy.

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

region

+

String

+

Region ID, which is the same as the request parameter.

+

availability_zone_mode

+

String

+

AZ mode, which is the same as the request parameter.

+

master_availability_zone

+

String

+

Primary AZ ID.

+

vpc_id

+

String

+

VPC ID, which is the same as the request parameter.

+

security_group_id

+

String

+

Security group ID, which is the same as the request parameter.

+

subnet_id

+

String

+

Subnet ID, which is the same as the request parameter.

+

flavor_ref

+

String

+

Specification code, which is the same as the request parameter.

+

charge_info

+

MysqlChargeInfo object

+

Billing mode, which is yearly/monthly or pay-per-use (default setting).

+
+
+ +
+ + + + + + + + + + + + + +
Table 11 MysqlDatastore

Parameter

+

Type

+

Description

+

type

+

String

+

DB engine.

+

version

+

String

+

DB version.

+
+
+ +
+ + + + + + + + + + + + + +
Table 12 MysqlBackupStrategy

Parameter

+

Type

+

Description

+

start_time

+

String

+

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

+

keep_days

+

String

+

Backup retention days.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 13 MysqlChargeInfo

Parameter

+

Type

+

Description

+

charge_mode

+

String

+

Billing mode.

+

period_type

+

String

+

Subscription period.

+

Values:

+
  • 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.

+

period_num

+

Integer

+

Subscription duration, which is calculated by month.

+

This parameter is valid when charge_mode is set to prePaid (this parameter is valid only for yearly/monthly instances).

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 14 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 15 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Creating a DB instance

+
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances
+
+{
+  "name" : "taurusdb-instance1",
+  "region" : "eu-de",
+  "charge_info" : {
+    "charge_mode" : "postPaid"
+  },
+  "datastore" : {
+    "type" : "gaussdb-mysql",
+    "version" : "8.0"
+  },
+  "mode" : "Cluster",
+  "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
+  "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
+  "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
+  "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
+  "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07",
+  "password" : "xxxxx",
+  "backup_strategy" : {
+    "start_time" : "08:00-09:00"
+  },
+  "availability_zone_mode" : "single",
+  "slave_count" : 1,
+  "enterprise_project_id" : 0
+}
+
+

Example Response

Status code: 201

+

Success.

+
{
+  "instance" : {
+    "id" : "5eebbb4c0f9f4a99b42ed1b6334569aain07",
+    "name" : "taurusdb-instance1",
+    "region" : "eu-de",
+    "charge_info" : {
+      "charge_mode" : "postPaid"
+    },
+    "datastore" : {
+      "type" : "gaussdb-mysql",
+      "version" : "8.0"
+    },
+    "mode" : "Cluster",
+    "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
+    "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
+    "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
+    "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
+    "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07",
+    "backup_strategy" : {
+      "start_time" : "08:00-09:00",
+      "keep_days" : 7
+    },
+    "availability_zone_mode" : "single",
+    "slave_count" : 1
+  },
+  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0005.html b/docs/taurusdb/api-ref/gaussdb_11_0005.html new file mode 100644 index 000000000..8540b79c1 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0005.html @@ -0,0 +1,633 @@ + + +

Querying DB Instances

+

Function

This API is used to query instances according to search criteria. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

instances

+

Array of MysqlInstanceListInfo objects

+

Instance list information.

+

total_count

+

Integer

+

Total number of records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MysqlInstanceListInfo

Parameter

+

Type

+

Description

+

id

+

String

+

DB instance ID.

+

name

+

String

+

DB instance name.

+

status

+

String

+

DB instance status.

+

private_ips

+

Array of strings

+

Private IP address for write. It is a blank string until an ECS is created.

+

public_ips

+

Array of strings

+

Public IP addresses.

+

port

+

String

+

Database port.

+

type

+

String

+

DB instance type. The value is Cluster.

+

region

+

String

+

Region where the DB instance is deployed.

+

datastore

+

MysqlDatastore object

+

Database information.

+

created

+

String

+

Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

The value is empty unless the instance creation is complete.

+

updated

+

String

+

Update time. The format is the same as that of the created field.

+

The value is empty unless the instance creation is complete.

+

db_user_name

+

String

+

Default username.

+

vpc_id

+

String

+

VPC ID.

+

subnet_id

+

String

+

Network ID of the subnet.

+

security_group_id

+

String

+

Security group ID.

+

flavor_ref

+

String

+

Specification code.

+

flavor_info

+

MysqlFlavorInfo object

+

Specification description.

+

volume

+

MysqlVolumeInfo object

+

Storage disk information.

+

backup_strategy

+

MysqlBackupStrategy object

+

Backup policy.

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

time_zone

+

String

+

Time zone.

+

charge_info

+

MysqlChargeInfo object

+

Billing mode, which is yearly/monthly or pay-per-use (default setting).

+

dedicated_resource_id

+

String

+

Dedicated resource pool ID. This parameter is returned only when the instance belongs to a dedicated resource pool.

+

tags

+

Array of InstanceTagItem objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 MysqlDatastore

Parameter

+

Type

+

Description

+

type

+

String

+

DB engine. Currently, only gaussdb-mysql is supported.

+

version

+

String

+

DB version.

+

To obtain details about supported DB engine versions, call the API for querying the DB engine versions.

+

kernel_version

+

String

+

Database kernel version.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 MysqlFlavorInfo

Parameter

+

Type

+

Description

+

vcpus

+

String

+

Number of vCPUs.

+

ram

+

String

+

Memory size in GB.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 MysqlVolumeInfo

Parameter

+

Type

+

Description

+

type

+

String

+

Disk type.

+

size

+

String

+

Used disk size in GB.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 MysqlBackupStrategy

Parameter

+

Type

+

Description

+

start_time

+

String

+

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

+

keep_days

+

String

+

Backup retention days.

+
+
+ +
+ + + + + + + + + +
Table 9 MysqlChargeInfo

Parameter

+

Type

+

Description

+

charge_mode

+

String

+

Billing mode.

+

Value: postPaid

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 InstanceTagItem

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+

value

+

String

+

Tag value.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Querying DB Instances

+
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
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "total_count" : 1,
+  "instances" : [ {
+    "id" : "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
+    "name" : "taurusdb-instance01",
+    "status" : "ACTIVE",
+    "port" : 3306,
+    "type" : "Cluster",
+    "private_ips" : [ "192.168.0.142" ],
+    "db_user_name" : "root",
+    "region" : "eu-de",
+    "datastore" : {
+      "type" : "gaussdb-mysql",
+      "version" : "8.0"
+    },
+    "created" : "2018-08-20T02:33:49_0800",
+    "updated" : "2018-08-20T02:33:49_0800",
+    "volume" : {
+      "type" : "POOL",
+      "used_size" : 100
+    },
+    "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
+    "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
+    "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
+    "flavor_ref" : "gaussdb.mysql.c3.small.4",
+    "flavor_info" : {
+      "vcpus" : 8,
+      "ram" : 16
+    },
+    "backup_strategy" : {
+      "start_time" : "19:00-20:00",
+      "keep_days" : 7
+    },
+    "charge_info" : {
+      "charge_mode" : "postPaid"
+    },
+    "enterprise_project_id" : 0,
+    "time_zone" : "UTC",
+    "tags" : [ ]
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0006.html b/docs/taurusdb/api-ref/gaussdb_11_0006.html new file mode 100644 index 000000000..b4452852f --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0006.html @@ -0,0 +1,720 @@ + + +

Querying Details of a DB Instance

+

Function

This API is used to query the details of a specified DB instance. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + +
Table 3 Response body parameter

Parameter

+

Type

+

Description

+

instance

+

MysqlInstanceInfoDetail object

+

Instance information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MysqlInstanceInfoDetail

Parameter

+

Type

+

Description

+

id

+

String

+

DB instance ID.

+

name

+

String

+

DB instance name.

+

project_id

+

String

+

Project ID of a tenant in a region.

+

status

+

String

+

DB instance status. Values:

+

If the value is BUILD, the DB instance is being created.

+

If the value is ACTIVE, the DB instance is normal.

+

If the value is FAILED, the DB instance is abnormal.

+

If the value is FROZEN, the DB instance is frozen.

+

If the value is MODIFYING, the DB instance is being scaled up.

+

If the value is REBOOTING, the DB instance is being rebooted.

+

If the value is RESTORING, the DB instance is being restored.

+

If the value is MODIFYING INSTANCE TYPE, the DB instance is changing from primary to standby.

+

If the value is SWITCHOVER, the primary/standby switchover is being performed.

+

If the value is MIGRATING, the DB instance is being migrated.

+

If the value is BACKING UP, the DB instance is being backed up.

+

If the value is MODIFYING DATABASE PORT, the database port is being changed.

+

If the value is STORAGE FULL, the instance storage space is full.

+

port

+

String

+

Database port.

+

type

+

String

+

Instance type. The value is Cluster.

+

node_count

+

Integer

+

Number of nodes.

+

datastore

+

MysqlDatastore object

+

Database information.

+

backup_used_space

+

Double

+

Used backup space in GB.

+

created

+

String

+

Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. The value is empty unless the instance creation is complete.

+

updated

+

String

+

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

+

private_write_ips

+

Array of strings

+

Private IP address for write.

+

public_ips

+

String

+

Public IP address of the instance.

+

db_user_name

+

String

+

Default username.

+

vpc_id

+

String

+

VPC ID.

+

subnet_id

+

String

+

Network ID of the subnet.

+

security_group_id

+

String

+

Security group ID.

+

configuration_id

+

String

+

ID of the parameter template used for creating an instance or ID of the latest parameter template that is applied to an instance.

+

backup_strategy

+

MysqlBackupStrategy object

+

Backup policy.

+

nodes

+

Array of MysqlInstanceNodeInfo objects

+

Node information.

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

time_zone

+

String

+

Time zone.

+

az_mode

+

String

+

AZ type. It can be single or multi.

+

master_az_code

+

String

+

Primary AZ.

+

maintenance_window

+

String

+

Maintenance window in the UTC format.

+

tags

+

Array of MysqlTags objects

+

Tags for managing instances.

+

dedicated_resource_id

+

String

+

Dedicated resource pool ID. This parameter is returned only when the instance belongs to a dedicated resource pool.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 MysqlDatastore

Parameter

+

Type

+

Description

+

type

+

String

+

DB engine. Currently, only gaussdb-mysql is supported.

+

version

+

String

+

DB version.

+

kernel_version

+

String

+

Database kernel version.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 MysqlInatanceNodeVolumeInfo

Parameter

+

Type

+

Description

+

type

+

String

+

Disk type.

+

used

+

String

+

Used disk size in GB.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 MysqlBackupStrategy

Parameter

+

Type

+

Description

+

start_time

+

String

+

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

+

keep_days

+

String

+

Backup retention days.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 MysqlInstanceNodeInfo

Parameter

+

Type

+

Description

+

id

+

String

+

DB instance ID.

+

name

+

String

+

Node name.

+

type

+

String

+

Node type, which can be master or slave.

+

status

+

String

+

Node status.

+

port

+

Integer

+

Database port.

+

private_read_ips

+

Array of strings

+

Private IP address for read of the node.

+

volume

+

Table 6 object

+

Storage disk information.

+

az_code

+

String

+

AZ.

+

region_code

+

String

+

Region where the instance is located.

+

created

+

String

+

DB instance creation time.

+

updated

+

String

+

Update time.

+

flavor_ref

+

String

+

Specification code.

+

max_connections

+

String

+

Maximum number of connections.

+

vcpus

+

String

+

Number of vCPUs.

+

ram

+

String

+

Memory size in GB.

+

need_restart

+

Boolean

+

Whether to reboot the instance for the parameter modifications to take effect.

+

priority

+

Integer

+

Failover priority.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 MysqlTags

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key. The value can contain a maximum of 36 Unicode characters. The value cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

+

value

+

String

+

Tag value. It contains a maximum of 43 Unicode characters. The value can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Querying details of a DB instance

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

Example Response

Status code: 201

+

Success.

+
{
+  "instance": {
+    "id": "d2cda7b97a39488e8b30e3cea4066204in07",
+    "name": "taurusdb-d616-lb07",
+    "status": "ACTIVE",
+    "project_id": "053f533ead80d5102f0cc012e8d468a4",
+    "enterprise_project_id": "0",
+    "type": "Cluster",
+    "charge_info": {
+      "charge_mode": "postPaid",
+      "order_id": ""
+    },
+    "node_count": 2,
+    "datastore": {
+      "type": "gaussdb-mysql",
+      "version": "8.0"
+    },
+    "created": "2020-07-21T09:13:56+0200",
+    "updated": "2020-07-21T09:27:54+0200",
+    "public_ips": "",
+    "private_write_ips": [
+      "192.168.0.235"
+    ],
+    "db_user_name": "root",
+    "port": "3306",
+    "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
+    "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186",
+    "security_group_id": "c7f69884-fe2b-4630-8114-70a11499d902",
+    "backup_strategy": {
+      "start_time": "00:00-00:00",
+      "keep_days": "0"
+    },
+    "nodes": [
+      {
+        "id": "799a0f2fa49a4151bf9f7063c1fbba36no07",
+        "name": "taurusdb-d616-lb07_node01",
+        "type": "master",
+        "status": "ACTIVE",
+        "port": 3306,
+        "private_read_ips": [
+          "192.168.0.163"
+        ],
+        "volume": {
+          "type": "POOL",
+          "used": "0.0"
+        },
+        "az_code": "eu-de-01",
+        "region_code": "eu-de",
+        "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
+        "flavor_ref": "gaussdb.mysql.xlarge.x86.8",
+        "max_connections": null,
+        "vcpus": "4",
+        "ram": "32",
+        "need_restart": false,
+        "priority": 1
+      },
+      {
+        "id": "816459d771c444db9fa4c1d5c173cb1cno07",
+        "name": "taurusdb-d616-lb07_node02",
+        "type": "slave",
+        "status": "ACTIVE",
+        "port": 3306,
+        "private_read_ips": [
+          "192.168.0.160"
+        ],
+        "volume": {
+          "type": "POOL",
+          "used": "0.0"
+        },
+        "az_code": "eu-de-01",
+        "region_code": "eu-de",
+        "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
+        "flavor_ref": "gaussdb.mysql.xlarge.x86.8",
+        "max_connections": null,
+        "vcpus": "4",
+        "ram": "32",
+        "need_restart": false,
+        "priority": 1
+      }
+    ],
+    "time_zone": "UTC+08:00",
+    "backup_used_space": 0,
+    "az_mode": "single",
+    "master_az_code": "eu-de-01",
+    "maintenance_window": "18:00-22:00"
+  }
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0007.html b/docs/taurusdb/api-ref/gaussdb_11_0007.html new file mode 100644 index 000000000..042a724c2 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0007.html @@ -0,0 +1,173 @@ + + +

Deleting a DB Instance

+

Function

This API is used to delete a DB instance. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

ID of the task for deleting a DB instance.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

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

Example Response

Status code: 500

+

Server error.

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0015.html b/docs/taurusdb/api-ref/gaussdb_11_0015.html new file mode 100644 index 000000000..43193c5e1 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0015.html @@ -0,0 +1,226 @@ + + +

Creating a Read Replica

+

Function

This API is used to create a read replica. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

priorities

+

Yes

+

Array of integers

+

Read replica failover priority ranging from 1 to 16. The total number of the primary node and read replicas is up to 16.

+
+
+
+

Response Parameters

Status code: 201

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

Parameter

+

Type

+

Description

+

instance_id

+

String

+

DB instance ID.

+

node_names

+

Array of strings

+

Node name list

+

job_id

+

String

+

ID of the task for creating a DB instance.

+

This parameter is returned only when pay-per-use DB instances are created.

+

order_id

+

String

+

Order ID. This parameter is returned only when yearly/monthly instances are created.

+
+
+

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

Creating a read replica

+
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge
+
+{
+  "priorities" : [ 1, 2 ]
+}
+
+

Example Response

Status code: 201

+

Success.

+
{
+  "instance_id" : "f381d0b539e644df8f5b0d3a62129515in07",
+  "node_names" : [ "taurusdb-ccf5_node03" ],
+  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0016.html b/docs/taurusdb/api-ref/gaussdb_11_0016.html new file mode 100644 index 000000000..4b6306088 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0016.html @@ -0,0 +1,180 @@ + + +

Deleting a Read Replica

+

Function

This API is used to delete a read replica. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

ID of the task for deleting a read replica.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/3d39c18788b54a919bab633874c159dfin01/nodes/ss62c18799854a919bab633874c159dfin55
+
+

Example Response

Status code: 500

+

Server error.

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0018.html b/docs/taurusdb/api-ref/gaussdb_11_0018.html new file mode 100644 index 000000000..c275cb5f2 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0018.html @@ -0,0 +1,211 @@ + + +

Changing a DB Instance Name

+

Function

This API is used to change a DB instance name. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Instance name.

+

Instances of the same type can have same names under the same tenant.

+

The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_).

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameter

Parameter

+

Type

+

Description

+

job_id

+

String

+

ID of the task for changing a DB instance name.

+
+
+

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

Changing a DB instance name

+
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name
+
+{
+  "name" : "taurusdb-name"
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "job_id" : "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+

+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0019.html b/docs/taurusdb/api-ref/gaussdb_11_0019.html new file mode 100644 index 000000000..4d67667fb --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0019.html @@ -0,0 +1,185 @@ + + +

Resetting a Database Password

+

Function

This API is used to reset a database password. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

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

Parameter

+

Mandatory

+

Type

+

Description

+

password

+

Yes

+

String

+

Database password.

+

Valid value:

+

The password consists of 8 to 32 characters and contains at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^*-_=+?,()&).

+

You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid.

+
+
+
+

Response Parameters

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

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"
+}
+
+

Example Response

{}

+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0020.html b/docs/taurusdb/api-ref/gaussdb_11_0020.html new file mode 100644 index 000000000..a971a6dda --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0020.html @@ -0,0 +1,236 @@ + + +

Changing DB Instance Specifications

+

Function

This API is used to change DB instance specifications. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

resize_flavor

+

Yes

+

MysqlResizeFlavor object

+

Specification change information.

+
+
+ +
+ + + + + + + + + + + +
Table 4 MysqlResizeFlavor

Parameter

+

Mandatory

+

Type

+

Description

+

spec_code

+

Yes

+

String

+

Specification code.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Job ID for changing DB instance specifications. This parameter is returned only when you change the specifications of a pay-per-use DB instance.

+

order_id

+

String

+

Order ID for changing DB instance specifications. This parameter is returned only when you change the specification of a yearly/monthly DB instance.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Changing instance specifications

+
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action
+
+{
+  "resize_flavor" : {
+    "spec_code" : "gaussdb.mysql.xlarge.x86.8"
+  }
+}
+
+

Example Response

None

+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0021.html b/docs/taurusdb/api-ref/gaussdb_11_0021.html new file mode 100644 index 000000000..5cbc595a6 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0021.html @@ -0,0 +1,25 @@ + + + +

Backup Management

+ +

+
+ +
+ + +
+
Parent topic: APIs (Unavailable Soon)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0022.html b/docs/taurusdb/api-ref/gaussdb_11_0022.html new file mode 100644 index 000000000..df8e46299 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0022.html @@ -0,0 +1,288 @@ + + +

Creating a Manual Backup

+

Function

This API is used to create a manual backup. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

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

+

name

+

Yes

+

String

+

Backup name.

+

The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_).

+

description

+

No

+

String

+

Backup description. It contains a maximum of 256 characters and cannot contain the special characters (>!<"&'=)

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameter

Parameter

+

Type

+

Description

+

backup

+

backup object

+

Backup information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 backup

Parameter

+

Type

+

Description

+

id

+

String

+

Backup ID.

+

name

+

String

+

Backup name.

+

descriprion

+

String

+

Backup description.

+

begin_time

+

String

+

Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.

+

status

+

String

+

Backup status

+

Valid value:

+
  • BUILDING: Backup in progress
  • COMPLETED: Backup completed
  • FAILED: Backup failed
  • AVAILABLE: Backup available
+

type

+

String

+

Backup type. Value:

+

Valid value:

+

manual: manual full backup

+

instance_id

+

String

+

DB instance ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

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",
+   "description": "manual backup"
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "backup" : {
+    "id" : "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
+    "name" : "backup-1",
+    "description": "Manual backup"
+    "begin_time" : "2020-07-07T01:17:05+0200",
+    "status" : "BUILDING",
+    "type" : "manual",
+    "instance_id" : "ef25188419f941309882d2986b2210b9in07"
+  }
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+

+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0023.html b/docs/taurusdb/api-ref/gaussdb_11_0023.html new file mode 100644 index 000000000..d10e799c3 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0023.html @@ -0,0 +1,379 @@ + + +

Querying Backups

+

Function

This API is used to query backups according to search criteria. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

backups

+

Array of backups objects

+

Backup information.

+

total_count

+

Long

+

Total number of backup files.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 backups

Parameter

+

Type

+

Description

+

id

+

String

+

Backup ID.

+

name

+

String

+

Backup name.

+

begin_time

+

String

+

Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

end_time

+

String

+

Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

status

+

String

+

Backup status. Value:

+
  • BUILDING: Backup in progress
  • COMPLETED: Backup completed
  • FAILED: Backup failed
  • AVAILABLE: Backup available
+

take_up_time

+

Integer

+

Backup duration in minutes.

+

type

+

String

+

Backup type. Value:

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

size

+

Double

+

Backup size in MB.

+

datastore

+

MysqlDatastore object

+

Database information.

+

instance_id

+

String

+

DB instance ID.

+

description

+

String

+

Description of the backup file.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 MysqlDatastore

Parameter

+

Type

+

Description

+

type

+

String

+

DB engine. Currently, only gaussdb-mysql is supported.

+

version

+

String

+

DB version.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

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

Example Response

Status code: 200

+

Success.

+
{
+  "backups" : [ {
+    "id" : "1fe4feaab48f11e6654hfa163eba87e4b66u",
+    "name" : "TaurusDB-e747-20200705185048266",
+    "begin_time" : "2018-08-06T12:41:14+0200",
+    "end_time" : "2018-08-06T12:45:14+0200",
+    "take_up_time" : 2,
+    "status" : "COMPLETED",
+    "type" : "auto",
+    "size" : 2803,
+    "datastore" : {
+      "type" : "gaussdb-mysql",
+      "version" : "8.0"
+    },
+    "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01"
+   
+  } ],
+  "total_count" : 1
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+

+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0024.html b/docs/taurusdb/api-ref/gaussdb_11_0024.html new file mode 100644 index 000000000..712feec4c --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0024.html @@ -0,0 +1,217 @@ + + +

Querying an Automated Backup Policy

+

Function

This API is used to query an automated backup policy. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

backup_policy

+

BackupPolicy object

+

Backup policy information.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 BackupPolicy

Parameter

+

Type

+

Description

+

keep_days

+

Integer

+

Backup retention days.

+

start_time

+

String

+

Backup time window. Automated backups will be triggered during the backup time window.

+

period

+

String

+

Backup cycle configuration. Data will be automatically backed up on the selected days every week.

+
+
+

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

get https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "backup_policy" : {
+    "keep_days" : "7,",
+    "start_time" : "19:00-20:00",
+    "period" : "1,2"
+   
+  }
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0025.html b/docs/taurusdb/api-ref/gaussdb_11_0025.html new file mode 100644 index 000000000..a90e7ddd1 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0025.html @@ -0,0 +1,286 @@ + + +

Modifying the Backup Policy

+

Function

This API is used to modify the backup policy. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

backup_policy

+

Yes

+

MysqlBackupPolicy object

+

Database information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MysqlBackupPolicy

Parameter

+

Mandatory

+

Type

+

Description

+

start_time

+

Yes

+

String

+

Backup time window. Automated backups will be triggered during the backup time window.

+

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.

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

Example value:

+

21:00-22:00

+

keep_days

+

Yes

+

Integer

+

Backup retention days.

+

period

+

Yes

+

String

+

Backup cycle configuration. Data will be automatically backed up on the selected days every week.

+

Value range: The value is a number separated by commas (,), indicating the days of the week.

+

For example, the value 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.

+

retention_num_backup_level1

+

No

+

Integer

+

Number of retained level-1 backups. The default value is 0. This parameter is valid when the level-1 backup function is enabled. Valid value:

+
  • 0
  • 1
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

status

+

String

+

Backup status. Value:

+
  • BUILDING: Modification in progress
  • COMPLETED: Modification completed
  • FAILED: Modification failed
+

instance_id

+

String

+

Instance ID.

+

instance_name

+

String

+

Instance name.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

Modifying the backup policy

+
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update
+
+{
+  "backup_policy" : {
+    "keep_days" : 7,
+    "start_time" : "19:00-20:00",
+    "period" : "1,2,3,4,5"
+  }
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "status" : "COMPLETED",
+  "instance_id" : "ef25188419f941309882d2986b2210b9in07",
+  "instance_name" : "taurusdb"
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0026.html b/docs/taurusdb/api-ref/gaussdb_11_0026.html new file mode 100644 index 000000000..120a13695 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0026.html @@ -0,0 +1,16 @@ + + +

Parameter Template Management

+

+
+
+ + +
+
Parent topic: APIs (Unavailable Soon)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0027.html b/docs/taurusdb/api-ref/gaussdb_11_0027.html new file mode 100644 index 000000000..6cbb10a7c --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0027.html @@ -0,0 +1,287 @@ + + +

Querying Parameter Templates

+

Function

This API is used to obtain parameter templates, including all databases' default and custom parameter templates. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

configurations

+

Array of ConfigurationSummary objects

+

Parameter template information.

+

total_count

+

Integer

+

Total number of parameter templates.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ConfigurationSummary

Parameter

+

Type

+

Description

+

id

+

String

+

Parameter template ID.

+

name

+

String

+

Parameter template name.

+

description

+

String

+

Parameter template description.

+

datastore_version_name

+

String

+

DB version name.

+

datastore_name

+

String

+

DB name.

+

created

+

String

+

Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

updated

+

String

+

Update time in the "yyyy-MM-ddTHH:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

user_defined

+

Boolean

+

Whether the parameter template is a custom template.

+
  • false: The parameter template is a default template.
  • true: The parameter template is a custom template.
+
+
+

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

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

Example Response

Status code: 200

+

Success.

+
{
+  "total_count" : 1,
+  "configurations" : [ {
+    "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07",
+    "name" : "configuration_test",
+    "description" : "configuration_test",
+    "datastore_version_name" : "8.0",
+    "datastore_name" : "GaussDB(for MySQL)",
+    "created" : "2019-05-15T11:53:34+0000",
+    "updated" : "2019-05-15T11:53:34+0000",
+    "user_defined" : true
+  }, {
+    "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07",
+    "name" : "Default-TaurusDB V2.0",
+    "description" : "Default parameter template for TaurusDB",
+    "datastore_version_name" : "8.0",
+    "datastore_name" : "GaussDB(for MySQL)",
+    "created" : "2019-05-27T03:38:51+0000",
+    "updated" : "2019-05-27T03:38:51+0000",
+    "user_defined" : false
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0028.html b/docs/taurusdb/api-ref/gaussdb_11_0028.html new file mode 100644 index 000000000..315c76b45 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0028.html @@ -0,0 +1,23 @@ + + + +

Quota Management

+ +

+
+ +
+ + +
+
Parent topic: APIs (Unavailable Soon)
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0029.html b/docs/taurusdb/api-ref/gaussdb_11_0029.html new file mode 100644 index 000000000..6cbb7a439 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0029.html @@ -0,0 +1,271 @@ + + +

Querying Enterprise Project Resource Quotas of a Tenant

+

Function

This API is used to obtain the resource quotas of a specified enterprise project. Before calling this API:

+ +
+

URI

+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

quota_list

+

Array of quota objects

+

Quota information list.

+

total_count

+

Integer

+

Number of quota records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 quota

Parameter

+

Type

+

Description

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

enterprise_project_name

+

String

+

Enterprise project name.

+

instance_quota

+

Integer

+

Quota of the DB instance quantity.

+

vcpus_quota

+

Integer

+

Quota of vCPUs.

+

ram_quota

+

Integer

+

Memory quota in GB.

+

availability_instance_quota

+

Integer

+

Remaining quota of DB instances.

+

availability_vcpus_quota

+

Integer

+

Remaining quota of vCPUs.

+

availability_ram_quota

+

Integer

+

Remaining memory quota.

+
+
+

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

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

Example Response

Status code: 200

+

Success.

+
{
+  "quota_list" : [ {
+    "enterprise_project_id" : "0",
+    "enterprise_project_name" : "default",
+    "instance_quota" : 20,
+    "vcpus_quota" : 20,
+    "ram_quota" : 40,
+    "availability_instance_quota" : 1,
+    "availability_vcpus_quota" : 4,
+    "availability_ram_quota" : 8
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Quota Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0030.html b/docs/taurusdb/api-ref/gaussdb_11_0030.html new file mode 100644 index 000000000..141792d26 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0030.html @@ -0,0 +1,231 @@ + + +

Configuring Enterprise Project Resource Quotas of a Tenant

+

Function

This API is used to configure resource quotas for a specified enterprise project. Before calling this API:

+ +
+

URI

+ +
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

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

Parameter

+

Mandatory

+

Type

+

Description

+

quota_list

+

Yes

+

Array of setQuota objects

+

Quota details. Up to 10 quota records can be configured at a time.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 setQuota

Parameter

+

Mandatory

+

Type

+

Description

+

enterprise_project_id

+

Yes

+

String

+

Enterprise project ID.

+

instance_quota

+

Yes

+

Integer

+

Quota of the DB instance quantity. The value ranges from 0 to 1000. (If there are already instances created, this parameter value must be greater than the number of existing instances.)

+

vcpus_quota

+

Yes

+

Integer

+

Quota of vCPUs. Value: 0 to 3600000. (If there are already instances created, this parameter value must be greater than the number of used vCPUs.)

+

ram_quota

+

Yes

+

Integer

+

Memory quota in GB. Value: 0 to 19200000. (If there are already instances created, this parameter value must be greater than the used memory size.)

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 5 Response body parameter

Parameter

+

Type

+

Description

+

quota_list

+

Array of setQuota objects

+

Resource list objects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 setQuota

Parameter

+

Type

+

Description

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

instance_quota

+

Integer

+

Quota of the DB instance quantity.

+

vcpus_quota

+

Integer

+

Quota of vCPUs.

+

ram_quota

+

Integer

+

Memory quota in GB.

+
+
+
+

Example Request

None

+
+

Example Response

Status code: 200

+

Success.

+
{
+  "quota_list" : [ {
+    "enterprise_project_id" : "0",
+    "instance_quota" : 20,
+    "vcpus_quota" : 20,
+    "ram_quota" : 40
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Quota Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0031.html b/docs/taurusdb/api-ref/gaussdb_11_0031.html new file mode 100644 index 000000000..e84f43596 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0031.html @@ -0,0 +1,293 @@ + + +

Modifying Enterprise Project Resource Quotas of a Tenant

+

Function

This API is used to modify the resource quotas of a specified enterprise project. Before calling this API:

+ +
+

URI

+ +
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

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

Parameter

+

Mandatory

+

Type

+

Description

+

quota_list

+

Yes

+

Array of setQuota objects

+

Enterprise project resource quotas to be updated. A maximum of 10 quotas can be updated at a time.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 setQuota

Parameter

+

Mandatory

+

Type

+

Description

+

enterprise_project_id

+

Yes

+

String

+

Enterprise project ID.

+

instance_quota

+

Yes

+

Integer

+

Quota of the DB instance quantity. Value: 0 to 1000. (If there are already instances created, this parameter value must be greater than the number of existing instances.)

+

vcpus_quota

+

Yes

+

Integer

+

Quota of vCPUs. Value: 0 to 3600000. (If there are already instances created, this parameter value must be greater than the number of used vCPUs.)

+

ram_quota

+

Yes

+

Integer

+

Memory quota in GB. Value: 0 to 19200000. (If there are already instances created, this parameter value must be greater than the used memory size.)

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

quota_list

+

Array of setQuota objects

+

Configured quota information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 setQuota

Parameter

+

Type

+

Description

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

instance_quota

+

Integer

+

Quota of the DB instance quantity.

+

vcpus_quota

+

Integer

+

Quota of vCPUs.

+

ram_quota

+

Integer

+

Memory quota in GB.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas
+{
+  "quota_list" : [ {
+    "enterprise_project_id" : "0",
+    "instance_quota" : 20,
+    "vcpus_quota" : 20,
+    "ram_quota" : 40
+  } ]
+}
+
+

Example Response

Status code: 200

+

Success.

+
{
+  "quota_list" : [ {
+    "enterprise_project_id" : "0",
+    "instance_quota" : 20,
+    "vcpus_quota" : 20,
+    "ram_quota" : 40
+  } ]
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Quota Management
+
+
+ diff --git a/docs/taurusdb/api-ref/gaussdb_11_0032.html b/docs/taurusdb/api-ref/gaussdb_11_0032.html new file mode 100644 index 000000000..d8e292005 --- /dev/null +++ b/docs/taurusdb/api-ref/gaussdb_11_0032.html @@ -0,0 +1,401 @@ + + +

Obtaining Information About a Task with a Specified ID

+

Function

This API is used to obtain information about a TaurusDB task with a specified ID in the task center. Before calling this API:

+ +
+

URI

+ +
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+

X-Language

+

No

+

String

+

Language.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

job

+

GetJobInfoDetail object

+

Task information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 GetJobInfoDetail

Parameter

+

Type

+

Description

+

id

+

String

+

Task ID.

+

name

+

String

+

Task name.

+

status

+

String

+

Task execution status.

+
Valid value:
  • Running: The task is being executed.
  • Completed: The task is successfully executed.
  • Failed: The task fails to be executed.
+
+

created

+

String

+

Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

The value is empty unless the instance creation is complete.

+

ended

+

String

+

End time in the "yyyy-mm-ddThh:mm:ssZ" format.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

+

The value is empty unless the instance creation is complete.

+

process

+

String

+

Task execution progress. The execution progress (such as 60%) is displayed only when the task is being executed. Otherwise, "" is returned.

+

instance

+

GetJobInstanceInfoDetail object

+

Instance information of the task with the specified ID.

+

entities

+

Table 6 object

+

Displayed information varies depending on tasks.

+

fail_reason

+

String

+

Task failure information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 GetJobInstanceInfoDetail

Parameter

+

Type

+

Description

+

id

+

String

+

DB instance ID.

+

name

+

String

+

DB instance name.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 entities field data structure description

Name

+

Type

+

Description

+

instance

+

Object

+

DB instance queried in the task.

+

For details, see Table 7.

+

resource_ids

+

List<String>

+

Resource ID involved in a task.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 7 entities.instance field data structure description

Name

+

Type

+

Description

+

endpoint

+

String

+

DB instance connection address.

+

type

+

String

+

DB instance type.

+

datastore

+

Object

+

DB information. For details, see Table 8.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 datastore field data structure description

Name

+

Type

+

Description

+

type

+

String

+

DB engine.

+

version

+

String

+

DB version.

+
+
+ +
+ + + + + + + + + +
Table 9 entities field data structure description (binding or unbinding an EIP)

Name

+

Type

+

Description

+

public_ip

+

String

+

EIP bound to the instance.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Request

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514
+
+

Example Response

In the response example, some tasks in the task center are used as examples.

+
+

Status code: 200

+

Success.

+
{
+  "job": {
+    "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
+    "name": " RestartGaussDBInstance",
+    "status": "Completed",
+    "created": "2018-08-06T10:41:14+0000",
+    "ended": "2018-08-06T16:41:14+0000",
+    "process": "",
+    "instance": {
+      "id": "a48e43ff268f4c0e879652d65e63d0fbin01",
+      "name": "DO-NOT-TOUCH-mgr2-taurusdb"
+    },
+    "entities": {}
+    }
+}
+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+

+
+
+
+
Parent topic: APIs (Unavailable Soon)
+
+
+ diff --git a/docs/taurusdb/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/taurusdb/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 000000000..60f607621 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/taurusdb/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 000000000..47a9c7235 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/delta.gif b/docs/taurusdb/api-ref/public_sys-resources/delta.gif new file mode 100644 index 000000000..0d1b1f674 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/deltaend.gif b/docs/taurusdb/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 000000000..cc7da0fc8 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/taurusdb/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 000000000..379428032 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/taurusdb/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 000000000..6aaaa11c2 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/icon-caution.gif b/docs/taurusdb/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/icon-danger.gif b/docs/taurusdb/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/icon-huawei.gif b/docs/taurusdb/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 000000000..a31d60f89 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/icon-note.gif b/docs/taurusdb/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 000000000..31be2b039 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/icon-notice.gif b/docs/taurusdb/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 000000000..409070650 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/icon-tip.gif b/docs/taurusdb/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 000000000..c47bae05c Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/icon-warning.gif b/docs/taurusdb/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/taurusdb/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 000000000..57a0e1f53 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/taurusdb/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 000000000..fa4b64990 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/taurusdb/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/taurusdb/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 000000000..def5c3565 Binary files /dev/null and b/docs/taurusdb/api-ref/public_sys-resources/warning_3.0-en-us.png differ diff --git a/docs/taurusdb/api-ref/topic_300000006.html b/docs/taurusdb/api-ref/topic_300000006.html new file mode 100644 index 000000000..696edb997 --- /dev/null +++ b/docs/taurusdb/api-ref/topic_300000006.html @@ -0,0 +1,31 @@ + + + +

Database Proxy

+ +

+
+ +
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/topic_300000007.html b/docs/taurusdb/api-ref/topic_300000007.html new file mode 100644 index 000000000..4f34e3b39 --- /dev/null +++ b/docs/taurusdb/api-ref/topic_300000007.html @@ -0,0 +1,17 @@ + + +

Log Management

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/topic_300000009.html b/docs/taurusdb/api-ref/topic_300000009.html new file mode 100644 index 000000000..a06499d51 --- /dev/null +++ b/docs/taurusdb/api-ref/topic_300000009.html @@ -0,0 +1,20 @@ + + +

Tag Management

+

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/taurusdb/api-ref/topic_300000012.html b/docs/taurusdb/api-ref/topic_300000012.html new file mode 100644 index 000000000..e68830d73 --- /dev/null +++ b/docs/taurusdb/api-ref/topic_300000012.html @@ -0,0 +1,24 @@ + + +

SQL Statement Concurrency Control

+

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+