diff --git a/docs/gaussdb_mysql/api-ref/.placeholder b/docs/gaussdb_mysql/api-ref/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/gaussdb_mysql/api-ref/ALL_META.TXT.json b/docs/gaussdb_mysql/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..4265abb2 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/ALL_META.TXT.json @@ -0,0 +1,332 @@ +[ + { + "uri":"gaussdb_00_0011.html", + "product_code":"gaussdb", + "code":"1", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Before You Start", + "title":"Before You Start", + "githuburl":"" + }, + { + "uri":"gaussdb_00_0001.html", + "product_code":"gaussdb", + "code":"2", + "des":"This document describes how to use application programming interfaces (APIs) to perform operations on DB instances. For details about all supported operations, see API Ov", + "doc_type":"api", + "kw":"Overview,Before You Start,API Reference", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"gaussdb_00_0002.html", + "product_code":"gaussdb", + "code":"3", + "des":"GaussDB(for MySQL) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", + "doc_type":"api", + "kw":"API Calling,Before You Start,API Reference", + "title":"API Calling", + "githuburl":"" + }, + { + "uri":"gaussdb_00_0003.html", + "product_code":"gaussdb", + "code":"4", + "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", + "doc_type":"api", + "kw":"Endpoints,Before You Start,API Reference", + "title":"Endpoints", + "githuburl":"" + }, + { + "uri":"gaussdb_00_0004.html", + "product_code":"gaussdb", + "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 the GaussDB(for MySQL) User Guide.For ", + "doc_type":"api", + "kw":"Constraints,Before You Start,API Reference", + "title":"Constraints", + "githuburl":"" + }, + { + "uri":"gaussdb_00_0005.html", + "product_code":"gaussdb", + "code":"6", + "des":"DomainA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user p", + "doc_type":"api", + "kw":"Concepts,Before You Start,API Reference", + "title":"Concepts", + "githuburl":"" + }, + { + "uri":"gaussdb_02_0000.html", + "product_code":"gaussdb", + "code":"7", + "des":"With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas.", + "doc_type":"api", + "kw":"API Overview,API Reference", + "title":"API Overview", + "githuburl":"" + }, + { + "uri":"gaussdb_03_0000.html", + "product_code":"gaussdb", + "code":"8", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Calling APIs", + "title":"Calling APIs", + "githuburl":"" + }, + { + "uri":"gaussdb_03_0005.html", + "product_code":"gaussdb", + "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,Calling APIs,API Reference", + "title":"Making an API Request", + "githuburl":"" + }, + { + "uri":"gaussdb_03_0001.html", + "product_code":"gaussdb", + "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,Calling APIs,API Reference", + "title":"Authentication", + "githuburl":"" + }, + { + "uri":"gaussdb_03_0006.html", + "product_code":"gaussdb", + "code":"11", + "des":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits ranging from 1xx to", + "doc_type":"api", + "kw":"Response,Calling APIs,API Reference", + "title":"Response", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0000.html", + "product_code":"gaussdb", + "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":"API", + "title":"API", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0001.html", + "product_code":"gaussdb", + "code":"13", + "des":"This API is used to query the DB version information of a specified DB engine.Learn how to authorize and authenticate this API before using it.Before calling this API, ob", + "doc_type":"api", + "kw":"Querying Version Information About a DB Engine,API,API Reference", + "title":"Querying Version Information About a DB Engine", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0002.html", + "product_code":"gaussdb", + "code":"14", + "des":"This API is used to query the database specifications of a specified DB engine version.Learn how to authorize and authenticate this API before using it.Before calling thi", + "doc_type":"api", + "kw":"Querying Database Specifications,API,API Reference", + "title":"Querying Database Specifications", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0003.html", + "product_code":"gaussdb", + "code":"15", + "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", + "title":"Managing DB Instances", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0004.html", + "product_code":"gaussdb", + "code":"16", + "des":"This API is used to create a GaussDB(for MySQL) DB instanceLearn how to authorize and authenticate this API before using it.Before calling this API, obtain the required r", + "doc_type":"api", + "kw":"Creating a DB instance,Managing DB Instances,API Reference", + "title":"Creating a DB instance", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0005.html", + "product_code":"gaussdb", + "code":"17", + "des":"This API is used to query a DB instance list according to search criteria.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain", + "doc_type":"api", + "kw":"Querying a DB Instance List,Managing DB Instances,API Reference", + "title":"Querying a DB Instance List", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0006.html", + "product_code":"gaussdb", + "code":"18", + "des":"This API is used to query the details of a specified DB instance.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain the requ", + "doc_type":"api", + "kw":"Querying Details of a DB Instance,Managing DB Instances,API Reference", + "title":"Querying Details of a DB Instance", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0007.html", + "product_code":"gaussdb", + "code":"19", + "des":"This API is used to delete a DB instance.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain the required region and endpoint", + "doc_type":"api", + "kw":"Deleting a DB Instance,Managing DB Instances,API Reference", + "title":"Deleting a DB Instance", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0008.html", + "product_code":"gaussdb", + "code":"20", + "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 Parameter Templates", + "title":"Managing Parameter Templates", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0009.html", + "product_code":"gaussdb", + "code":"21", + "des":"This API is used to obtain a parameter template list, including all databases' default and custom parameter templates.Learn how to authorize and authenticate this API bef", + "doc_type":"api", + "kw":"Querying a Parameter Template,Managing Parameter Templates,API Reference", + "title":"Querying a Parameter Template", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0010.html", + "product_code":"gaussdb", + "code":"22", + "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 Quotas", + "title":"Managing Quotas", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0011.html", + "product_code":"gaussdb", + "code":"23", + "des":"This API is used to obtain the resource quota of a specified enterprise project.Learn how to authorize and authenticate this API before using it.Before calling this API, ", + "doc_type":"api", + "kw":"Querying Resource Quotas,Managing Quotas,API Reference", + "title":"Querying Resource Quotas", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0012.html", + "product_code":"gaussdb", + "code":"24", + "des":"This API is used to set resource quotas for a specified enterprise project.Learn how to authorize and authenticate this API before using it.Before calling this API, obtai", + "doc_type":"api", + "kw":"Configuring Resource Quotas,Managing Quotas,API Reference", + "title":"Configuring Resource Quotas", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0013.html", + "product_code":"gaussdb", + "code":"25", + "des":"This API is used to modify the resource quota of a specified enterprise project.Learn how to authorize and authenticate this API before using it.Before calling this API, ", + "doc_type":"api", + "kw":"Modifying Resource Quotas,Managing Quotas,API Reference", + "title":"Modifying Resource Quotas", + "githuburl":"" + }, + { + "uri":"gaussdb_04_0014.html", + "product_code":"gaussdb", + "code":"26", + "des":"This API is used to obtain task information from the task center.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain the requ", + "doc_type":"api", + "kw":"Obtaining Task Information,API,API Reference", + "title":"Obtaining Task Information", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0000.html", + "product_code":"gaussdb", + "code":"27", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Appendix", + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0001.html", + "product_code":"gaussdb", + "code":"28", + "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", + "title":"Abnormal Request Results", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0002.html", + "product_code":"gaussdb", + "code":"29", + "des":"Status code list:", + "doc_type":"api", + "kw":"Status Codes,Appendix,API Reference", + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0003.html", + "product_code":"gaussdb", + "code":"30", + "des":"The following table describes error codes.", + "doc_type":"api", + "kw":"Error Codes,Appendix,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0004.html", + "product_code":"gaussdb", + "code":"31", + "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", + "title":"Obtaining a Project ID", + "githuburl":"" + }, + { + "uri":"gaussdb_10_0006.html", + "product_code":"gaussdb", + "code":"32", + "des":"This section describes namespaces, descriptions, and dimensions of monitoring metrics to be reported to Cloud Eye. You can use APIs provided by Cloud Eye to retrieve moni", + "doc_type":"api", + "kw":"GaussDB(for MySQL) Monitoring Metrics,Appendix,API Reference", + "title":"GaussDB(for MySQL) Monitoring Metrics", + "githuburl":"" + }, + { + "uri":"changeHistory.html", + "product_code":"gaussdb", + "code":"33", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/gaussdb_mysql/api-ref/CLASS.TXT.json b/docs/gaussdb_mysql/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..0d48ad61 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/CLASS.TXT.json @@ -0,0 +1,299 @@ +[ + { + "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":"gaussdb", + "title":"Before You Start", + "uri":"gaussdb_00_0011.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"This document describes how to use application programming interfaces (APIs) to perform operations on DB instances. For details about all supported operations, see API Ov", + "product_code":"gaussdb", + "title":"Overview", + "uri":"gaussdb_00_0001.html", + "doc_type":"api", + "p_code":"1", + "code":"2" + }, + { + "desc":"GaussDB(for MySQL) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", + "product_code":"gaussdb", + "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":"gaussdb", + "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 the GaussDB(for MySQL) User Guide.For ", + "product_code":"gaussdb", + "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":"gaussdb", + "title":"Concepts", + "uri":"gaussdb_00_0005.html", + "doc_type":"api", + "p_code":"1", + "code":"6" + }, + { + "desc":"With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas.", + "product_code":"gaussdb", + "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":"gaussdb", + "title":"Calling APIs", + "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":"gaussdb", + "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":"gaussdb", + "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":"gaussdb", + "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":"gaussdb", + "title":"API", + "uri":"gaussdb_04_0000.html", + "doc_type":"api", + "p_code":"", + "code":"12" + }, + { + "desc":"This API is used to query the DB version information of a specified DB engine.Learn how to authorize and authenticate this API before using it.Before calling this API, ob", + "product_code":"gaussdb", + "title":"Querying Version Information About a DB Engine", + "uri":"gaussdb_04_0001.html", + "doc_type":"api", + "p_code":"12", + "code":"13" + }, + { + "desc":"This API is used to query the database specifications of a specified DB engine version.Learn how to authorize and authenticate this API before using it.Before calling thi", + "product_code":"gaussdb", + "title":"Querying Database Specifications", + "uri":"gaussdb_04_0002.html", + "doc_type":"api", + "p_code":"12", + "code":"14" + }, + { + "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":"gaussdb", + "title":"Managing DB Instances", + "uri":"gaussdb_04_0003.html", + "doc_type":"api", + "p_code":"12", + "code":"15" + }, + { + "desc":"This API is used to create a GaussDB(for MySQL) DB instanceLearn how to authorize and authenticate this API before using it.Before calling this API, obtain the required r", + "product_code":"gaussdb", + "title":"Creating a DB instance", + "uri":"gaussdb_04_0004.html", + "doc_type":"api", + "p_code":"15", + "code":"16" + }, + { + "desc":"This API is used to query a DB instance list according to search criteria.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain", + "product_code":"gaussdb", + "title":"Querying a DB Instance List", + "uri":"gaussdb_04_0005.html", + "doc_type":"api", + "p_code":"15", + "code":"17" + }, + { + "desc":"This API is used to query the details of a specified DB instance.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain the requ", + "product_code":"gaussdb", + "title":"Querying Details of a DB Instance", + "uri":"gaussdb_04_0006.html", + "doc_type":"api", + "p_code":"15", + "code":"18" + }, + { + "desc":"This API is used to delete a DB instance.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain the required region and endpoint", + "product_code":"gaussdb", + "title":"Deleting a DB Instance", + "uri":"gaussdb_04_0007.html", + "doc_type":"api", + "p_code":"15", + "code":"19" + }, + { + "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":"gaussdb", + "title":"Managing Parameter Templates", + "uri":"gaussdb_04_0008.html", + "doc_type":"api", + "p_code":"12", + "code":"20" + }, + { + "desc":"This API is used to obtain a parameter template list, including all databases' default and custom parameter templates.Learn how to authorize and authenticate this API bef", + "product_code":"gaussdb", + "title":"Querying a Parameter Template", + "uri":"gaussdb_04_0009.html", + "doc_type":"api", + "p_code":"20", + "code":"21" + }, + { + "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":"gaussdb", + "title":"Managing Quotas", + "uri":"gaussdb_04_0010.html", + "doc_type":"api", + "p_code":"12", + "code":"22" + }, + { + "desc":"This API is used to obtain the resource quota of a specified enterprise project.Learn how to authorize and authenticate this API before using it.Before calling this API, ", + "product_code":"gaussdb", + "title":"Querying Resource Quotas", + "uri":"gaussdb_04_0011.html", + "doc_type":"api", + "p_code":"22", + "code":"23" + }, + { + "desc":"This API is used to set resource quotas for a specified enterprise project.Learn how to authorize and authenticate this API before using it.Before calling this API, obtai", + "product_code":"gaussdb", + "title":"Configuring Resource Quotas", + "uri":"gaussdb_04_0012.html", + "doc_type":"api", + "p_code":"22", + "code":"24" + }, + { + "desc":"This API is used to modify the resource quota of a specified enterprise project.Learn how to authorize and authenticate this API before using it.Before calling this API, ", + "product_code":"gaussdb", + "title":"Modifying Resource Quotas", + "uri":"gaussdb_04_0013.html", + "doc_type":"api", + "p_code":"22", + "code":"25" + }, + { + "desc":"This API is used to obtain task information from the task center.Learn how to authorize and authenticate this API before using it.Before calling this API, obtain the requ", + "product_code":"gaussdb", + "title":"Obtaining Task Information", + "uri":"gaussdb_04_0014.html", + "doc_type":"api", + "p_code":"12", + "code":"26" + }, + { + "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":"gaussdb", + "title":"Appendix", + "uri":"gaussdb_10_0000.html", + "doc_type":"api", + "p_code":"", + "code":"27" + }, + { + "desc":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringReturned error code when a task submission exception occurs. For details, see", + "product_code":"gaussdb", + "title":"Abnormal Request Results", + "uri":"gaussdb_10_0001.html", + "doc_type":"api", + "p_code":"27", + "code":"28" + }, + { + "desc":"Status code list:", + "product_code":"gaussdb", + "title":"Status Codes", + "uri":"gaussdb_10_0002.html", + "doc_type":"api", + "p_code":"27", + "code":"29" + }, + { + "desc":"The following table describes error codes.", + "product_code":"gaussdb", + "title":"Error Codes", + "uri":"gaussdb_10_0003.html", + "doc_type":"api", + "p_code":"27", + "code":"30" + }, + { + "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":"gaussdb", + "title":"Obtaining a Project ID", + "uri":"gaussdb_10_0004.html", + "doc_type":"api", + "p_code":"27", + "code":"31" + }, + { + "desc":"This section describes namespaces, descriptions, and dimensions of monitoring metrics to be reported to Cloud Eye. You can use APIs provided by Cloud Eye to retrieve moni", + "product_code":"gaussdb", + "title":"GaussDB(for MySQL) Monitoring Metrics", + "uri":"gaussdb_10_0006.html", + "doc_type":"api", + "p_code":"27", + "code":"32" + }, + { + "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":"gaussdb", + "title":"Change History", + "uri":"changeHistory.html", + "doc_type":"api", + "p_code":"", + "code":"33" + } +] \ No newline at end of file diff --git a/docs/gaussdb_mysql/api-ref/PARAMETERS.txt b/docs/gaussdb_mysql/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/gaussdb_mysql/api-ref/changeHistory.html b/docs/gaussdb_mysql/api-ref/changeHistory.html new file mode 100644 index 00000000..50d0c9c1 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/changeHistory.html @@ -0,0 +1,26 @@ + + +

