dadrobna/gaussdb-mysql
1
0
Fork 0
forked from docs/gaussdb-mysql
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2022-11-23 02:23:55 +00:00
parent 427027d148
commit d01f123ec6
34 changed files with 551 additions and 548 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
api-ref/source/_static/images/en-us_image_0264049300.png → api-ref/source/_static/images/en-us_image_0000001372529646.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

0
api-ref/source/_static/images/en-us_image_0264049268.gif → api-ref/source/_static/images/en-us_image_0000001422968749.gif
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 51 KiB

0
api-ref/source/_static/images/en-us_image_0264049266.jpg → api-ref/source/_static/images/en-us_image_0000001423128721.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 136 KiB

After

Width:  |  Height:  |  Size: 136 KiB

16
api-ref/source/api/index.rst
View File

@ -1,16 +1,16 @@
:original_name: rds_09_0000.html :original_name: gaussdb_04_0000.html
.. _rds_09_0000: .. _gaussdb_04_0000:
API API
=== ===
- :ref:`Querying Version Information About a DB Engine <en-us_topic_0264049311>` - :ref:`Querying Version Information About a DB Engine <gaussdb_04_0001>`
- :ref:`Querying Database Specifications <en-us_topic_0264049275>` - :ref:`Querying Database Specifications <gaussdb_04_0002>`
- :ref:`Managing DB Instances <en-us_topic_0264049294>` - :ref:`Managing DB Instances <gaussdb_04_0003>`
- :ref:`Managing Parameter Templates <en-us_topic_0264049297>` - :ref:`Managing Parameter Templates <gaussdb_04_0008>`
- :ref:`Managing Quotas <en-us_topic_0264049309>` - :ref:`Managing Quotas <gaussdb_04_0010>`
- :ref:`Obtaining Task Information <en-us_topic_0264049301>` - :ref:`Obtaining Task Information <gaussdb_04_0014>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

68
api-ref/source/api/managing_db_instances/creating_a_db_instance.rst
View File

File diff suppressed because it is too large Load Diff

20
api-ref/source/api/managing_db_instances/deleting_a_db_instance.rst
View File

@ -1,6 +1,6 @@
:original_name: en-us_topic_0264049269.html :original_name: gaussdb_04_0007.html
.. _en-us_topic_0264049269: .. _gaussdb_04_0007:
Deleting a DB Instance Deleting a DB Instance
====================== ======================
@ -10,7 +10,7 @@ Function
This API is used to delete a DB instance. This API is used to delete a DB instance.
- Learn how to :ref:`authorize and authenticate <rds_03_0001>` this API before using it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` this API before using it.
- Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
URI URI
@ -28,15 +28,15 @@ URI
.. table:: **Table 1** Parameter description .. table:: **Table 1** Parameter description
+-----------------------+-----------------------+------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------+
| Name | Mandatory | Description | | Name | Mandatory | Description |
+=======================+=======================+========================================================================+ +=======================+=======================+============================================================================+
| project_id | Yes | Project ID of a tenant in a region. | | project_id | Yes | Project ID of a tenant in a region. |
| | | | | | | |
| | | To obtain this value, see :ref:`Obtaining a Project ID <rds_03_0002>`. | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------------+-----------------------+------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------+
| instance_id | Yes | DB instance ID, which is compliant with the UUID format. | | instance_id | Yes | DB instance ID, which is compliant with the UUID format. |
+-----------------------+-----------------------+------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------+
Request Request
------- -------
@ -67,9 +67,9 @@ Response
Status Code Status Code
----------- -----------
For details, see :ref:`Status Codes <rds_10_0200>`. For details, see :ref:`Status Codes <gaussdb_10_0002>`.
Error Code Error Code
---------- ----------
For details, see :ref:`Error Codes <rds_10_0201>`. For details, see :ref:`Error Codes <gaussdb_10_0003>`.

12
api-ref/source/api/managing_db_instances/index.rst
View File

@ -1,14 +1,14 @@
:original_name: en-us_topic_0264049294.html :original_name: gaussdb_04_0003.html
.. _en-us_topic_0264049294: .. _gaussdb_04_0003:
Managing DB Instances Managing DB Instances
===================== =====================
- :ref:`Creating a DB instance <en-us_topic_0264049265>` - :ref:`Creating a DB instance <gaussdb_04_0004>`
- :ref:`Querying a DB Instance List <en-us_topic_0264049278>` - :ref:`Querying a DB Instance List <gaussdb_04_0005>`
- :ref:`Querying Details of a DB Instance <en-us_topic_0264049244>` - :ref:`Querying Details of a DB Instance <gaussdb_04_0006>`
- :ref:`Deleting a DB Instance <en-us_topic_0264049269>` - :ref:`Deleting a DB Instance <gaussdb_04_0007>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

86
api-ref/source/api/managing_db_instances/querying_a_db_instance_list.rst
View File

File diff suppressed because it is too large Load Diff

100
api-ref/source/api/managing_db_instances/querying_details_of_a_db_instance.rst
View File

File diff suppressed because it is too large Load Diff

6
api-ref/source/api/managing_parameter_templates/index.rst
View File

@ -1,11 +1,11 @@
:original_name: en-us_topic_0264049297.html :original_name: gaussdb_04_0008.html
.. _en-us_topic_0264049297: .. _gaussdb_04_0008:
Managing Parameter Templates Managing Parameter Templates
============================ ============================
- :ref:`Querying a Parameter Template <en-us_topic_0264049285>` - :ref:`Querying a Parameter Template <gaussdb_04_0009>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

