diff --git a/docs/opengauss/api-ref/.placeholder b/docs/opengauss/api-ref/.placeholder deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/opengauss/api-ref/ALL_META.TXT.json b/docs/opengauss/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..2d4220526 --- /dev/null +++ b/docs/opengauss/api-ref/ALL_META.TXT.json @@ -0,0 +1,302 @@ +[ + { + "uri":"opengauss_api_0001.html", + "product_code":"opengauss", + "code":"1", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Before You Start", + "title":"Before You Start", + "githuburl":"" + }, + { + "uri":"opengauss_api_0002.html", + "product_code":"opengauss", + "code":"2", + "des":"Welcome to GaussDB(openGauss) API Reference. GaussDB(openGauss) is a next-generation, enterprise-class distributed database. It is designed based on the shared-nothing ar", + "doc_type":"api", + "kw":"Overview,Before You Start,API Reference", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"opengauss_api_0003.html", + "product_code":"opengauss", + "code":"3", + "des":"GaussDB(openGauss) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see API Overview.", + "doc_type":"api", + "kw":"API Calling,Before You Start,API Reference", + "title":"API Calling", + "githuburl":"" + }, + { + "uri":"opengauss_api_0004.html", + "product_code":"opengauss", + "code":"4", + "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", + "doc_type":"api", + "kw":"Endpoints,Before You Start,API Reference", + "title":"Endpoints", + "githuburl":"" + }, + { + "uri":"opengauss_api_0005.html", + "product_code":"opengauss", + "code":"5", + "des":"For more constraints, see API description.", + "doc_type":"api", + "kw":"Constraints,Before You Start,API Reference", + "title":"Constraints", + "githuburl":"" + }, + { + "uri":"opengauss_api_0006.html", + "product_code":"opengauss", + "code":"6", + "des":"DomainA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user p", + "doc_type":"api", + "kw":"Concepts,Before You Start,API Reference", + "title":"Concepts", + "githuburl":"" + }, + { + "uri":"opengauss_api_0007.html", + "product_code":"opengauss", + "code":"7", + "des":"GaussDB(openGauss) APIs enable you to use all GaussDB(openGauss) functions, including creating/deleting DB instances and scaling up instance storage space.", + "doc_type":"api", + "kw":"API Overview,API Reference", + "title":"API Overview", + "githuburl":"" + }, + { + "uri":"opengauss_api_0012.html", + "product_code":"opengauss", + "code":"8", + "des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "doc_type":"api", + "kw":"Using APIs,API Reference", + "title":"Using APIs", + "githuburl":"" + }, + { + "uri":"opengauss_api_0013.html", + "product_code":"opengauss", + "code":"9", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API", + "title":"API", + "githuburl":"" + }, + { + "uri":"opengauss_api_0014.html", + "product_code":"opengauss", + "code":"10", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"DB Instance Management", + "title":"DB Instance Management", + "githuburl":"" + }, + { + "uri":"opengauss_api_0015.html", + "product_code":"opengauss", + "code":"11", + "des":"This API is used to create a GaussDB(openGauss) DB instance. GaussDB(openGauss) supports distributed instances.Before calling an API, you need to understand the API in Us", + "doc_type":"api", + "kw":"Creating a DB Instance,DB Instance Management,API Reference", + "title":"Creating a DB Instance", + "githuburl":"" + }, + { + "uri":"opengauss_api_0016.html", + "product_code":"opengauss", + "code":"12", + "des":"This API is used to scale up storage space of a DB instance.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the requir", + "doc_type":"api", + "kw":"Scaling Up Storage Space of a DB Instance,DB Instance Management,API Reference", + "title":"Scaling Up Storage Space of a DB Instance", + "githuburl":"" + }, + { + "uri":"opengauss_api_0017.html", + "product_code":"opengauss", + "code":"13", + "des":"This API is used to delete a DB instance.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and endpo", + "doc_type":"api", + "kw":"Deleting a DB Instance,DB Instance Management,API Reference", + "title":"Deleting a DB Instance", + "githuburl":"" + }, + { + "uri":"opengauss_api_0018.html", + "product_code":"opengauss", + "code":"14", + "des":"This API is used to query DB instances according to search criteria.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain th", + "doc_type":"api", + "kw":"Querying Details About DB Instances,DB Instance Management,API Reference", + "title":"Querying Details About DB Instances", + "githuburl":"" + }, + { + "uri":"opengauss_api_0019.html", + "product_code":"opengauss", + "code":"15", + "des":"This API is used to add CNs.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and endpoint.The CN gr", + "doc_type":"api", + "kw":"Adding CNs,DB Instance Management,API Reference", + "title":"Adding CNs", + "githuburl":"" + }, + { + "uri":"opengauss_api_0020.html", + "product_code":"opengauss", + "code":"16", + "des":"This API is used to add shards.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and endpoint.Interm", + "doc_type":"api", + "kw":"Adding Shards,DB Instance Management,API Reference", + "title":"Adding Shards", + "githuburl":"" + }, + { + "uri":"opengauss_api_0021.html", + "product_code":"opengauss", + "code":"17", + "des":"This API is used to reset a database password.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and ", + "doc_type":"api", + "kw":"Resetting a Database Password,DB Instance Management,API Reference", + "title":"Resetting a Database Password", + "githuburl":"" + }, + { + "uri":"opengauss_api_0022.html", + "product_code":"opengauss", + "code":"18", + "des":"This API is used to change a DB instance name.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and ", + "doc_type":"api", + "kw":"Modifying a DB Instance Name,DB Instance Management,API Reference", + "title":"Modifying a DB Instance Name", + "githuburl":"" + }, + { + "uri":"opengauss_api_0023.html", + "product_code":"opengauss", + "code":"19", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Parameter Configuration", + "title":"Parameter Configuration", + "githuburl":"" + }, + { + "uri":"opengauss_api_0024.html", + "product_code":"opengauss", + "code":"20", + "des":"This API is used to modify parameters in the parameter template of a specified DB instance.Before calling an API, you need to understand the API in Using APIs.Before call", + "doc_type":"api", + "kw":"Modifying Parameters of a Specified DB Instance,Parameter Configuration,API Reference", + "title":"Modifying Parameters of a Specified DB Instance", + "githuburl":"" + }, + { + "uri":"opengauss_api_0025.html", + "product_code":"opengauss", + "code":"21", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Backup Management", + "title":"Backup Management", + "githuburl":"" + }, + { + "uri":"opengauss_api_0026.html", + "product_code":"opengauss", + "code":"22", + "des":"This API is used to set an automated backup policy.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region", + "doc_type":"api", + "kw":"Setting an Automated Backup Policy,Backup Management,API Reference", + "title":"Setting an Automated Backup Policy", + "githuburl":"" + }, + { + "uri":"opengauss_api_0030.html", + "product_code":"opengauss", + "code":"23", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Appendix", + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"opengauss_api_0031.html", + "product_code":"opengauss", + "code":"24", + "des":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_ms", + "doc_type":"api", + "kw":"Abnormal Request Results,Appendix,API Reference", + "title":"Abnormal Request Results", + "githuburl":"" + }, + { + "uri":"opengauss_api_0032.html", + "product_code":"opengauss", + "code":"25", + "des":"Table 1 describes status codes.", + "doc_type":"api", + "kw":"Status Codes,Appendix,API Reference", + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"opengauss_api_0033.html", + "product_code":"opengauss", + "code":"26", + "des":"The following table describes error codes.", + "doc_type":"api", + "kw":"Error Codes,Appendix,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"opengauss_api_0034.html", + "product_code":"opengauss", + "code":"27", + "des":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first.On the My Credential page, view project IDs in the p", + "doc_type":"api", + "kw":"Obtaining a Project ID,Appendix,API Reference", + "title":"Obtaining a Project ID", + "githuburl":"" + }, + { + "uri":"opengauss_api_0036.html", + "product_code":"opengauss", + "code":"28", + "des":"Replication mode table", + "doc_type":"api", + "kw":"Replication Mode Table,Appendix,API Reference", + "title":"Replication Mode Table", + "githuburl":"" + }, + { + "uri":"opengauss_api_0037.html", + "product_code":"opengauss", + "code":"29", + "des":"This section describes the GaussDB(openGauss) DB instance class.", + "doc_type":"api", + "kw":"DB Instance Class,Appendix,API Reference", + "title":"DB Instance Class", + "githuburl":"" + }, + { + "uri":"opengauss_api_0038.html", + "product_code":"opengauss", + "code":"30", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/opengauss/api-ref/CLASS.TXT.json b/docs/opengauss/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..488d31b16 --- /dev/null +++ b/docs/opengauss/api-ref/CLASS.TXT.json @@ -0,0 +1,272 @@ +[ + { + "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":"opengauss", + "title":"Before You Start", + "uri":"opengauss_api_0001.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"Welcome to GaussDB(openGauss) API Reference. GaussDB(openGauss) is a next-generation, enterprise-class distributed database. It is designed based on the shared-nothing ar", + "product_code":"opengauss", + "title":"Overview", + "uri":"opengauss_api_0002.html", + "doc_type":"api", + "p_code":"1", + "code":"2" + }, + { + "desc":"GaussDB(openGauss) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see API Overview.", + "product_code":"opengauss", + "title":"API Calling", + "uri":"opengauss_api_0003.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":"opengauss", + "title":"Endpoints", + "uri":"opengauss_api_0004.html", + "doc_type":"api", + "p_code":"1", + "code":"4" + }, + { + "desc":"For more constraints, see API description.", + "product_code":"opengauss", + "title":"Constraints", + "uri":"opengauss_api_0005.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":"opengauss", + "title":"Concepts", + "uri":"opengauss_api_0006.html", + "doc_type":"api", + "p_code":"1", + "code":"6" + }, + { + "desc":"GaussDB(openGauss) APIs enable you to use all GaussDB(openGauss) functions, including creating/deleting DB instances and scaling up instance storage space.", + "product_code":"opengauss", + "title":"API Overview", + "uri":"opengauss_api_0007.html", + "doc_type":"api", + "p_code":"", + "code":"7" + }, + { + "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "product_code":"opengauss", + "title":"Using APIs", + "uri":"opengauss_api_0012.html", + "doc_type":"api", + "p_code":"", + "code":"8" + }, + { + "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":"opengauss", + "title":"API", + "uri":"opengauss_api_0013.html", + "doc_type":"api", + "p_code":"", + "code":"9" + }, + { + "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":"opengauss", + "title":"DB Instance Management", + "uri":"opengauss_api_0014.html", + "doc_type":"api", + "p_code":"9", + "code":"10" + }, + { + "desc":"This API is used to create a GaussDB(openGauss) DB instance. GaussDB(openGauss) supports distributed instances.Before calling an API, you need to understand the API in Us", + "product_code":"opengauss", + "title":"Creating a DB Instance", + "uri":"opengauss_api_0015.html", + "doc_type":"api", + "p_code":"10", + "code":"11" + }, + { + "desc":"This API is used to scale up storage space of a DB instance.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the requir", + "product_code":"opengauss", + "title":"Scaling Up Storage Space of a DB Instance", + "uri":"opengauss_api_0016.html", + "doc_type":"api", + "p_code":"10", + "code":"12" + }, + { + "desc":"This API is used to delete a DB instance.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and endpo", + "product_code":"opengauss", + "title":"Deleting a DB Instance", + "uri":"opengauss_api_0017.html", + "doc_type":"api", + "p_code":"10", + "code":"13" + }, + { + "desc":"This API is used to query DB instances according to search criteria.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain th", + "product_code":"opengauss", + "title":"Querying Details About DB Instances", + "uri":"opengauss_api_0018.html", + "doc_type":"api", + "p_code":"10", + "code":"14" + }, + { + "desc":"This API is used to add CNs.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and endpoint.The CN gr", + "product_code":"opengauss", + "title":"Adding CNs", + "uri":"opengauss_api_0019.html", + "doc_type":"api", + "p_code":"10", + "code":"15" + }, + { + "desc":"This API is used to add shards.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and endpoint.Interm", + "product_code":"opengauss", + "title":"Adding Shards", + "uri":"opengauss_api_0020.html", + "doc_type":"api", + "p_code":"10", + "code":"16" + }, + { + "desc":"This API is used to reset a database password.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and ", + "product_code":"opengauss", + "title":"Resetting a Database Password", + "uri":"opengauss_api_0021.html", + "doc_type":"api", + "p_code":"10", + "code":"17" + }, + { + "desc":"This API is used to change a DB instance name.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region and ", + "product_code":"opengauss", + "title":"Modifying a DB Instance Name", + "uri":"opengauss_api_0022.html", + "doc_type":"api", + "p_code":"10", + "code":"18" + }, + { + "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":"opengauss", + "title":"Parameter Configuration", + "uri":"opengauss_api_0023.html", + "doc_type":"api", + "p_code":"9", + "code":"19" + }, + { + "desc":"This API is used to modify parameters in the parameter template of a specified DB instance.Before calling an API, you need to understand the API in Using APIs.Before call", + "product_code":"opengauss", + "title":"Modifying Parameters of a Specified DB Instance", + "uri":"opengauss_api_0024.html", + "doc_type":"api", + "p_code":"19", + "code":"20" + }, + { + "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":"opengauss", + "title":"Backup Management", + "uri":"opengauss_api_0025.html", + "doc_type":"api", + "p_code":"9", + "code":"21" + }, + { + "desc":"This API is used to set an automated backup policy.Before calling an API, you need to understand the API in Using APIs.Before calling this API, obtain the required region", + "product_code":"opengauss", + "title":"Setting an Automated Backup Policy", + "uri":"opengauss_api_0026.html", + "doc_type":"api", + "p_code":"21", + "code":"22" + }, + { + "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":"opengauss", + "title":"Appendix", + "uri":"opengauss_api_0030.html", + "doc_type":"api", + "p_code":"", + "code":"23" + }, + { + "desc":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_ms", + "product_code":"opengauss", + "title":"Abnormal Request Results", + "uri":"opengauss_api_0031.html", + "doc_type":"api", + "p_code":"23", + "code":"24" + }, + { + "desc":"Table 1 describes status codes.", + "product_code":"opengauss", + "title":"Status Codes", + "uri":"opengauss_api_0032.html", + "doc_type":"api", + "p_code":"23", + "code":"25" + }, + { + "desc":"The following table describes error codes.", + "product_code":"opengauss", + "title":"Error Codes", + "uri":"opengauss_api_0033.html", + "doc_type":"api", + "p_code":"23", + "code":"26" + }, + { + "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.On the My Credential page, view project IDs in the p", + "product_code":"opengauss", + "title":"Obtaining a Project ID", + "uri":"opengauss_api_0034.html", + "doc_type":"api", + "p_code":"23", + "code":"27" + }, + { + "desc":"Replication mode table", + "product_code":"opengauss", + "title":"Replication Mode Table", + "uri":"opengauss_api_0036.html", + "doc_type":"api", + "p_code":"23", + "code":"28" + }, + { + "desc":"This section describes the GaussDB(openGauss) DB instance class.", + "product_code":"opengauss", + "title":"DB Instance Class", + "uri":"opengauss_api_0037.html", + "doc_type":"api", + "p_code":"23", + "code":"29" + }, + { + "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":"opengauss", + "title":"Change History", + "uri":"opengauss_api_0038.html", + "doc_type":"api", + "p_code":"", + "code":"30" + } +] \ No newline at end of file diff --git a/docs/opengauss/api-ref/PARAMETERS.txt b/docs/opengauss/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/opengauss/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/opengauss/api-ref/en-us_image_0000001072599100.jpg b/docs/opengauss/api-ref/en-us_image_0000001072599100.jpg new file mode 100644 index 000000000..9a3a0c8d8 Binary files /dev/null and b/docs/opengauss/api-ref/en-us_image_0000001072599100.jpg differ diff --git a/docs/opengauss/api-ref/en-us_image_0000001072791022.gif b/docs/opengauss/api-ref/en-us_image_0000001072791022.gif new file mode 100644 index 000000000..493d44822 Binary files /dev/null and b/docs/opengauss/api-ref/en-us_image_0000001072791022.gif differ diff --git a/docs/opengauss/api-ref/opengauss_api_0001.html b/docs/opengauss/api-ref/opengauss_api_0001.html new file mode 100644 index 000000000..551120317 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0001.html @@ -0,0 +1,19 @@ + + +