Change History

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

Released On

+

Description

+

2022-10-30

+

This issue is the second official release.

+ +

2020-05-30

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/en-us_image_0000001372529646.png b/docs/gaussdb_mysql/api-ref/en-us_image_0000001372529646.png new file mode 100644 index 00000000..d4a37a97 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/en-us_image_0000001372529646.png differ diff --git a/docs/gaussdb_mysql/api-ref/en-us_image_0000001422968749.gif b/docs/gaussdb_mysql/api-ref/en-us_image_0000001422968749.gif new file mode 100644 index 00000000..493d4482 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/en-us_image_0000001422968749.gif differ diff --git a/docs/gaussdb_mysql/api-ref/en-us_image_0000001423128721.jpg b/docs/gaussdb_mysql/api-ref/en-us_image_0000001423128721.jpg new file mode 100644 index 00000000..9a3a0c8d Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/en-us_image_0000001423128721.jpg differ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_00_0001.html b/docs/gaussdb_mysql/api-ref/gaussdb_00_0001.html new file mode 100644 index 00000000..9519e72a --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_00_0001.html @@ -0,0 +1,12 @@ + + +

Overview

+

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 GaussDB(for MySQL) through an API, ensure that you are familiar with GaussDB(for MySQL) concepts. For details, see "What Is GaussDB(for MySQL)?" in the GaussDB(for MySQL) User Guide.

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