54
api-ref/source/api/managing_parameter_templates/querying_a_parameter_template.rst
View File

File diff suppressed because it is too large Load Diff

34
api-ref/source/api/managing_quotas/configuring_resource_quotas.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_06_0002.html :original_name: gaussdb_04_0012.html
.. _rds_06_0002: .. _gaussdb_04_0012:
Configuring Resource Quotas Configuring Resource Quotas
=========================== ===========================
@ -10,7 +10,7 @@ Function
This API is used to set resource quotas for a specified enterprise project. This API is used to set resource quotas for a specified enterprise project.
- Learn how to :ref:`authorize and authenticate <rds_03_0001>` this API before using it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` this API before using it.
- Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
URI URI
@ -28,24 +28,24 @@ URI
.. table:: **Table 1** Parameter description .. table:: **Table 1** Parameter description
+-----------------------+-----------------------+---------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------+
| Name | Mandatory | Description | | Name | Mandatory | Description |
+=======================+=======================+===========================================================================+ +=======================+=======================+============================================================================+
| project_id | Yes | Project ID of a tenant in a region. | | project_id | Yes | Project ID of a tenant in a region. |
| | | | | | | |
| | | To obtain this value, see :ref:`Obtaining a Project ID <rds_03_0002>`. | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------------+-----------------------+---------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------+
| quota_list | Yes | Quota details. A maximum of 10 quota records can be configured at a time. | | quota_list | Yes | Quota details. A maximum of 10 quota records can be configured at a time. |
| | | | | | | |
| | | For details, see :ref:`Table 2 <rds_06_0002__table1453814912427>`. | | | | For details, see :ref:`Table 2 <gaussdb_04_0012__table1453814912427>`. |
+-----------------------+-----------------------+---------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------+
Request Request
------- -------
- Parameter description - Parameter description
.. _rds_06_0002__table1453814912427: .. _gaussdb_04_0012__table1453814912427:
.. table:: **Table 2** quota_list field data structure description .. table:: **Table 2** quota_list field data structure description
@ -83,15 +83,15 @@ Response
.. table:: **Table 3** Parameter description .. table:: **Table 3** Parameter description
+-----------------------+-----------------------+---------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+===============================================================+ +=======================+=======================+===================================================================+
| quota_list | Array of objects | Configured quota information. | | quota_list | Array of objects | Configured quota information. |
| | | | | | | |
| | | For details, see :ref:`Table 4 <rds_06_0002__table66531170>`. | | | | For details, see :ref:`Table 4 <gaussdb_04_0012__table66531170>`. |
+-----------------------+-----------------------+---------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
.. _rds_06_0002__table66531170: .. _gaussdb_04_0012__table66531170:
.. table:: **Table 4** quota_list data structure description .. table:: **Table 4** quota_list data structure description
@ -122,9 +122,9 @@ Response
Status Code Status Code
----------- -----------
For details, see :ref:`Status Codes <rds_10_0200>`. For details, see :ref:`Status Codes <gaussdb_10_0002>`.
Error Code Error Code
---------- ----------
For details, see :ref:`Error Codes <rds_10_0201>`. For details, see :ref:`Error Codes <gaussdb_10_0003>`.

10
api-ref/source/api/managing_quotas/index.rst
View File

@ -1,13 +1,13 @@
:original_name: en-us_topic_0264049309.html :original_name: gaussdb_04_0010.html
.. _en-us_topic_0264049309: .. _gaussdb_04_0010:
Managing Quotas Managing Quotas
=============== ===============
- :ref:`Querying Resource Quotas <rds_06_0001>` - :ref:`Querying Resource Quotas <gaussdb_04_0011>`
- :ref:`Configuring Resource Quotas <rds_06_0002>` - :ref:`Configuring Resource Quotas <gaussdb_04_0012>`
- :ref:`Modifying Resource Quotas <rds_04_0002>` - :ref:`Modifying Resource Quotas <gaussdb_04_0013>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