Before You Start

+
+
+ +
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0002.html b/docs/opengauss/api-ref/opengauss_api_0002.html new file mode 100644 index 000000000..a586e2010 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0002.html @@ -0,0 +1,12 @@ + + +

Overview

+

Welcome to GaussDB(openGauss) API Reference. GaussDB(openGauss) is a next-generation, enterprise-class distributed database. It is designed based on the shared-nothing architecture and supports both x86 and Kunpeng CPU architectures. It features the following: high-throughput, strong-consistency transaction processing capabilities, financial-grade HA with 3DC geo-redundant DR, high scalability with a distributed architecture, and high-performance big data query capabilities. GaussDB(openGauss) is suitable for core systems used in a wide range of sectors, such as finance, telecom, and government.

+

This document describes how to use application programming interfaces (APIs) to perform operations on DB instances, such as DB instance creation, deletion, query, parameter modifications, and scaling. For details about all supported operations, see API Overview.

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

API Calling

+

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

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0004.html b/docs/opengauss/api-ref/opengauss_api_0004.html new file mode 100644 index 000000000..b9be4bc23 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0004.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/opengauss/api-ref/opengauss_api_0005.html b/docs/opengauss/api-ref/opengauss_api_0005.html new file mode 100644 index 000000000..e073420bc --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0005.html @@ -0,0 +1,11 @@ + + +