API Calling

+

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

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_00_0003.html b/docs/gaussdb_mysql/api-ref/gaussdb_00_0003.html new file mode 100644 index 00000000..fbbb485f --- /dev/null +++ b/docs/gaussdb_mysql/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/gaussdb_mysql/api-ref/gaussdb_00_0004.html b/docs/gaussdb_mysql/api-ref/gaussdb_00_0004.html new file mode 100644 index 00000000..6177abac --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_00_0004.html @@ -0,0 +1,11 @@ + + +

Constraints

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

Concepts

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

Before You Start

+
+
+ +
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_02_0000.html b/docs/gaussdb_mysql/api-ref/gaussdb_02_0000.html new file mode 100644 index 00000000..eacb16c5 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_02_0000.html @@ -0,0 +1,46 @@ + + +

API Overview

+

With GaussDB(for MySQL) 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 DB instances, query DB instance lists, query DB instance details, delete DB instances, create read replicas, and delete read replicas.

+

Parameter template management

+

Query parameter templates.

+

Quota management

+

Query, set, and modify resource quotas.

+

Task information query

+

Obtain task information about the task center.

+
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_03_0000.html b/docs/gaussdb_mysql/api-ref/gaussdb_03_0000.html new file mode 100644 index 00000000..954e9289 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_03_0000.html @@ -0,0 +1,15 @@ + + +