26
api-ref/source/api/managing_quotas/modifying_resource_quotas.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_04_0002.html :original_name: gaussdb_04_0013.html
.. _rds_04_0002: .. _gaussdb_04_0013:
Modifying Resource Quotas Modifying Resource Quotas
========================= =========================
@ -10,7 +10,7 @@ Function
This API is used to modify the resource quota of a specified enterprise project. This API is used to modify the resource quota of a specified enterprise project.
- Learn how to :ref:`authorize and authenticate <rds_03_0001>` this API before using it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` this API before using it.
- Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
URI URI
@ -33,11 +33,11 @@ URI
+=======================+=======================+====================================================================================================+ +=======================+=======================+====================================================================================================+
| project_id | Yes | Project ID of a tenant in a region. | | project_id | Yes | Project ID of a tenant in a region. |
| | | | | | | |
| | | To obtain this value, see :ref:`Obtaining a Project ID <rds_03_0002>`. | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+
| quota_list | Yes | Enterprise project resource quotas to be updated. A maximum of 10 quotas can be updated at a time. | | quota_list | Yes | Enterprise project resource quotas to be updated. A maximum of 10 quotas can be updated at a time. |
| | | | | | | |
| | | For details, see :ref:`Table 2 <rds_04_0002__table1252104315240>`. | | | | For details, see :ref:`Table 2 <gaussdb_04_0013__table1252104315240>`. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+
Request Request
@ -45,7 +45,7 @@ Request
- Parameter description - Parameter description
.. _rds_04_0002__table1252104315240: .. _gaussdb_04_0013__table1252104315240:
.. table:: **Table 2** quota_list field data structure description .. table:: **Table 2** quota_list field data structure description
@ -85,15 +85,15 @@ Response
.. table:: **Table 3** Parameter description .. table:: **Table 3** Parameter description
+-----------------------+-----------------------+---------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+===============================================================+ +=======================+=======================+===================================================================+
| quota_list | Array of objects | Configured quota information. | | quota_list | Array of objects | Configured quota information. |
| | | | | | | |
| | | For details, see :ref:`Table 4 <rds_04_0002__table66531170>`. | | | | For details, see :ref:`Table 4 <gaussdb_04_0013__table66531170>`. |
+-----------------------+-----------------------+---------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
.. _rds_04_0002__table66531170: .. _gaussdb_04_0013__table66531170:
.. table:: **Table 4** quota_list field data structure description .. table:: **Table 4** quota_list field data structure description
@ -124,9 +124,9 @@ Response
Status Code Status Code
----------- -----------
For details, see :ref:`Status Codes <rds_10_0200>`. For details, see :ref:`Status Codes <gaussdb_10_0002>`.
Error Code Error Code
---------- ----------
For details, see :ref:`Error Codes <rds_10_0201>`. For details, see :ref:`Error Codes <gaussdb_10_0003>`.

24
api-ref/source/api/managing_quotas/querying_resource_quotas.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_06_0001.html :original_name: gaussdb_04_0011.html
.. _rds_06_0001: .. _gaussdb_04_0011:
Querying Resource Quotas Querying Resource Quotas
======================== ========================
@ -10,7 +10,7 @@ Function
This API is used to obtain the resource quota of a specified enterprise project. This API is used to obtain the resource quota of a specified enterprise project.
- Learn how to :ref:`authorize and authenticate <rds_03_0001>` this API before using it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` this API before using it.
- Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
URI URI
@ -33,7 +33,7 @@ URI
+=======================+=======================+=========================================================================================================================================================================================================================================+ +=======================+=======================+=========================================================================================================================================================================================================================================+
| project_id | Yes | Project ID of a tenant in a region. | | project_id | Yes | Project ID of a tenant in a region. |
| | | | | | | |
| | | To obtain this value, see :ref:`Obtaining a Project ID <rds_03_0002>`. | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| offset | No | Index position. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. | | offset | No | Index position. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -52,17 +52,17 @@ Response
.. table:: **Table 2** Parameter description .. table:: **Table 2** Parameter description
+-----------------------+-----------------------+---------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+===============================================================+ +=======================+=======================+===================================================================+
| quota_list | Array of objects | Quota information list. | | quota_list | Array of objects | Quota information list. |
| | | | | | | |
| | | For details, see :ref:`Table 3 <rds_06_0001__table66531170>`. | | | | For details, see :ref:`Table 3 <gaussdb_04_0011__table66531170>`. |
+-----------------------+-----------------------+---------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
| total_count | Integer | Number of quota records. | | total_count | Integer | Number of quota records. |
+-----------------------+-----------------------+---------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
.. _rds_06_0001__table66531170: .. _gaussdb_04_0011__table66531170:
.. table:: **Table 3** quota_list field data structure description .. table:: **Table 3** quota_list field data structure description
@ -108,9 +108,9 @@ Response
Status Code Status Code
----------- -----------
For details, see :ref:`Status Codes <rds_10_0200>`. For details, see :ref:`Status Codes <gaussdb_10_0002>`.
Error Code Error Code
---------- ----------
For details, see :ref:`Error Codes <rds_10_0201>`. For details, see :ref:`Error Codes <gaussdb_10_0003>`.