Constraints

+
+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0006.html b/docs/opengauss/api-ref/opengauss_api_0006.html new file mode 100644 index 000000000..731320d3b --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0006.html @@ -0,0 +1,19 @@ + + +

Concepts

+
+ +
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0007.html b/docs/opengauss/api-ref/opengauss_api_0007.html new file mode 100644 index 000000000..5ec1093c8 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0007.html @@ -0,0 +1,35 @@ + + +

API Overview

+

GaussDB(openGauss) APIs enable you to use all GaussDB(openGauss) functions, including creating/deleting DB instances and scaling up instance storage space.

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

Type

+

Subtype

+

Description

+

GaussDB(openGauss) APIs

+

DB Instance Management

+

Manage DB instances, including creating a DB instance, scaling up instance storage space, delete a DB instance, obtaining a DB instance list, obtaining a specified DB instance, adding Coordinator Nodes (CNs), adding shards, resetting a database password, and change a DB instance name.

+

Parameter Configuration

+

Modify parameters of a specified DB instance.

+

Backup Management

+

Set an automated backup policy.

+
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0012.html b/docs/opengauss/api-ref/opengauss_api_0012.html new file mode 100644 index 000000000..2174df77b --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0012.html @@ -0,0 +1,9 @@ + + +

Using APIs