Calling APIs

+
+
+ +
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_03_0001.html b/docs/gaussdb_mysql/api-ref/gaussdb_03_0001.html new file mode 100644 index 00000000..ccace035 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_03_0001.html @@ -0,0 +1,24 @@ + + +

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.

+

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: Calling APIs
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_03_0005.html b/docs/gaussdb_mysql/api-ref/gaussdb_03_0005.html new file mode 100644 index 00000000..a0c0fc29 --- /dev/null +++ b/docs/gaussdb_mysql/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. You can obtain the values 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: Calling APIs
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_03_0006.html b/docs/gaussdb_mysql/api-ref/gaussdb_03_0006.html new file mode 100644 index 00000000..75fde425 --- /dev/null +++ b/docs/gaussdb_mysql/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: Calling APIs
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0000.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0000.html new file mode 100644 index 00000000..395720fa --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0000.html @@ -0,0 +1,21 @@ + + +

API

+
+
+ +
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0001.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0001.html new file mode 100644 index 00000000..41622425 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0001.html @@ -0,0 +1,105 @@ + + +

Querying Version Information About a DB Engine

+

Function

This API is used to query the DB version information of a specified DB engine.

+ +
+

URI

+
+

Request

None.

+
+

Response

+
+ +

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: API
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0002.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0002.html new file mode 100644 index 00000000..1b39aeb2 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0002.html @@ -0,0 +1,208 @@ + + +