86
api-ref/source/api/obtaining_task_information.rst
View File

File diff suppressed because it is too large Load Diff

38
api-ref/source/api/querying_database_specifications.rst
View File

@ -1,6 +1,6 @@
:original_name: en-us_topic_0264049275.html :original_name: gaussdb_04_0002.html
.. _en-us_topic_0264049275: .. _gaussdb_04_0002:
Querying Database Specifications Querying Database Specifications
================================ ================================
@ -10,7 +10,7 @@ Function
This API is used to query the database specifications of a specified DB engine version. This API is used to query the database specifications of a specified DB engine version.
- Learn how to :ref:`authorize and authenticate <rds_03_0001>` this API before using it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` this API before using it.
- Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
URI URI
@ -28,25 +28,25 @@ URI
.. table:: **Table 1** Parameter description .. table:: **Table 1** Parameter description
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description | | Name | Mandatory | Type | Description |
+========================+=================+=================+==============================================================================================================================+ +========================+=================+=================+=======================================================================================================================+
| project_id | Yes | String | Project ID of a tenant in a region. | | project_id | Yes | String | Project ID of a tenant in a region. |
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <rds_03_0002>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| database | Yes | String | DB engine. Its value can be any of the following and is case-insensitive: | | database | Yes | String | DB engine. Its value can be any of the following and is case-insensitive: |
| | | | | | | | | |
| | | | - gaussdb-mysql | | | | | - gaussdb-mysql |
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| version_name | No | String | DB version number. To obtain this value, see :ref:`Querying Version Information About a DB Engine <en-us_topic_0264049311>`. | | version_name | No | String | DB version number. To obtain this value, see :ref:`Querying Version Information About a DB Engine <gaussdb_04_0001>`. |
| | | | | | | | | |
| | | | Currently, only MySQL 8.0 is supported. | | | | | Currently, only MySQL 8.0 is supported. |
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| availability_zone_mode | Yes | String | AZ type of the specification. The value can be **single** or **multi**. | | availability_zone_mode | Yes | String | AZ type of the specification. The value can be **single** or **multi**. |
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| spec_code | No | String | Specification code. | | spec_code | No | String | Specification code. |
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
Request Request
------- -------
@ -60,15 +60,15 @@ Response
.. table:: **Table 2** Parameter description .. table:: **Table 2** Parameter description
+-----------------------+-----------------------+--------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+==========================================================================+ +=======================+=======================+===================================================================+
| flavors | Array of objects | DB instance specification list. | | flavors | Array of objects | DB instance specification list. |
| | | | | | | |
| | | For details, see :ref:`Table 3 <en-us_topic_0264049275__table66531170>`. | | | | For details, see :ref:`Table 3 <gaussdb_04_0002__table66531170>`. |
+-----------------------+-----------------------+--------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
.. _en-us_topic_0264049275__table66531170: .. _gaussdb_04_0002__table66531170:
.. table:: **Table 3** flavors field data structure description .. table:: **Table 3** flavors field data structure description
@ -134,9 +134,9 @@ Response
Status Code Status Code
----------- -----------
For details, see :ref:`Status Codes <rds_10_0200>`. For details, see :ref:`Status Codes <gaussdb_10_0002>`.
Error Code Error Code
---------- ----------
For details, see :ref:`Error Codes <rds_10_0201>`. For details, see :ref:`Error Codes <gaussdb_10_0003>`.

22
api-ref/source/api/querying_version_information_about_a_db_engine.rst
View File

@ -1,6 +1,6 @@
:original_name: en-us_topic_0264049311.html :original_name: gaussdb_04_0001.html
.. _en-us_topic_0264049311: .. _gaussdb_04_0001:
Querying Version Information About a DB Engine Querying Version Information About a DB Engine
============================================== ==============================================
@ -10,7 +10,7 @@ Function
This API is used to query the DB version information of a specified DB engine. This API is used to query the DB version information of a specified DB engine.
- Learn how to :ref:`authorize and authenticate <rds_03_0001>` this API before using it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` this API before using it.
- Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
URI URI
@ -33,7 +33,7 @@ URI
+=======================+=======================+===================================================================================+ +=======================+=======================+===================================================================================+
| project_id | Yes | Project ID of a tenant in a region. | | project_id | Yes | Project ID of a tenant in a region. |
| | | | | | | |
| | | To obtain this value, see :ref:`Obtaining a Project ID <rds_03_0002>`. | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------+
| database_name | Yes | DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql | | database_name | Yes | DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------+
@ -50,15 +50,15 @@ Response
.. table:: **Table 2** Parameter description .. table:: **Table 2** Parameter description
+-----------------------+-----------------------+--------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+==========================================================================+ +=======================+=======================+===================================================================+
| datastores | Array of objects | DB version list. | | datastores | Array of objects | DB version list. |
| | | | | | | |
| | | For details, see :ref:`Table 3 <en-us_topic_0264049311__table66531170>`. | | | | For details, see :ref:`Table 3 <gaussdb_04_0001__table66531170>`. |
+-----------------------+-----------------------+--------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
.. _en-us_topic_0264049311__table66531170: .. _gaussdb_04_0001__table66531170:
.. table:: **Table 3** datastores field data structure description .. table:: **Table 3** datastores field data structure description
@ -84,9 +84,9 @@ Response
Status Code Status Code
----------- -----------
For details, see :ref:`Status Codes <rds_10_0200>`. For details, see :ref:`Status Codes <gaussdb_10_0002>`.
Error Code Error Code
---------- ----------
For details, see :ref:`Error Codes <rds_10_0201>`. For details, see :ref:`Error Codes <gaussdb_10_0003>`.