+

Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0013.html b/docs/opengauss/api-ref/opengauss_api_0013.html new file mode 100644 index 000000000..7c20724a4 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0013.html @@ -0,0 +1,15 @@ + + +

API

+
+
+ +
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0014.html b/docs/opengauss/api-ref/opengauss_api_0014.html new file mode 100644 index 000000000..e1ba8ac70 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0014.html @@ -0,0 +1,29 @@ + + +

DB Instance Management

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0015.html b/docs/opengauss/api-ref/opengauss_api_0015.html new file mode 100644 index 000000000..10dd9b430 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0015.html @@ -0,0 +1,774 @@ + + +

Creating a DB Instance

+

Function

This API is used to create a GaussDB(openGauss) DB instance. GaussDB(openGauss) supports distributed instances.

+ +
+

URI

+
+

Request

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Parameter description (for distributed instance creation)

Name

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Specifies the DB instance name.

+

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

+

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

+

datastore

+

Yes

+

Object

+

Specifies the database information.

+

For details, see Table 3.

+

ha

+

Yes

+

Object

+

Used to create a distributed instance. For details, see Table 4.

+

configuration_id

+

No

+

String

+

Specifies the parameter template ID. If this parameter is not specified, the default parameter template is used.

+

port

+

No

+

String

+

Specifies the database port.

+

The GaussDB(openGauss) database port ranges from 1024 to 39998 (excluding the following which are occupied by the system and cannot be used: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 12016, 12017, 20049, 20050, 21731, 21732, 32122, 32123, and 32124).

+

If this parameter is not specified, the default port 8000 is used.

+

password

+

Yes

+

String

+

Specifies the database password.

+

The password cannot be empty and must contain 8 to 32 characters, including at least three 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.

+

backup_strategy

+

No

+

Object

+

Specifies the backup policy.

+

For details, see Table 5.

+

flavor_ref

+

Yes

+

String

+

Specifies the specification code. The value cannot be empty. For details on how to obtain the GaussDB(openGauss) specification code, see Table 1.

+

volume

+

Yes

+

Object

+

Specifies the volume information.

+

For details, see Table 6.

+

region

+

Yes

+

String

+

Specifies the region ID.

+

The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.

+

availability_zone

+

Yes

+

String

+

Specifies the AZ ID.

+

The value cannot be empty. You can deploy GaussDB(openGauss) in the same AZ or across three different AZs, and use commas (,) to separate AZs. For example:

+
  • To deploy GaussDB(openGauss) in the same AZ, enter three same AZ IDs.
  • To deploy GaussDB(openGauss) across three different AZs, enter three different AZ IDs.
+

The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.

+

vpc_id

+

Yes

+

String

+

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

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

subnet_id

+

Yes

+

String

+

Specifies the network ID. To obtain this parameter value, use either of the following methods:

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

security_group_id

+

No

+

String

+

Specifies the security group which the DB instance belongs to. To obtain this parameter value, use either of the following methods:

+
  • 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 the "Querying Security Groups" section in the Virtual Private Cloud API Reference.
+

charge_info

+

No

+

Object

+

Specifies the billing type, which is only pay-per-use.

+

For details, see Table 7.

+

sharding_num

+

Yes

+

Integer

+

Specifies the number of shards. The value ranges from 1 to 9.

+

coordinator_num

+

Yes

+

Integer

+

Specifies the number of CNs. The value ranges from 1 to 9. The number of CNs must be less than or equal to twice the number of shards.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 datastore field data structure description

Name

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

Specifies the DB engine. Value:

+

GaussDB(openGauss).

+

version

+

Yes

+

String

+

Specifies the database version.

+

The following versions are supported:

+
  • 1.1
  • 1.2
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 ha field data structure description

Name

+

Mandatory

+

Type

+

Description

+

mode

+

Yes

+

String

+

Specifies the distributed mode of GaussDB(openGauss). The value is enterprise and is case insensitive.