Querying Database Specifications

+

Function

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

+ +
+

URI

+ +
+

Request

None.

+
+

Response

+
+ +

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: API
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0003.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0003.html new file mode 100644 index 00000000..29955fd1 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0003.html @@ -0,0 +1,22 @@ + + +

Managing DB Instances

+

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0004.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0004.html new file mode 100644 index 00000000..64f0f2f1 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0004.html @@ -0,0 +1,594 @@ + + +

Creating a DB instance

+

Function

This API is used to create a GaussDB(for MySQL) DB instance

+ +
+

URI

+
+

Request

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Parameter description

Name

+

Mandatory

+

Type

+

Description

+

charge_info

+

No

+

Object

+

Billing mode.

+

For details, see Table 3.

+

name

+

Yes

+

String

+

DB instance name.

+

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

+

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

+

datastore

+

Yes

+

Object

+

Database information.

+

For details, see Table 4.

+

mode

+

Yes

+

String

+

DB instance type. Currently, only the cluster type is supported.

+

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 the network ACL is enabled for the subnet used by the created DB 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.

+

Valid value:

+

The password is 8 to 32 characters long and must contain 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

+

Object

+

Automated backup policy.

+

For details, see Table 5.

+

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 read-only nodes from 1 to 9. A DB instance can have a maximum of 15 read-only nodes.

+

region

+

Yes

+

String

+

Region ID.

+

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

+

enterprise_project_id

+

No

+

String

+

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

+
+
+ +
+ + + + + + + + + + + +
Table 3 charge_info field data structure description

Name

+

Mandatory

+

Type

+

Description

+

charge_mode

+

Yes

+

String

+

Billing mode.

+

Value: postPaid

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 datastore field data structure description

Name

+

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 section Querying Version Information About a DB Engine.

+
+
+ +
+ + + + + + + + + + + +
Table 5 backup_strategy field data structure description

Name

+

Mandatory

+

Type

+

Description

+

start_time

+

Yes

+

String

+

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

+
+
+

The value of region in the following is used as an example.

+
+ +
+

Response

+

The values of region and master_availability_zone are used as examples.

+
+ +
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0005.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0005.html new file mode 100644 index 00000000..f2b7d124 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0005.html @@ -0,0 +1,449 @@ + + +

Querying a DB Instance List

+

Function

This API is used to query a DB instance list according to search criteria.

+ +
+

URI

+
+

Request

None.

+
+

Response

+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0006.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0006.html new file mode 100644 index 00000000..fabee687 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0006.html @@ -0,0 +1,581 @@ + + +

Querying Details of a DB Instance

+

Function

This API is used to query the details of a specified DB instance.

+ +
+

URI

+
+

Request

None.

+
+

Response

+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0007.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0007.html new file mode 100644 index 00000000..ec91e716 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0007.html @@ -0,0 +1,74 @@ + + +

Deleting a DB Instance

+

Function

This API is used to delete a DB instance.

+ +
+

URI

+
+

Request

None.

+
+

Response

+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing DB Instances
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0008.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0008.html new file mode 100644 index 00000000..2236f1fc --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0008.html @@ -0,0 +1,16 @@ + + +

Managing Parameter Templates

+

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0009.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0009.html new file mode 100644 index 00000000..23594510 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0009.html @@ -0,0 +1,158 @@ + + +

Querying a Parameter Template

+

Function

This API is used to obtain a parameter template list, including all databases' default and custom parameter templates.

+ +
+

URI

+
+

Request

None.

+
+

Response

+ +
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing Parameter Templates
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0010.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0010.html new file mode 100644 index 00000000..3ac2eaee --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0010.html @@ -0,0 +1,23 @@ + + + +

Managing Quotas

+ +

+
+ +
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0011.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0011.html new file mode 100644 index 00000000..42893e89 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0011.html @@ -0,0 +1,169 @@ + + +

Querying Resource Quotas

+

Function

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

+ +
+

URI

+
+

Request

None

+
+

Response

