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 2023-05-25 16:26:19 +00:00
parent 0b15e459dd
commit 59c26562ea
15 changed files with 50 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because it is too large Load Diff

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

@ -37,11 +37,11 @@ URI
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | No | DB instance ID. | | id | String | No | DB instance ID. |
| | | | | | | | | |
| | | | The asterisk (``*``) is reserved for the system. If the instance ID starts with an asterisk (``*``), the value following asterisk (``*``) is used for fuzzy matching. Otherwise, the instance ID is used for exact matching. | | | | | The asterisk (\``*`\`) is reserved for the system. If the instance ID starts with an asterisk (\``*`\`), the value following asterisk (\``*`\`) is used for fuzzy matching. Otherwise, the instance ID is used for exact matching. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | No | DB instance name. | | name | String | No | DB instance name. |
| | | | | | | | | |
| | | | The asterisk (``*``) is reserved for the system. If the instance name starts with an asterisk (``*``), the value following asterisk (``*``) is used for fuzzy matching. Otherwise, the instance name is used for exact matching. | | | | | The asterisk (\``*`\`) is reserved for the system. If the instance name starts with an asterisk (\``*`\`), the value following asterisk (\``*`\`) is used for fuzzy matching. Otherwise, the instance name is used for exact matching. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | No | DB instance type to be queried. Currently, only the cluster type is supported. | | type | String | No | DB instance type to be queried. Currently, only the cluster type is supported. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -84,7 +84,6 @@ Response
| total_count | Integer | Total number of records. | | total_count | Integer | Total number of records. |
+-----------------------+-----------------------+------------------------------------------------------------------------+ +-----------------------+-----------------------+------------------------------------------------------------------------+
.. _gaussdb_04_0005__table2058713718267:
.. table:: **Table 3** instances field data structure description .. table:: **Table 3** instances field data structure description
@ -144,7 +143,6 @@ Response
| time_zone | String | Time zone. | | time_zone | String | Time zone. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+
.. _gaussdb_04_0005__table187591675262:
.. table:: **Table 4** datastore field data structure description .. table:: **Table 4** datastore field data structure description
@ -155,7 +153,6 @@ Response
version String DB version. version String DB version.
======= ====== =========== ======= ====== ===========
.. _gaussdb_04_0005__table14771167122611:
.. table:: **Table 5** volume field data structure description .. table:: **Table 5** volume field data structure description
@ -175,7 +172,6 @@ Response
ram String Memory size in GB. ram String Memory size in GB.
===== ====== ================== ===== ====== ==================
.. _gaussdb_04_0005__table578797132615:
.. table:: **Table 7** backup_strategy field data structure description .. table:: **Table 7** backup_strategy field data structure description

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

@ -58,7 +58,6 @@ Response
| | | For details, see :ref:`Table 3 <gaussdb_04_0006__table2058713718267>`. | | | | For details, see :ref:`Table 3 <gaussdb_04_0006__table2058713718267>`. |
+-----------------------+-----------------------+------------------------------------------------------------------------+ +-----------------------+-----------------------+------------------------------------------------------------------------+
.. _gaussdb_04_0006__table2058713718267:
.. table:: **Table 3** instance field data structure description .. table:: **Table 3** instance field data structure description
@ -114,7 +113,6 @@ Response
| master_az_code | String | Primary AZ. | | master_az_code | String | Primary AZ. |
+-----------------------+------------------+---------------------------------------------------------------------------------------------+ +-----------------------+------------------+---------------------------------------------------------------------------------------------+
.. _gaussdb_04_0006__table187591675262:
.. table:: **Table 4** datastore field data structure description .. table:: **Table 4** datastore field data structure description
@ -134,7 +132,6 @@ Response
name String Parameter template name. name String Parameter template name.
==== ====== ======================== ==== ====== ========================
.. _gaussdb_04_0006__table37991653839:
.. table:: **Table 6** backup_strategy field data structure description .. table:: **Table 6** backup_strategy field data structure description
@ -146,7 +143,6 @@ Response
| keep_days | Integer | Backup retention days. | | keep_days | Integer | Backup retention days. |
+------------+---------+----------------------------------------------------------------------------------------+ +------------+---------+----------------------------------------------------------------------------------------+
.. _gaussdb_04_0006__table5182635134511:
.. table:: **Table 7** nodes field data structure description .. table:: **Table 7** nodes field data structure description
@ -188,7 +184,6 @@ Response
| priority | String | Failover priority. | | priority | String | Failover priority. |
+------------------+-----------------+-------------------------------------------------------------------------+ +------------------+-----------------+-------------------------------------------------------------------------+
.. _gaussdb_04_0006__table14771167122611:
.. table:: **Table 8** volume field data structure description .. table:: **Table 8** volume field data structure description

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

@ -58,7 +58,6 @@ Response
| total_count | Integer | Total number of parameter templates. | | total_count | Integer | Total number of parameter templates. |
+-----------------------+-----------------------+------------------------------------------------------------------------+ +-----------------------+-----------------------+------------------------------------------------------------------------+
.. _gaussdb_04_0009__table1324110018258:
.. table:: **Table 3** configurations field data structure description .. table:: **Table 3** configurations field data structure description

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

@ -45,7 +45,6 @@ Request
- Parameter description - Parameter description
.. _gaussdb_04_0012__table1453814912427:
.. table:: **Table 2** quota_list field data structure description .. table:: **Table 2** quota_list field data structure description
@ -91,7 +90,6 @@ Response
| | | For details, see :ref:`Table 4 <gaussdb_04_0012__table66531170>`. | | | | For details, see :ref:`Table 4 <gaussdb_04_0012__table66531170>`. |
+-----------------------+-----------------------+-------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
.. _gaussdb_04_0012__table66531170:
.. table:: **Table 4** quota_list data structure description .. table:: **Table 4** quota_list data structure description

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

@ -45,7 +45,6 @@ Request
- Parameter description - Parameter description
.. _gaussdb_04_0013__table1252104315240:
.. table:: **Table 2** quota_list field data structure description .. table:: **Table 2** quota_list field data structure description
@ -93,7 +92,6 @@ Response
| | | For details, see :ref:`Table 4 <gaussdb_04_0013__table66531170>`. | | | | For details, see :ref:`Table 4 <gaussdb_04_0013__table66531170>`. |
+-----------------------+-----------------------+-------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
.. _gaussdb_04_0013__table66531170:
.. table:: **Table 4** quota_list field data structure description .. table:: **Table 4** quota_list field data structure description

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

@ -62,7 +62,6 @@ Response
| total_count | Integer | Number of quota records. | | total_count | Integer | Number of quota records. |
+-----------------------+-----------------------+-------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
.. _gaussdb_04_0011__table66531170:
.. table:: **Table 3** quota_list field data structure description .. table:: **Table 3** quota_list field data structure description

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

@ -56,7 +56,6 @@ Response
| job | Object | Task information. For details, see :ref:`Table 3 <gaussdb_04_0014__table54571314103317>`. | | job | Object | Task information. For details, see :ref:`Table 3 <gaussdb_04_0014__table54571314103317>`. |
+------+--------+-------------------------------------------------------------------------------------------+ +------+--------+-------------------------------------------------------------------------------------------+
.. _gaussdb_04_0014__table54571314103317:
.. table:: **Table 3** job field data structure description .. table:: **Table 3** job field data structure description
@ -92,7 +91,6 @@ Response
| fail_reason | String | Task failure information. | | fail_reason | String | Task failure information. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+
.. _gaussdb_04_0014__table4062895917262:
.. table:: **Table 4** instances field data structure description .. table:: **Table 4** instances field data structure description
@ -103,7 +101,6 @@ Response
name String DB instance name. name String DB instance name.
==== ====== ================= ==== ====== =================
.. _gaussdb_04_0014__table1014617554138:
.. table:: **Table 5** entities field data structure description .. table:: **Table 5** entities field data structure description
@ -117,7 +114,6 @@ Response
| resource_ids | List<String> | Resource ID involved in a task. | | resource_ids | List<String> | Resource ID involved in a task. |
+-----------------------+-----------------------+-----------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------+
.. _gaussdb_04_0014__table975183423611:
.. table:: **Table 6** entities.instance field data structure description .. table:: **Table 6** entities.instance field data structure description
@ -131,7 +127,6 @@ Response
| datastore | Object | DB information. For details, see :ref:`Table 7 <gaussdb_04_0014__table173094268581>`. | | datastore | Object | DB information. For details, see :ref:`Table 7 <gaussdb_04_0014__table173094268581>`. |
+-----------+--------+---------------------------------------------------------------------------------------+ +-----------+--------+---------------------------------------------------------------------------------------+
.. _gaussdb_04_0014__table173094268581:
.. table:: **Table 7** datastore field data structure description .. table:: **Table 7** datastore field data structure description

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

@ -68,7 +68,6 @@ Response
| | | For details, see :ref:`Table 3 <gaussdb_04_0002__table66531170>`. | | | | For details, see :ref:`Table 3 <gaussdb_04_0002__table66531170>`. |
+-----------------------+-----------------------+-------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
.. _gaussdb_04_0002__table66531170:
.. table:: **Table 3** flavors field data structure description .. table:: **Table 3** flavors field data structure description

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

@ -58,7 +58,6 @@ Response
| | | For details, see :ref:`Table 3 <gaussdb_04_0001__table66531170>`. | | | | For details, see :ref:`Table 3 <gaussdb_04_0001__table66531170>`. |
+-----------------------+-----------------------+-------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------+
.. _gaussdb_04_0001__table66531170:
.. table:: **Table 3** datastores field data structure description .. table:: **Table 3** datastores field data structure description

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

@ -13,7 +13,6 @@ When calling APIs, you need to specify the project ID in some URLs. To do so, yo
- :ref:`Obtaining the Project ID by Calling an API <gaussdb_10_0004__section85791974381>` - :ref:`Obtaining the Project ID by Calling an API <gaussdb_10_0004__section85791974381>`
- :ref:`Obtain a Project ID from the Console <gaussdb_10_0004__section196091152113715>` - :ref:`Obtain a Project ID from the Console <gaussdb_10_0004__section196091152113715>`
.. _gaussdb_10_0004__section85791974381:
Obtaining the Project ID by Calling an API Obtaining the Project ID by Calling an API
------------------------------------------ ------------------------------------------
@ -48,7 +47,6 @@ The following is an example response. The value of **id** is the project ID.
} }
} }
.. _gaussdb_10_0004__section196091152113715:
Obtain a Project ID from the Console Obtain a Project ID from the Console
------------------------------------ ------------------------------------
@ -61,6 +59,4 @@ Obtain a Project ID from the Console
.. figure:: /_static/images/en-us_image_0000001423128721.jpg .. figure:: /_static/images/en-us_image_0000001423128721.jpg
:alt: **Figure 1** Viewing project IDs :alt:
**Figure 1** Viewing project IDs

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

@ -29,6 +29,4 @@ Concepts
.. figure:: /_static/images/en-us_image_0000001422968749.gif .. figure:: /_static/images/en-us_image_0000001422968749.gif
:alt: **Figure 1** Project isolating model :alt:
**Figure 1** Project isolating model

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

@ -60,7 +60,6 @@ You can also add additional fields to a request, such as the fields required by
:ref:`Table 3 <gaussdb_03_0005__table1986821153312>` lists common request header fields. :ref:`Table 3 <gaussdb_03_0005__table1986821153312>` lists common request header fields.
.. _gaussdb_03_0005__table1986821153312:
.. table:: **Table 3** Common request headers .. table:: **Table 3** Common request headers

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

@ -21,12 +21,9 @@ Similar to a request, a response also has a header, for example, **Content-Type*
: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. :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.
.. _gaussdb_03_0006__fig4865141011511:
.. figure:: /_static/images/en-us_image_0000001372529646.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
(Optional) Response Body (Optional) Response Body
------------------------ ------------------------

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

@ -18,7 +18,7 @@ import os
import sys import sys
extensions = [ extensions = [
'otcdocstheme', 'otcdocstheme'
] ]
otcdocs_auto_name = False otcdocs_auto_name = False