+

replication_mode

+

Yes

+

String

+

Specifies the replication mode for the standby node.

+

Value:

+

For GaussDB(openGauss), the value is sync.

+
NOTE:
  • sync indicates the synchronous replication mode.
+
+

consistency

+

Yes

+

String

+

Specifies the instance consistency type. The value can be strong or eventual and is case-insensitive.

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

Name

+

Mandatory

+

Type

+

Description

+

start_time

+

Yes

+

String

+

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

+

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

+
  • The HH value must be 1 greater than the hh value.
  • The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45.
+

Example value:

+
  • 08:15-09:15
  • 23:00-00:00
+

keep_days

+

No

+

Integer

+

Specifies the retention days for specific backup files.

+

The value ranges from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 volume field data structure description

Name

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

Specifies the volume type.

+

The value can only be ULTRAHIGH (case-sensitive), indicating SSD.

+

size

+

Yes

+

Integer

+

Specifies the volume size.

+

The value must be a multiple of the number of shards multiplied by 40 GB, ranging from the number of shards multiplied by 40 GB to the number of shards multiplied by 16 TB.

+
+
+ +
+ + + + + + + + + + + +
Table 7 chargeInfo field data structure description

Name

+

Mandatory

+

Type

+

Description

+

charge_mode

+

Yes

+

String

+

Specifies the billing mode. The value can only be postPaid, indicating the pay-per-use billing mode.

+
+
+ +
+
Creating a DB instance of the enterprise edition:
+{
+    "name": "user1-v3-independent", 
+    "datastore": {
+        "type": "GaussDB(openGauss)", 
+        "version": "1.1"
+    }, 
+    "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", 
+    "volume": {
+        "type": "ULTRAHIGH", 
+        "size": 120
+    },
+    "region": "eu-de",
+     "availability_zone": "eu-de-01,eu-de-01,eu-de-01",
+    "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", 
+    "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", 
+    "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", 
+    "backup_strategy": {
+        "start_time": "17:00-18:00", 
+        "keep_days": 7
+    }, 
+    "charge_info": {
+        "charge_mode": "postPaid"
+    }, 
+    "password": "Gauss_234", 
+    "configuration_id": "b000d7c91f1749da87315700793a11d4pr14", 
+    "time_zone": "UTC+08:00",
+    "ha":{
+        "mode":"enterprise",
+        "consistency":"strong",
+        "replication_mode":"sync"
+    },
+    "sharding_num":1,
+    "coordinator_num":1,
+    "port":8000
+}
+

Response

+ +
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0016.html b/docs/opengauss/api-ref/opengauss_api_0016.html new file mode 100644 index 000000000..ef9a2ea33 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0016.html @@ -0,0 +1,131 @@ + + +

Scaling Up Storage Space of a DB Instance

+

Function

This API is used to scale up storage space of a DB instance.

+ +
+

Constraints

+
+

URI

+
+

Request

+
+ +

Response

+
+ +

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0017.html b/docs/opengauss/api-ref/opengauss_api_0017.html new file mode 100644 index 000000000..11f8ab6ac --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0017.html @@ -0,0 +1,75 @@ + + +

Deleting a DB Instance

+

Function

This API is used to delete a DB instance.

+ +
+

URI

+
+

Request

None

+
+

Response

+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0018.html b/docs/opengauss/api-ref/opengauss_api_0018.html new file mode 100644 index 000000000..699046fe7 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0018.html @@ -0,0 +1,1309 @@ + + +

Querying Details About DB Instances

+

Function

This API is used to query DB instances according to search criteria.

+ +
+

URI

+
+

Request

None

+
+

Response

+ +
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0019.html b/docs/opengauss/api-ref/opengauss_api_0019.html new file mode 100644 index 000000000..dc53b5aea --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0019.html @@ -0,0 +1,172 @@ + + +

Adding CNs

+

Function

This API is used to add CNs.

+ +
+

Constraints

+
+

URI

+
+

Request

+ +
+

Response

+
+ +

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0020.html b/docs/opengauss/api-ref/opengauss_api_0020.html new file mode 100644 index 000000000..c0effb54a --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0020.html @@ -0,0 +1,130 @@ + + +

Adding Shards

+

Function

This API is used to add shards.

+ +

Intermittent disconnection occurs when shards are being added. Exercise caution when performing this operation.

+
+
+

Constraints

+
+

URI

+
+
+
+

Response

+
+ +

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0021.html b/docs/opengauss/api-ref/opengauss_api_0021.html new file mode 100644 index 000000000..3192ce519 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0021.html @@ -0,0 +1,85 @@ + + +

Resetting a Database Password

+

Function

This API is used to reset a database password.

+ +
+

URI

+
+

Request

+
+ +

Response

+
+ +

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0022.html b/docs/opengauss/api-ref/opengauss_api_0022.html new file mode 100644 index 000000000..9d101c39b --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0022.html @@ -0,0 +1,105 @@ + + +

Modifying a DB Instance Name

+

Function

This API is used to change a DB instance name.

+ +
+

URI

+
+

Request

+
+ +

Response

+
+ +

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0023.html b/docs/opengauss/api-ref/opengauss_api_0023.html new file mode 100644 index 000000000..30fa6bff4 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0023.html @@ -0,0 +1,15 @@ + + +

Parameter Configuration

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0024.html b/docs/opengauss/api-ref/opengauss_api_0024.html new file mode 100644 index 000000000..8414d36f9 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0024.html @@ -0,0 +1,140 @@ + + +

Modifying Parameters of a Specified DB Instance

+

Function

This API is used to modify parameters in the parameter template of a specified DB instance.

+ +
+

Constraints

+
+

URI

+
+

Request

+ +
+

Response