+
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing Quotas
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0012.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0012.html new file mode 100644 index 00000000..d96b7d40 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0012.html @@ -0,0 +1,176 @@ + + +

Configuring Resource Quotas

+

Function

This API is used to set resource quotas for a specified enterprise project.

+ +
+

URI

+ +
+

Request

+ +
+

Response

+ +
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing Quotas
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0013.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0013.html new file mode 100644 index 00000000..312c4990 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0013.html @@ -0,0 +1,177 @@ + + +

Modifying Resource Quotas

+

Function

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

+ +
+

URI

+ +
+

Request

+ +
+

Response

+ +
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+
+
+
+
+
Parent topic: Managing Quotas
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0014.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0014.html new file mode 100644 index 00000000..363e9f50 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0014.html @@ -0,0 +1,296 @@ + + +

Obtaining Task Information

+

Function

This API is used to obtain task information from the task center.

+ +
+

URI

+ +
+

Request

None.

+
+

Response

+ +
+

Status Code

For details, see Status Codes.

+
+

Error Code

For details, see Error Codes.

+

+
+
+
+
+
Parent topic: API
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_10_0000.html b/docs/gaussdb_mysql/api-ref/gaussdb_10_0000.html new file mode 100644 index 00000000..7c431c66 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_10_0000.html @@ -0,0 +1,19 @@ + + +

Appendix

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

Abnormal Request Results

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

Status Codes

+

Status code list:

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Status Code

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/gaussdb_mysql/api-ref/gaussdb_10_0003.html b/docs/gaussdb_mysql/api-ref/gaussdb_10_0003.html new file mode 100644 index 00000000..68c865f3 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_10_0003.html @@ -0,0 +1,289 @@ + + +

Error Codes

+

The following table describes error codes.

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

Error Code

+

Response Code

+

Description

+

DBS.200040

+

400

+

The DB engine type must be specified.

+

DBS.200041

+

400

+

Invalid DB engine type.

+

DBS.200051

+

500

+

Invalid deployment mode.

+

DBS.200910

+

400

+

The maximum number of read replicas has been reached.

+

DBS.280203

+

400

+

This is a weak password. Please enter a strong password.

+

DBS.280216

+

400

+

Invalid backup start time.

+

DBS.280227

+

400

+

The new storage space must be greater than the current storage and must be a multiple of 10 GB.

+

DBS.280234

+

400

+

Invalid DB instance name.

+

DBS.280235

+

400

+

Invalid database type.

+

DBS.280236

+

400

+

Invalid database version.

+

DBS.280237

+

400

+

DB engine information must be specified.

+

DBS.280238

+

400

+

The DB engine or version is not supported.

+

DBS.280242

+

400

+

Storage space is out of range.

+

DBS.280243

+

400

+

Invalid region.

+

DBS.280247

+

400

+

Invalid VPC ID.

+

DBS.280248

+

400

+

Invalid subnet ID.

+

DBS.280260

+

400

+

Invalid AZ.

+

DBS.280266

+

400

+

Storage space must be a multiple of 10.

+

DBS.280288

+

400

+

Invalid specification code.

+

DBS.280305

+

400

+

Invalid security group.

+

DBS.280311

+

400

+

Storage space must be specified.

+

DBS.280342

+

400

+

Invalid cluster mode.

+

DBS.280365

+

400

+

Invalid billing mode.

+

DBS.280431

+

400

+

Invalid billing period.

+

DBS.280433

+

400

+

Invalid enterprise project ID.

+

DBS.280434

+

400

+

Invalid specification code

+

DBS.280447

+

400

+

Invalid time zone.

+

DBS.280448

+

400

+

The storage type is sold out.

+

DBS.280450

+

400

+

The DB instance specifications are sold out.

+

DBS.280462

+

400

+

Invalid auto renewal parameter.

+

DBS.280463

+

400

+

Invalid auto payment parameter.

+

DBS.280464

+

400

+

Primary AZ cannot be defined in a single AZ.

+

DBS.280465

+

400

+

Invalid password.

+

DBS.280466

+

400

+

Invalid read replica quantity.

+

DBS.280467

+

400

+

Invalid read replica failover priority.

+

DBS.280468

+

400

+

Invalid DB instance type.

+

DBS.280470

+

400

+

The primary node and read replicas must be located in different AZs.

+

DBS.280471

+

500

+

CBC error.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_10_0004.html b/docs/gaussdb_mysql/api-ref/gaussdb_10_0004.html new file mode 100644 index 00000000..254181bf --- /dev/null +++ b/docs/gaussdb_mysql/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/gaussdb_mysql/api-ref/gaussdb_10_0006.html b/docs/gaussdb_mysql/api-ref/gaussdb_10_0006.html new file mode 100644 index 00000000..95288bd9 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/gaussdb_10_0006.html @@ -0,0 +1,508 @@ + + +