22
api-ref/source/api_overview.rst
View File

@ -1,24 +1,24 @@
:original_name: rds_02_0000.html :original_name: gaussdb_02_0000.html
.. _rds_02_0000: .. _gaussdb_02_0000:
API Overview API Overview
============ ============
With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas. With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas.
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| Type | Description | | Type | Description |
+===============================+===================================================================================================================================================================================================+ +===============================+===============================================================================================================================================+
| DB engine version query | Query the DB version information of a specified DB engine. | | DB engine version query | Query the DB version information of a specified DB engine. |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| DB specifications query | Query the DB specifications of a specified DB engine version. | | DB specifications query | Query the DB specifications of a specified DB engine version. |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| DB instance management | Create DB instances, query DB instance lists, query DB instance details, delete DB instances, create read replicas, delete read replicas, and scale storage space of yearly/monthly DB instances. | | DB instance management | Create DB instances, query DB instance lists, query DB instance details, delete DB instances, create read replicas, and delete read replicas. |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter template management | Query parameter templates. | | Parameter template management | Query parameter templates. |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| Quota management | Query, set, and modify resource quotas. | | Quota management | Query, set, and modify resource quotas. |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| Task information query | Obtain task information about the task center. | | Task information query | Obtain task information about the task center. |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+

14
api-ref/source/appendix/abnormal_request_results.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_01_0010.html :original_name: gaussdb_10_0001.html
.. _rds_01_0010: .. _gaussdb_10_0001:
Abnormal Request Results Abnormal Request Results
======================== ========================
@ -9,13 +9,13 @@ Abnormal Request Results
.. table:: **Table 1** Abnormal response description .. table:: **Table 1** Abnormal response description
+------------+--------+-----------------------------------------------------------------------------------------------------------------+ +------------+--------+---------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+============+========+=================================================================================================================+ +============+========+=====================================================================================================================+
| error_code | String | Returned error code when a task submission exception occurs. For details, see :ref:`Error Codes <rds_10_0201>`. | | error_code | String | Returned error code when a task submission exception occurs. For details, see :ref:`Error Codes <gaussdb_10_0003>`. |
+------------+--------+-----------------------------------------------------------------------------------------------------------------+ +------------+--------+---------------------------------------------------------------------------------------------------------------------+
| error_msg | String | Returned error description when a task submission exception occurs. | | error_msg | String | Returned error description when a task submission exception occurs. |
+------------+--------+-----------------------------------------------------------------------------------------------------------------+ +------------+--------+---------------------------------------------------------------------------------------------------------------------+
- Example response - Example response