+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Configuration
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0025.html b/docs/opengauss/api-ref/opengauss_api_0025.html new file mode 100644 index 000000000..cd031bf94 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0025.html @@ -0,0 +1,19 @@ + + + +

Backup Management

+ +

+
+ +
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0026.html b/docs/opengauss/api-ref/opengauss_api_0026.html new file mode 100644 index 000000000..2ed90a7f1 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0026.html @@ -0,0 +1,148 @@ + + +

Setting an Automated Backup Policy

+

Function

This API is used to set an automated backup policy.

+ +
+

URI

+
+

Request

+
+ +

Response

+
+ +

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0030.html b/docs/opengauss/api-ref/opengauss_api_0030.html new file mode 100644 index 000000000..3ebf4be04 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0030.html @@ -0,0 +1,21 @@ + + +

Appendix

+
+
+ +
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0031.html b/docs/opengauss/api-ref/opengauss_api_0031.html new file mode 100644 index 000000000..6692aef50 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0031.html @@ -0,0 +1,42 @@ + + +

Abnormal Request Results

+
Abnormal response description +
+ + + + + + + + + + + + + +
Table 1 Abnormal response description

Name

+

Type

+

Description

+

error_code

+

String

+

Specifies the error returned when a task submission exception occurs.

+

error_msg

+

String

+

Specifies the description of the error returned when a task submission exception occurs.

+
+
+
+
Response example
{
+    "error_code": "DBS.200022",
+    "error_msg": "The DB instance name already exists."
+}
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0032.html b/docs/opengauss/api-ref/opengauss_api_0032.html new file mode 100644 index 000000000..2dd4e05d6 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0032.html @@ -0,0 +1,328 @@ + + +

Status Codes

+

Table 1 describes status codes.

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

Status Code

+

Message

+

Description

+

100

+

Continue

+

The client should continue with its request.

+

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

+

101

+

Switching Protocols

+

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

+

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

+

200

+

OK

+

Request succeeded.

+

201

+

Created

+

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

+

202

+

Accepted

+

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

+

203

+

Non-Authoritative Information

+

Unauthorized information. The request is successful.

+

204

+

NoContent

+

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

+

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

+

205

+

Reset Content

+

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

+

206

+

Partial Content

+

The server has processed certain GET requests.

+

300

+

Multiple Choices

+

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

+

301

+

Moved Permanently

+

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

+

302

+

Found

+

The requested resource was temporarily moved.

+

303

+

See Other

+

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

+

304

+

Not Modified

+

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

+

305

+

Use Proxy

+

The requested resource must be accessed through a proxy.

+

306

+

Unused

+

The HTTP status code is no longer used.

+

400

+

BadRequest

+

Invalid request.

+

The client should not repeat the request without modifications.

+

401

+

Unauthorized

+

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

+

402

+

Payment Required

+

This status code is reserved for future use.

+

403

+

Forbidden

+

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

+

The client should not repeat the request without modifications.

+

404

+

NotFound

+

The requested resource cannot be found.

+

The client should not repeat the request without modifications.

+

405

+

MethodNotAllowed

+

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

+

The client should not repeat the request without modifications.

+

406

+

Not Acceptable

+

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

+

407

+

Proxy Authentication Required

+

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

+

408

+

Request Time-out

+

The server timed out waiting for the request.

+

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

+

409

+

Conflict

+

The request could not be processed due to a conflict.

+

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

+

410

+

Gone

+

The requested resource is no longer available.

+

The requested resource has been deleted permanently.

+

411

+

Length Required

+

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

+

412

+

Precondition Failed

+

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

+

413

+

Request Entity Too Large

+

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

+

414

+

Request-URI Too Large

+

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

+

415

+

Unsupported Media Type

+

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

+

416

+

Requested range not satisfied

+

The requested range is invalid.

+

417

+

Expectation Failed

+

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

+

422

+

UnprocessableEntity

+

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

+

429

+

TooManyRequests

+

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

+

500

+

InternalServerError

+

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

+

501

+

Not Implemented

+

The server does not support the requested function.

+

502

+

Bad Gateway

+

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

+

503

+

ServiceUnavailable

+

The requested service is invalid.

+

The client should not repeat the request without modifications.

+

504

+

ServerTimeout

+

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

+

505

+

HTTP Version not supported

+

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

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0033.html b/docs/opengauss/api-ref/opengauss_api_0033.html new file mode 100644 index 000000000..d4c3f149b --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0033.html @@ -0,0 +1,968 @@ + + +

Error Codes

+

The following table describes error codes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 V3 error codes

Error Code

+

Response Code

+

Description

+

DBS.108000

+

500

+

Server failure.

+

DBS.108002

+

500

+

Server failure.

+

DBS.108005

+

500

+

Server failure.

+

DBS.200001

+

400

+

Parameter error.

+

DBS.200002

+

404

+

The DB instance does not exist.

+

DBS.200004

+

400

+

Parameter error.

+

DBS.200005

+

500

+

Server failure.

+

DBS.200006

+

400

+

The request is null. Enter a request parameter.

+

DBS.200008

+

404

+

The ECS information of the DB instance cannot be found.

+

DBS.200010

+

403

+

The DB instance ID or user ID may be null, or the operation is not authorized.

+

DBS.200011

+

409

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

DBS.200013

+

404

+

The original DB instance does not exist.

+

DBS.200019

+

409

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

DBS.200021

+

400

+

Invalid DB instance name.

+

DBS.200022

+

409

+

The DB instance name already exists.

+

DBS.200023

+

400

+

Storage space is out of range.

+

DBS.200024

+

400

+

Invalid region.

+

DBS.200025

+

400

+

Invalid AZ.

+

DBS.200026

+

400

+

Invalid storage type.

+

DBS.200027

+

400

+

Storage space must be a multiple of 10.

+

DBS.200040

+

400

+

The DB engine or version is not supported.

+