GaussDB(for MySQL) Monitoring Metrics

+

Function Description

This section describes namespaces, descriptions, and dimensions of monitoring metrics to be reported to Cloud Eye. You can use APIs provided by Cloud Eye to retrieve monitoring metrics and alarm information generated for GaussDB(for MySQL).

+
+

Namespace

SYS.GAUSSDB

+
+

Monitoring Metrics

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Monitoring 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: GaussDB(for MySQL) instance

+

gaussdb_mysql002_mem_util

+

Memory Usage

+

Memory usage of the monitored object

+

0–100%

+

Monitored object: ECS

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql004_bytes_in

+

Network Input Throughput

+

Incoming traffic in bytes per second

+

≥0 Bytes/s

+

Monitored object: ECS

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql005_bytes_out

+

Network Output Throughput

+

Outgoing traffic in bytes per second

+

≥0 Bytes/s

+

Monitored object: ECS

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql006_conn_count

+

Total Connections

+

Total number of connections that attempt to connect to the MySQL server

+

≥0 Counts

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql007_conn_active_count

+

Current Active Connections

+

Number of current active connections

+

≥0 Counts

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql008_qps

+

QPS

+

Query times of SQL statements (including storage procedures) per second

+

≥0 Executions/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql009_tps

+

TPS

+

Execution times of submitted and rollback transactions per second

+

≥0 Transactions/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql010_innodb_buf_usage

+

Buffer Pool Usage

+

Ratio of dirty data to all data in the InnoDB buffer

+

0–1

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql011_innodb_buf_hit

+

Buffer Pool Hit Ratio

+

Ratio of read hits to read requests in the InnoDB buffer

+

0–100%

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql012_innodb_buf_dirty

+

Buffer Pool Dirty Block Ratio

+

Ratio of used pages to total pages in the InnoDB buffer

+

0–1

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) 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: GaussDB(for MySQL) instance

+

gaussdb_mysql014_innodb_writes

+

InnoDB Write Throughput

+

Number of write bytes per second in the InnoDB buffer

+

≥0 Counts/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql017_innodb_log_write_req_count

+

InnoDB Log Write Requests per Second

+

Number of InnoDB log write requests per second

+

≥0 Counts/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) 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: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql028_comdml_del_count

+

DELETE Statements per Second

+

Number of DELETE statements executed per second

+

≥0 Executions/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql029_comdml_ins_count

+

INSERT Statements per Second

+

Number of INSERT statements executed per second

+

≥0 Executions/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql030_comdml_ins_sel_count

+

INSERT_SELECT Statements per Second

+

Number of INSERT_SELECT statements executed per second

+

≥0 Executions/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql031_comdml_rep_count

+

REPLACE Statements per Second

+

Number of REPLACE statements executed per second

+

≥0 Executions/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql032_comdml_rep_sel_count

+

REPLACE_SELECTION Statements per Second

+

Number of REPLACE_SELECTION statements executed per second

+

≥0 Executions/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql033_comdml_sel_count

+

SELECT Statements per Second

+

Number of SELECT statements executed per second

+

≥0 Executions/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql034_comdml_upd_count

+

UPDATE Statements per Second

+

Number of UPDATE statements executed per second

+

≥0 Executions/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql035_innodb_del_row_count

+

Row Delete Frequency

+

Number of rows deleted from the InnoDB table per second

+

≥0 Rows/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql036_innodb_ins_row_count

+

Row Insert Frequency

+

Number of rows inserted into the InnoDB table per second

+

≥0 Rows/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql037_innodb_read_row_count

+

Row Read Frequency

+

Number of rows read from the InnoDB table per second

+

≥0 Rows/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql038_innodb_upd_row_count

+

Row Update Frequency

+

Number of rows updated into the InnoDB table per second

+

≥0 Rows/s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql048_disk_used_size

+

Used Storage Space

+

Used storage space of the monitored object

+

0–4000 GB

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql072_conn_usage

+

Connection Usage

+

Percent of used MySQL connections to the total number of connections

+

0~100%

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql074_slow_queries

+

Slow Query Logs

+

Number of MySQL slow query logs generated per minute

+

≥0 Counts/Minute

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) instance

+

gaussdb_mysql077_replication_delay

+

Replication Delay

+

Data replication delay between the primary node and read replicas

+

≥0 s

+

Monitored object: database

+

Monitored instance type: GaussDB(for MySQL) 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: database

+

Monitored instance type: GaussDB(for MySQL) 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: database

+

Monitored instance type: GaussDB(for MySQL) 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: database

+

Monitored instance type: GaussDB(for MySQL) 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: database

+