10
api-ref/source/appendix/error_codes.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_10_0201.html :original_name: gaussdb_10_0003.html
.. _rds_10_0201: .. _gaussdb_10_0003:
Error Codes Error Codes
=========== ===========
@ -18,8 +18,6 @@ The following table describes error codes.
+------------+---------------+-------------------------------------------------------------------------------------------------+ +------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.200051 | 500 | Invalid deployment mode. | | DBS.200051 | 500 | Invalid deployment mode. |
+------------+---------------+-------------------------------------------------------------------------------------------------+ +------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.200317 | 400 | Storage scaling up is not supported for pay-per-use DB instances. |
+------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.200910 | 400 | The maximum number of read replicas has been reached. | | DBS.200910 | 400 | The maximum number of read replicas has been reached. |
+------------+---------------+-------------------------------------------------------------------------------------------------+ +------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.280203 | 400 | This is a weak password. Please enter a strong password. | | DBS.280203 | 400 | This is a weak password. Please enter a strong password. |
@ -62,8 +60,6 @@ The following table describes error codes.
+------------+---------------+-------------------------------------------------------------------------------------------------+ +------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.280431 | 400 | Invalid billing period. | | DBS.280431 | 400 | Invalid billing period. |
+------------+---------------+-------------------------------------------------------------------------------------------------+ +------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.280432 | 400 | Invalid duration for yearly/monthly DB instances. |
+------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.280433 | 400 | Invalid enterprise project ID. | | DBS.280433 | 400 | Invalid enterprise project ID. |
+------------+---------------+-------------------------------------------------------------------------------------------------+ +------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.280434 | 400 | Invalid specification code | | DBS.280434 | 400 | Invalid specification code |
@ -82,7 +78,7 @@ The following table describes error codes.
+------------+---------------+-------------------------------------------------------------------------------------------------+ +------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.280465 | 400 | Invalid password. | | DBS.280465 | 400 | Invalid password. |
+------------+---------------+-------------------------------------------------------------------------------------------------+ +------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.280466 | 400 | Invalid standby node quantity. | | DBS.280466 | 400 | Invalid read replica quantity. |
+------------+---------------+-------------------------------------------------------------------------------------------------+ +------------+---------------+-------------------------------------------------------------------------------------------------+
| DBS.280467 | 400 | Invalid read replica failover priority. | | DBS.280467 | 400 | Invalid read replica failover priority. |
+------------+---------------+-------------------------------------------------------------------------------------------------+ +------------+---------------+-------------------------------------------------------------------------------------------------+

4
api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_10_0204.html :original_name: gaussdb_10_0006.html
.. _rds_10_0204: .. _gaussdb_10_0006:
GaussDB(for MySQL) Monitoring Metrics GaussDB(for MySQL) Monitoring Metrics
===================================== =====================================

14
api-ref/source/appendix/index.rst
View File

@ -1,15 +1,15 @@
:original_name: rds_01_0000.html :original_name: gaussdb_10_0000.html
.. _rds_01_0000: .. _gaussdb_10_0000:
Appendix Appendix
======== ========
- :ref:`Abnormal Request Results <rds_01_0010>` - :ref:`Abnormal Request Results <gaussdb_10_0001>`
- :ref:`Status Codes <rds_10_0200>` - :ref:`Status Codes <gaussdb_10_0002>`
- :ref:`Error Codes <rds_10_0201>` - :ref:`Error Codes <gaussdb_10_0003>`
- :ref:`Obtaining a Project ID <rds_03_0002>` - :ref:`Obtaining a Project ID <gaussdb_10_0004>`
- :ref:`GaussDB(for MySQL) Monitoring Metrics <rds_10_0204>` - :ref:`GaussDB(for MySQL) Monitoring Metrics <gaussdb_10_0006>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

16
api-ref/source/appendix/obtaining_a_project_id.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_03_0002.html :original_name: gaussdb_10_0004.html
.. _rds_03_0002: .. _gaussdb_10_0004:
Obtaining a Project ID Obtaining a Project ID
====================== ======================
@ -10,15 +10,15 @@ Scenarios
When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first. Two methods are available: When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first. Two methods are available:
- :ref:`Obtaining the Project ID by Calling an API <rds_03_0002__section85791974381>` - :ref:`Obtaining the Project ID by Calling an API <gaussdb_10_0004__section85791974381>`
- :ref:`Obtain a Project ID from the Console <rds_03_0002__section196091152113715>` - :ref:`Obtain a Project ID from the Console <gaussdb_10_0004__section196091152113715>`
.. _rds_03_0002__section85791974381: .. _gaussdb_10_0004__section85791974381:
Obtaining the Project ID by Calling an API Obtaining the Project ID by Calling an API
------------------------------------------ ------------------------------------------
The API used to obtain a project ID is **GET https://{Endpoint}/v3/projects**. **{Endpoint}** is the IAM endpoint and can be obtained from `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__. For details about API authentication, see :ref:`Authentication <rds_03_0001>`. The API used to obtain a project ID is **GET https://{Endpoint}/v3/projects**. **{Endpoint}** is the IAM endpoint and can be obtained from `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__. For details about API authentication, see :ref:`Authentication <gaussdb_03_0001>`.
The following is an example response. The value of **id** is the project ID. The following is an example response. The value of **id** is the project ID.
@ -48,7 +48,7 @@ The following is an example response. The value of **id** is the project ID.
} }
} }
.. _rds_03_0002__section196091152113715: .. _gaussdb_10_0004__section196091152113715:
Obtain a Project ID from the Console Obtain a Project ID from the Console
------------------------------------ ------------------------------------
@ -60,7 +60,7 @@ Obtain a Project ID from the Console
On the **My Credentials** page, view project IDs in the project list. On the **My Credentials** page, view project IDs in the project list.
.. figure:: /_static/images/en-us_image_0264049266.jpg .. figure:: /_static/images/en-us_image_0000001423128721.jpg
:alt: **Figure 1** Viewing project IDs :alt: **Figure 1** Viewing project IDs
**Figure 1** Viewing project IDs **Figure 1** Viewing project IDs