DBS.200041

+

400

+

Invalid database version.

+

DBS.200042

+

400

+

The DB engine does not exist.

+

DBS.200043

+

400

+

Invalid synchronize model.

+

DBS.200044

+

403

+

Resource not found or permission denied.

+

DBS.200045

+

404

+

The DB instance does not exist.

+

DBS.200046

+

413

+

The number of DB instances has reached the quota.

+

DBS.200047

+

409

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

DBS.200048

+

400

+

Invalid VPC ID.

+

DBS.200049

+

400

+

Invalid network ID.

+

DBS.200050

+

404

+

The security group does not exist or does not belong to the VPC.

+

DBS.200051

+

400

+

Invalid HA mode.

+

DBS.200052

+

400

+

Invalid database root password.

+

DBS.200053

+

400

+

The selected specifications do not exist.

+

DBS.200054

+

400

+

Invalid specifications.

+

DBS.200055

+

400

+

Invalid replica_of_id.

+

DBS.200056

+

400

+

The maximum number of nodes has been reached.

+

DBS.200086

+

400

+

This operation is not allowed by the DB instance status.

+

DBS.200087

+

400

+

The number of tags added for the DB instance has reached the quota.

+

DBS.200098

+

400

+

The tag already exists.

+

DBS.200203

+

400

+

Failed to query the DB instance.

+

DBS.200303

+

400

+

The scale-up times have reached the maximum value.

+

DBS.200306

+

400

+

The new storage space must be greater than or equal to the original storage space.

+

DBS.200308

+

400

+

The new storage space after scaling up cannot be greater than that of the primary DB instance.

+

DBS.200316

+

409

+

This operation cannot be performed because the DB instance status is Storage full.

+

DBS.200402

+

409

+

Invalid operation.

+

DBS.200405

+

400

+

Parameter error.

+

DBS.200408

+

404

+

The DB instance does not exist.

+

DBS.200461

+

400

+

The parameter value is out of range.

+

DBS.200470

+

404

+

The region or AZ does not exist.

+

DBS.200501

+

404

+

The subnet does not exist or does not belong to the VPC.

+

DBS.200503

+

404

+

The VPC does not exist or does not belong to the user.

+

DBS.200504

+

400

+

Invalid database version.

+

DBS.200506

+

400

+

Invalid KMS.

+

DBS.200543

+

400

+

The job does not exist.

+

DBS.200602

+

404

+

The DB instance does not exist.

+

DBS.200604

+

403

+

The DB instance ID or user ID may be null, or the operation is not authorized.

+

DBS.200811

+

500

+

Failed to create the database.

+

DBS.201003

+

403

+

Resource not found or permission denied.

+

DBS.201010

+

404

+

The backup information does not exist.

+

DBS.201014

+

400

+

This operation is not allowed by the DB instance status.

+

DBS.201028

+

404

+

The DB instance does not exist.

+

DBS.201035

+

400

+

The database name must be different from the original and target database names.

+

DBS.201101

+

400

+

Invalid backup cycle.

+

DBS.201103

+

400

+

Invalid backup start time.

+

DBS.201106

+

400

+

Invalid retention days.

+

DBS.201201

+

409

+

The object already exists.

+

DBS.201202

+

409

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

DBS.201203

+

400

+

The backup file does not exist.

+

DBS.201205

+

409

+

Backup is in progress, please wait.

+

DBS.201207

+

400

+

The DB engine or version is not supported.

+

DBS.212001

+

404

+

The parameter template does not exist.

+

DBS.212002

+

400

+

Incorrect parameter template quota.

+

DBS.212003

+

400

+

Operation not allowed.

+

DBS.212004

+

400

+

Parameter template update error.

+

DBS.212005

+

400

+

The node does not belong to the group.

+

DBS.212006

+

409

+

Another operation is being performed on the DB instance or the DB instance is faulty.

+

DBS.212007

+

400

+

The DB engine does not exist.

+

DBS.212008

+

400

+

The DB engine is not supported.

+

DBS.212009

+

400

+

Task processing failed.

+

DBS.212010

+

400

+

The parameter template is being applied.

+

DBS.212011

+

400

+

Application failed.

+

DBS.212012

+

400

+

The parameter does not exist.

+

DBS.212013

+

404

+

The object does not exist.

+

DBS.212014

+

400

+

The node does not have a default parameter template.

+

DBS.212015

+

400

+

Partial success

+

DBS.212016

+

400

+

Parameter update failed.

+

DBS.212017

+

400

+

Invalid parameter.

+

DBS.212019

+

422

+

The parameter cannot be processed.

+

DBS.212025

+

400

+

Update failed.

+

DBS.212030

+

400

+

Parameter error

+

DBS.212032

+

400

+

The parameter template has been applied.

+

DBS.212037

+

400

+

Parameters are incorrectly set.

+

DBS.213004

+

500

+

Failed to process the request.

+

DBS.216028

+

400

+

Insufficient internal resource quota.

+

DBS.280001

+

400

+

Parameter error.

+

DBS.280015

+

403

+

Resource not found or permission denied.

+

DBS.280056

+

403

+

Invalid token.

+

DBS.280127

+

400

+

Invalid backup description.

+

DBS.280128

+

400

+

The database name does not exist.

+

DBS.280204

+

400

+

Invalid parameter.

+

DBS.280214

+

400

+

The backup does not exist.

+

DBS.280235

+

400

+

Invalid database type.

+

DBS.280236

+

400

+

Invalid database version.

+

DBS.280238

+

400

+

The DB engine or version is not supported.

+

DBS.280239

+

400

+

Invalid specifications.

+

DBS.280241

+

400

+

Invalid storage type.

+

DBS.280246

+

400

+

Invalid database root password.

+

DBS.280250

+

400

+

Invalid backup retention days.

+

DBS.280253