Monitored instance type: GaussDB(for MySQL) 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: GaussDB(for MySQL) 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: GaussDB(for MySQL) 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: GaussDB(for MySQL) 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: GaussDB(for MySQL) instance

+
+
+
+

Dimension

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

Key

+

Value

+

gaussdb_mysql_instance_id

+

GaussDB (for MySQL) instance ID.

+

gaussdb_mysql_node_id

+

Node ID of the GaussDB (for MySQL) instance.

+
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/ExpandCollapse.js b/docs/gaussdb_mysql/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 00000000..116ddaab --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}}; \ No newline at end of file diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/gaussdb_mysql/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 00000000..60f60762 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/commonltr.css b/docs/gaussdb_mysql/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 00000000..c5480b0a --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/public_sys-resources/commonltr.css @@ -0,0 +1 @@ +body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/commonltr_print.css b/docs/gaussdb_mysql/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 00000000..a5982314 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/commonrtl.css b/docs/gaussdb_mysql/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 00000000..f261da75 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/gaussdb_mysql/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 00000000..47a9c723 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/delta.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/deltaend.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..37942803 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..6aaaa11c Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-caution.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-danger.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-huawei.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-note.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-notice.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-tip.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-warning.gif b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/gaussdb_mysql/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 00000000..57a0e1f5 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/gaussdb_mysql/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 00000000..fa4b6499 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/popup.js b/docs/gaussdb_mysql/api-ref/public_sys-resources/popup.js new file mode 100644 index 00000000..a550862e --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/public_sys-resources/popup.js @@ -0,0 +1 @@ +var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!==null&&typeof document.body!=="undefined"){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(e){if(document.body===null||typeof document.body==="undefined"){return}if(i==0){return}clickFlag=true;var f=Json.parse("jsonData."+e);var a=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var b=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){b=0}var c=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=f;dhtmlgoodies_tooltip.style.left=c+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+b+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=c+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+b+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var d=dhtmlgoodies_tooltip.offsetWidth;if(da){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if((dhtmlgoodies_tooltip!==null&&typeof dhtmlgoodies_tooltip!=="undefined")&&+(dhtmlgoodies_tooltip.style!==null&&typeof dhtmlgoodies_tooltip.style!=="undefined")){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}}; \ No newline at end of file diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/pygments.css b/docs/gaussdb_mysql/api-ref/public_sys-resources/pygments.css new file mode 100644 index 00000000..53c53657 --- /dev/null +++ b/docs/gaussdb_mysql/api-ref/public_sys-resources/pygments.css @@ -0,0 +1 @@ +.hll{background-color:#ffc}.c{color:#069;font-style:italic}.err{color:black}.k{color:#069;font-weight:bold}.ch{color:#069;font-style:italic}.cm{color:#008200}.cp{color:black}.cpf{color:#069;font-style:italic}.c1{color:#008200}.cs{color:#069;font-weight:bold}.gd{color:#000;background-color:#fdd}.ge{font-style:italic}.gr{color:#a00}.gh{color:#999}.gi{color:#000;background-color:#dfd}.go{color:#888}.gp{color:#555}.gs{font-weight:bold}.gu{color:#aaa}.gt{color:#a00}.kc{color:#000080;font-weight:bold}.kd{color:#069;font-weight:bold}.kn{color:#000080;font-weight:bold}.kp{color:#069;font-weight:bold}.kr{color:#000080;font-weight:bold}.kt{color:#069;font-weight:bold}.m{color:blue}.s{color:blue}.na{color:gray}.nt{color:#069;font-weight:bold}.ow{font-weight:bold}.w{color:#bbb}.mb{color:blue}.mf{color:blue}.mh{color:blue}.mi{color:black}.mo{color:blue}.sa{color:blue}.sb{color:blue}.sc{color:#800080}.dl{color:blue}.sd{color:blue}.s2{color:blue}.se{color:blue}.sh{color:blue}.si{color:blue}.sx{color:blue}.sr{color:blue}.s1{color:blue}.ss{color:blue}.il{color:blue}.linenos{width:15px}.linenos{border-right:3px solid #6ce26c;color:#afafaf;text-align:right;padding:0 .5em 0 1em}.codecoloring{line-height:1.1em}.code,.highlight pre{font-family:"Consolas","Bitstream Vera Sans Mono","Courier New",Courier,monospace}.code,.highlight pre span{font-size:1em}.nb{color:#ff1493}.nv{color:#a70}.nx,.o,.n,.nf{color:black}.vc,.vi{color:#a70}.code,.highlight pre{padding:0 1em}.highlighttable pre{box-sizing:border-box;margin:0} \ No newline at end of file diff --git a/docs/gaussdb_mysql/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/gaussdb_mysql/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 00000000..def5c356 Binary files /dev/null and b/docs/gaussdb_mysql/api-ref/public_sys-resources/warning_3.0-en-us.png differ