4
api-ref/source/appendix/status_codes.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_10_0200.html :original_name: gaussdb_10_0002.html
.. _rds_10_0200: .. _gaussdb_10_0002:
Status Codes Status Codes
============ ============

2
api-ref/source/before_you_start/api_calling.rst
View File

@ -5,4 +5,4 @@
API Calling API Calling
=========== ===========
GaussDB(for MySQL) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see :ref:`Calling APIs <rds_02_0001>`. GaussDB(for MySQL) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see :ref:`Calling APIs <gaussdb_03_0000>`.

4
api-ref/source/before_you_start/concepts.rst
View File

@ -25,10 +25,10 @@ Concepts
- Project - Project
Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each HUAWEI CLOUD region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects. Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
.. figure:: /_static/images/en-us_image_0264049268.gif .. figure:: /_static/images/en-us_image_0000001422968749.gif
:alt: **Figure 1** Project isolating model :alt: **Figure 1** Project isolating model
**Figure 1** Project isolating model **Figure 1** Project isolating model

6
api-ref/source/before_you_start/overview.rst
View File

@ -5,8 +5,6 @@
Overview Overview
======== ========
Welcome to use GaussDB(for MySQL). GaussDB(for MySQL) is the latest generation enterprise-class distributed database from Huawei. It is fully compatible with MySQL and provides high scalability and massive storage capability. It uses a decoupled compute and storage architecture and Data Functions Virtualization (DFV) storage that auto scales up to 128 TB of storage. With GaussDB(for MySQL), there is no need to deal with sharding, and no need to worry about data loss. It delivers high scalability with one primary node and up to 15 read replicas. No sharding is required. It is an enterprise-class database solution that is suitable for financial and high-concurrency service scenarios. This document describes how to use application programming interfaces (APIs) to perform operations on DB instances. For details about all supported operations, see :ref:`API Overview <gaussdb_02_0000>`.
This document describes how to use application programming interfaces (APIs) to perform operations on DB instances. For details about all supported operations, see :ref:`API Overview <rds_02_0000>`. If you plan to access GaussDB(for MySQL) through an API, ensure that you are familiar with GaussDB(for MySQL) concepts. For details, see "What Is GaussDB(for MySQL)?" in the *GaussDB(for MySQL) User Guide*.
If you plan to access GaussDB(for MySQL) through an API, ensure that you are familiar with GaussDB(for MySQL) concepts. For details, see "Introduction" in the *GaussDB(for MySQL) User Guide*.

6
api-ref/source/calling_apis/authentication.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_03_0001.html :original_name: gaussdb_03_0001.html
.. _rds_03_0001: .. _gaussdb_03_0001:
Authentication Authentication
============== ==============
@ -18,7 +18,7 @@ Token-based Authentication
A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.
In :ref:`Making an API Request <rds_03_0005>`, the process of calling the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__ is described. In :ref:`Making an API Request <gaussdb_03_0005>`, the process of calling the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__ is described.
After a token is obtained, add the **X-Auth-Token** header field must be added to requests to specify the token when calling other APIs. For example, if the token is **ABCDEFJ....**, **X-Auth-Token: ABCDEFJ....** can be added to a request as follows: After a token is obtained, add the **X-Auth-Token** header field must be added to requests to specify the token when calling other APIs. For example, if the token is **ABCDEFJ....**, **X-Auth-Token: ABCDEFJ....** can be added to a request as follows:

10
api-ref/source/calling_apis/index.rst
View File