+

400

+

Invalid backup start time.

+

DBS.280270

+

400

+

The parameter does not exist.

+

DBS.280271

+

400

+

The parameter value is out of range.

+

DBS.280272

+

400

+

The tag key must be unique.

+

DBS.280277

+

400

+

Invalid object name.

+

DBS.280285

+

400

+

Invalid AZ.

+

DBS.280404

+

400

+

Invalid DB instance ID or node ID format.

+

DBS.280449

+

400

+

Operation not allowed on frozen objects.

+

DBS.280450

+

400

+

The DB instance specifications are sold out.

+

DBS.290000

+

400

+

Parameter error.

+

DBS.290001

+

400

+

Invalid parameter letter case.

+

DBS.290002

+

404

+

The selected specifications do not exist.

+

DBS.290003

+

413

+

The number of DB instances has reached the quota.

+

DBS.290005

+

404

+

The DB instance does not exist.

+

DBS.290006

+

500

+

Failed to process the request.

+

DBS.290011

+

404

+

The DB instance does not exist.

+

DBS.290013

+

404

+

Resource not found.

+

DBS.290015

+

500

+

Failed to process the request.

+

DBS.280618

+

400

+

Differential backup cycle invalid.

+

DBS.200475

+

400

+

New password should not equal to the old ones.

+

DBS.280234

+

400

+

Invalid DB instance name.

+

DBS.280006

+

400

+

The request is null. Enter a request parameter.

+

DBS.280203

+

400

+

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

+

DBS.200068

+

400

+

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

+

DBS.212033

+

403

+

The parameter template values cannot be changed because the DB instance is being operated.

+

DBS.280433

+

400

+

Invalid enterprise project ID.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0034.html b/docs/opengauss/api-ref/opengauss_api_0034.html new file mode 100644 index 000000000..3abcc4b45 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0034.html @@ -0,0 +1,16 @@ + + +

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.

+
+

Obtaining 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 Credential in the displayed drop-down list.

    On the My Credential page, view project IDs in the project list.

    +
    Figure 1 Viewing project IDs
    +

+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0036.html b/docs/opengauss/api-ref/opengauss_api_0036.html new file mode 100644 index 000000000..26d8a59e3 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0036.html @@ -0,0 +1,30 @@ + + +

Replication Mode Table

+

Replication mode table

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

Replication Mode

+

Description

+

Remarks

+

sync

+

Synchronous

+

N/A

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0037.html b/docs/opengauss/api-ref/opengauss_api_0037.html new file mode 100644 index 000000000..b65aad40e --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0037.html @@ -0,0 +1,59 @@ + + +

DB Instance Class

+

This section describes the GaussDB(openGauss) DB instance class.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 DB instance class

Instance Class

+

DB Engine

+

Spec Code

+

vCPUs

+

Memory (GB)

+

General-enhanced II

+

GaussDB(openGauss)

+

gaussdb.opengauss.ee.dn.m6.2xlarge.8.in

+

8

+

64

+

gaussdb.opengauss.ee.dn.m6.4xlarge.8.in

+

16

+

128

+

gaussdb.opengauss.ee.dn.m6.8xlarge.8.in

+

32

+

256

+

gaussdb.opengauss.ee.dn.m6.16xlarge.8.in

+

64

+

521

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/opengauss/api-ref/opengauss_api_0038.html b/docs/opengauss/api-ref/opengauss_api_0038.html new file mode 100644 index 000000000..702d2e9d5 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0038.html @@ -0,0 +1,20 @@ + + +

Change History

+
+
+ + + + + + + +

Released Date

+

Description

+

2020-11-30

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/opengauss/api-ref/public_sys-resources/ExpandCollapse.js b/docs/opengauss/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 000000000..116ddaabf --- /dev/null +++ b/docs/opengauss/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/opengauss/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/opengauss/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 000000000..60f607621 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/opengauss/api-ref/public_sys-resources/commonltr.css b/docs/opengauss/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 000000000..c5480b0ab --- /dev/null +++ b/docs/opengauss/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/opengauss/api-ref/public_sys-resources/commonltr_print.css b/docs/opengauss/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 000000000..a59823141 --- /dev/null +++ b/docs/opengauss/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/opengauss/api-ref/public_sys-resources/commonrtl.css b/docs/opengauss/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 000000000..f261da752 --- /dev/null +++ b/docs/opengauss/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/opengauss/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/opengauss/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 000000000..47a9c7235 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/opengauss/api-ref/public_sys-resources/delta.gif b/docs/opengauss/api-ref/public_sys-resources/delta.gif new file mode 100644 index 000000000..0d1b1f674 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/deltaend.gif b/docs/opengauss/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 000000000..cc7da0fc8 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/opengauss/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 000000000..84eec9be2 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/opengauss/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 000000000..39583d168 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/icon-caution.gif b/docs/opengauss/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/icon-danger.gif b/docs/opengauss/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/icon-huawei.gif b/docs/opengauss/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 000000000..a31d60f89 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/icon-note.gif b/docs/opengauss/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 000000000..31be2b039 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/icon-notice.gif b/docs/opengauss/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 000000000..409070650 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/icon-tip.gif b/docs/opengauss/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 000000000..c47bae05c Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/icon-warning.gif b/docs/opengauss/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/opengauss/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/opengauss/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 000000000..57a0e1f53 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/opengauss/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/opengauss/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 000000000..fa4b64990 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/opengauss/api-ref/public_sys-resources/popup.js b/docs/opengauss/api-ref/public_sys-resources/popup.js new file mode 100644 index 000000000..a550862ed --- /dev/null +++ b/docs/opengauss/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/opengauss/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/opengauss/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 000000000..def5c3565 Binary files /dev/null and b/docs/opengauss/api-ref/public_sys-resources/warning_3.0-en-us.png differ