@ -1,13 +1,13 @@
:original_name: rds_02_0001.html :original_name: gaussdb_03_0000.html
.. _rds_02_0001: .. _gaussdb_03_0000:
Calling APIs Calling APIs
============ ============
- :ref:`Making an API Request <rds_03_0005>` - :ref:`Making an API Request <gaussdb_03_0005>`
- :ref:`Authentication <rds_03_0001>` - :ref:`Authentication <gaussdb_03_0001>`
- :ref:`Response <rds_03_0006>` - :ref:`Response <gaussdb_03_0006>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

12
api-ref/source/calling_apis/making_an_api_request.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_03_0005.html :original_name: gaussdb_03_0005.html
.. _rds_03_0005: .. _gaussdb_03_0005:
Making an API Request Making an API Request
===================== =====================
@ -58,9 +58,9 @@ Request Header
You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, to request for the authentication information, add **Content-Type**, which specifies the request body type. You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, to request for the authentication information, add **Content-Type**, which specifies the request body type.
:ref:`Table 3 <rds_03_0005__table1986821153312>` lists common request header fields. :ref:`Table 3 <gaussdb_03_0005__table1986821153312>` lists common request header fields.
.. _rds_03_0005__table1986821153312: .. _gaussdb_03_0005__table1986821153312:
.. table:: **Table 3** Common request headers .. table:: **Table 3** Common request headers
@ -77,7 +77,7 @@ You can also add additional fields to a request, such as the fields required by
+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+--------------------------------------------+ +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+--------------------------------------------+
| Content-Length | Specifies the length of the request body. The unit is byte. | No | 3495 | | Content-Length | Specifies the length of the request body. The unit is byte. | No | 3495 |
+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+--------------------------------------------+ +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+--------------------------------------------+
| X-Project-Id | Specifies the project ID. Obtain the project ID by following the instructions in :ref:`Obtaining a Project ID <rds_03_0002>`. | No | e9993fc787d94b6c886cbaa340f9c0f4 | | X-Project-Id | Specifies the project ID. Obtain the project ID by following the instructions in :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | No | e9993fc787d94b6c886cbaa340f9c0f4 |
+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+--------------------------------------------+ +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+--------------------------------------------+
| X-Auth-Token | Specifies the user token. | No | The following is part of an example token: | | X-Auth-Token | Specifies the user token. | No | The following is part of an example token: |
| | | | | | | | | |
@ -91,7 +91,7 @@ The API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/i
(Optional) Request Body (Optional) Request Body
----------------------- -----------------------
This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the **Content-Type** header field. If the request body contains Chinese characters, these characters must be coded in UTF-8. This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the **Content-Type** header field. If the request body contains full-width characters, these characters must be coded in UTF-8.
The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods. The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.

12
api-ref/source/calling_apis/response.rst
View File

@ -1,6 +1,6 @@
:original_name: rds_03_0006.html :original_name: gaussdb_03_0006.html
.. _rds_03_0006: .. _gaussdb_03_0006:
Response Response
======== ========
@ -10,7 +10,7 @@ Status Code
After sending a request, you will receive a response, including the status code, response header, and response body. After sending a request, you will receive a response, including the status code, response header, and response body.
A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see :ref:`Status Codes <rds_10_0200>`. A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see :ref:`Status Codes <gaussdb_10_0002>`.
For example, if status code **201** is returned for calling the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__, the request is successful. For example, if status code **201** is returned for calling the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__, the request is successful.
@ -19,11 +19,11 @@ Response Header
Similar to a request, a response also has a header, for example, **Content-Type**. Similar to a request, a response also has a header, for example, **Content-Type**.
:ref:`Figure 1 <rds_03_0006__fig4865141011511>` shows the response header for the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__. The **x-subject-token** header field is the desired user token. This token can then be used to authenticate the calling of other APIs. :ref:`Figure 1 <gaussdb_03_0006__fig4865141011511>` shows the response header for the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__. The **x-subject-token** header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
.. _rds_03_0006__fig4865141011511: .. _gaussdb_03_0006__fig4865141011511:
.. figure:: /_static/images/en-us_image_0264049300.png .. figure:: /_static/images/en-us_image_0000001372529646.png
:alt: **Figure 1** Header fields of the response to the request for obtaining a user token :alt: **Figure 1** Header fields of the response to the request for obtaining a user token
**Figure 1** Header fields of the response to the request for obtaining a user token **Figure 1** Header fields of the response to the request for obtaining a user token

15
api-ref/source/change_history.rst
View File

@ -5,8 +5,13 @@
Change History Change History
============== ==============
=========== ========================================= +-----------------------------------+-------------------------------------------------------------------------------------+
Released On Description | Released On | Description |
=========== ========================================= +===================================+=====================================================================================+
2020-05-30 This issue is the first official release. | 2022-10-30 | This issue is the second official release. |
=========== ========================================= | | |
| | - Optimized the content in :ref:`Querying a Parameter Template <gaussdb_04_0009>`. |
| | - Optimized the content in :ref:`Querying a DB Instance List <gaussdb_04_0005>`. |
+-----------------------------------+-------------------------------------------------------------------------------------+
| 2020-05-30 | This issue is the first official release. |
+-----------------------------------+-------------------------------------------------------------------------------------+

8
api-ref/source/conf.py
View File

@ -26,6 +26,9 @@ otcdocs_auto_version = False
project = 'GaussDB Enterprise-class Distributed Database compatible with MySQL' project = 'GaussDB Enterprise-class Distributed Database compatible with MySQL'
otcdocs_repo_name = 'docs/gaussdb-mysql' otcdocs_repo_name = 'docs/gaussdb-mysql'
# Those variables are required for edit/bug links
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea'
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
@ -75,8 +78,9 @@ html_theme = 'otcdocs'
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
# documentation. # documentation.
html_theme_options = { html_theme_options = {
'disable_search': True, "disable_search": True,
'site_name': 'Internal Documentation Portal' "site_name": "Internal Documentation Portal",
"logo_url": "https://docs-int.otc-service.com",
} }
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to