diff --git a/api-ref/source/api/managing_db_instances/creating_a_db_instance.rst b/api-ref/source/api/managing_db_instances/creating_a_db_instance.rst index 6553e62..a5637dc 100644 --- a/api-ref/source/api/managing_db_instances/creating_a_db_instance.rst +++ b/api-ref/source/api/managing_db_instances/creating_a_db_instance.rst @@ -52,7 +52,7 @@ Request | | | | | | | | | DB instances of the same type can have same names under the same tenant. | | | | | | - | | | | The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | + | | | | The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (\_). | +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | datastore | Yes | Object | Database information. | | | | | | @@ -113,7 +113,6 @@ Request | enterprise_project_id | No | String | Enterprise project ID. This parameter is mandatory only when the enterprise project is enabled. | +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _gaussdb_04_0004__table1935491614524: .. table:: **Table 3** charge_info field data structure description @@ -125,7 +124,6 @@ Request | | | | Value: **postPaid** | +-----------------+-----------------+-----------------+---------------------+ -.. _gaussdb_04_0004__table64243102: .. table:: **Table 4** datastore field data structure description @@ -139,7 +137,6 @@ Request | | | | For details about supported DB versions, see section :ref:`Querying Version Information About a DB Engine `. | +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ -.. _gaussdb_04_0004__table0863181193416: .. table:: **Table 5** backup_strategy field data structure description @@ -201,55 +198,53 @@ Response | job_id | String | DB instance creation task ID. | +-----------------------+-----------------------+-----------------------------------------------------------------------+ - .. _gaussdb_04_0004__table175305610274: .. table:: **Table 7** instance field data structure description - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +============================+=======================+========================================================================================================================================================================+ - | id | String | DB instance ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | DB instance name. DB instances of the same type can have same names under the same tenant. | - | | | | - | | | The value must be 4 to 64 characters in length and start with a letter. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_). | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | DB instance status. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore | Object | Database information. | - | | | | - | | | For details, see :ref:`Table 8 `. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | String | DB instance type. Currently, only the cluster type is supported. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | configuration_id | String | Parameter template ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | String | Database port, which is the same as the request parameter. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_strategy | Object | Automated backup policy. | - | | | | - | | | For details, see :ref:`Table 9 `. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region | String | Region ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone_mode | String | AZ ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | master\_ availability_zone | String | Primary AZ ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Security group ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Subnet ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slave_count | Integer | Number of read-only nodes. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_info | Object | Billing mode. | - | | | | - | | | For details, see :ref:`Table 10 `. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============================+=======================+=========================================================================================================================================================================+ + | id | String | DB instance ID. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. DB instances of the same type can have same names under the same tenant. | + | | | | + | | | The value must be 4 to 64 characters in length and start with a letter. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (\_). | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | DB instance status. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | Object | Database information. | + | | | | + | | | For details, see :ref:`Table 8 `. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mode | String | DB instance type. Currently, only the cluster type is supported. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | configuration_id | String | Parameter template ID. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | String | Database port, which is the same as the request parameter. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | Object | Automated backup policy. | + | | | | + | | | For details, see :ref:`Table 9 `. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region | String | Region ID. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_mode | String | AZ ID. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | master\_ availability_zone | String | Primary AZ ID. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Subnet ID. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | slave_count | Integer | Number of read-only nodes. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_info | Object | Billing mode. | + | | | | + | | | For details, see :ref:`Table 10 `. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - .. _gaussdb_04_0004__table766045720277: .. table:: **Table 8** datastore field data structure description @@ -260,7 +255,6 @@ Response version String DB version. ======= ====== ============= - .. _gaussdb_04_0004__table81249589270: .. table:: **Table 9** backup_strategy field data structure description @@ -272,7 +266,6 @@ Response | keep_days | Integer | Backup retention days. | +------------+---------+----------------------------------------------------------------------------------------+ - .. _gaussdb_04_0004__table207147873611: .. table:: **Table 10** charge_info field data structure description diff --git a/api-ref/source/api/managing_db_instances/querying_a_db_instance_list.rst b/api-ref/source/api/managing_db_instances/querying_a_db_instance_list.rst index 3bd5d35..8dfe4c6 100644 --- a/api-ref/source/api/managing_db_instances/querying_a_db_instance_list.rst +++ b/api-ref/source/api/managing_db_instances/querying_a_db_instance_list.rst @@ -37,11 +37,11 @@ URI +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | | | | | | - | | | | 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. | +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -84,7 +84,6 @@ Response | total_count | Integer | Total number of records. | +-----------------------+-----------------------+------------------------------------------------------------------------+ - .. _gaussdb_04_0005__table2058713718267: .. table:: **Table 3** instances field data structure description @@ -144,7 +143,6 @@ Response | time_zone | String | Time zone. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - .. _gaussdb_04_0005__table187591675262: .. table:: **Table 4** datastore field data structure description @@ -155,7 +153,6 @@ Response version String DB version. ======= ====== =========== - .. _gaussdb_04_0005__table14771167122611: .. table:: **Table 5** volume field data structure description @@ -175,7 +172,6 @@ Response ram String Memory size in GB. ===== ====== ================== - .. _gaussdb_04_0005__table578797132615: .. table:: **Table 7** backup_strategy field data structure description diff --git a/api-ref/source/api/managing_db_instances/querying_details_of_a_db_instance.rst b/api-ref/source/api/managing_db_instances/querying_details_of_a_db_instance.rst index 2cdaa9c..e9e4fbe 100644 --- a/api-ref/source/api/managing_db_instances/querying_details_of_a_db_instance.rst +++ b/api-ref/source/api/managing_db_instances/querying_details_of_a_db_instance.rst @@ -58,7 +58,6 @@ Response | | | For details, see :ref:`Table 3 `. | +-----------------------+-----------------------+------------------------------------------------------------------------+ - .. _gaussdb_04_0006__table2058713718267: .. table:: **Table 3** instance field data structure description @@ -114,7 +113,6 @@ Response | master_az_code | String | Primary AZ. | +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - .. _gaussdb_04_0006__table187591675262: .. table:: **Table 4** datastore field data structure description @@ -134,7 +132,6 @@ Response name String Parameter template name. ==== ====== ======================== - .. _gaussdb_04_0006__table37991653839: .. table:: **Table 6** backup_strategy field data structure description @@ -146,7 +143,6 @@ Response | keep_days | Integer | Backup retention days. | +------------+---------+----------------------------------------------------------------------------------------+ - .. _gaussdb_04_0006__table5182635134511: .. table:: **Table 7** nodes field data structure description @@ -188,7 +184,6 @@ Response | priority | String | Failover priority. | +------------------+-----------------+-------------------------------------------------------------------------+ - .. _gaussdb_04_0006__table14771167122611: .. table:: **Table 8** volume field data structure description diff --git a/api-ref/source/api/managing_parameter_templates/querying_a_parameter_template.rst b/api-ref/source/api/managing_parameter_templates/querying_a_parameter_template.rst index fc25af0..0b1c669 100644 --- a/api-ref/source/api/managing_parameter_templates/querying_a_parameter_template.rst +++ b/api-ref/source/api/managing_parameter_templates/querying_a_parameter_template.rst @@ -58,7 +58,6 @@ Response | total_count | Integer | Total number of parameter templates. | +-----------------------+-----------------------+------------------------------------------------------------------------+ - .. _gaussdb_04_0009__table1324110018258: .. table:: **Table 3** configurations field data structure description diff --git a/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst b/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst index 6ad80e9..737e34e 100644 --- a/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst +++ b/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst @@ -45,7 +45,6 @@ Request - Parameter description - .. _gaussdb_04_0012__table1453814912427: .. table:: **Table 2** quota_list field data structure description @@ -91,7 +90,6 @@ Response | | | For details, see :ref:`Table 4 `. | +-----------------------+-----------------------+-------------------------------------------------------------------+ - .. _gaussdb_04_0012__table66531170: .. table:: **Table 4** quota_list data structure description diff --git a/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst b/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst index ea0afa0..4fd1270 100644 --- a/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst +++ b/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst @@ -45,7 +45,6 @@ Request - Parameter description - .. _gaussdb_04_0013__table1252104315240: .. table:: **Table 2** quota_list field data structure description @@ -93,7 +92,6 @@ Response | | | For details, see :ref:`Table 4 `. | +-----------------------+-----------------------+-------------------------------------------------------------------+ - .. _gaussdb_04_0013__table66531170: .. table:: **Table 4** quota_list field data structure description diff --git a/api-ref/source/api/managing_quotas/querying_resource_quotas.rst b/api-ref/source/api/managing_quotas/querying_resource_quotas.rst index 633fdbd..42230cc 100644 --- a/api-ref/source/api/managing_quotas/querying_resource_quotas.rst +++ b/api-ref/source/api/managing_quotas/querying_resource_quotas.rst @@ -62,7 +62,6 @@ Response | total_count | Integer | Number of quota records. | +-----------------------+-----------------------+-------------------------------------------------------------------+ - .. _gaussdb_04_0011__table66531170: .. table:: **Table 3** quota_list field data structure description diff --git a/api-ref/source/api/obtaining_task_information.rst b/api-ref/source/api/obtaining_task_information.rst index 0e4154e..a2497a5 100644 --- a/api-ref/source/api/obtaining_task_information.rst +++ b/api-ref/source/api/obtaining_task_information.rst @@ -56,7 +56,6 @@ Response | job | Object | Task information. For details, see :ref:`Table 3 `. | +------+--------+-------------------------------------------------------------------------------------------+ - .. _gaussdb_04_0014__table54571314103317: .. table:: **Table 3** job field data structure description @@ -92,7 +91,6 @@ Response | fail_reason | String | Task failure information. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - .. _gaussdb_04_0014__table4062895917262: .. table:: **Table 4** instances field data structure description @@ -103,7 +101,6 @@ Response name String DB instance name. ==== ====== ================= - .. _gaussdb_04_0014__table1014617554138: .. table:: **Table 5** entities field data structure description @@ -117,7 +114,6 @@ Response | resource_ids | List | Resource ID involved in a task. | +-----------------------+-----------------------+-----------------------------------------------------------------------+ - .. _gaussdb_04_0014__table975183423611: .. 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: .. table:: **Table 7** datastore field data structure description diff --git a/api-ref/source/api/querying_database_specifications.rst b/api-ref/source/api/querying_database_specifications.rst index 1338106..8f1c9b5 100644 --- a/api-ref/source/api/querying_database_specifications.rst +++ b/api-ref/source/api/querying_database_specifications.rst @@ -68,7 +68,6 @@ Response | | | For details, see :ref:`Table 3 `. | +-----------------------+-----------------------+-------------------------------------------------------------------+ - .. _gaussdb_04_0002__table66531170: .. table:: **Table 3** flavors field data structure description diff --git a/api-ref/source/api/querying_version_information_about_a_db_engine.rst b/api-ref/source/api/querying_version_information_about_a_db_engine.rst index 042ece1..a0146fc 100644 --- a/api-ref/source/api/querying_version_information_about_a_db_engine.rst +++ b/api-ref/source/api/querying_version_information_about_a_db_engine.rst @@ -58,7 +58,6 @@ Response | | | For details, see :ref:`Table 3 `. | +-----------------------+-----------------------+-------------------------------------------------------------------+ - .. _gaussdb_04_0001__table66531170: .. table:: **Table 3** datastores field data structure description diff --git a/api-ref/source/appendix/obtaining_a_project_id.rst b/api-ref/source/appendix/obtaining_a_project_id.rst index c03b2d1..37d5f7f 100644 --- a/api-ref/source/appendix/obtaining_a_project_id.rst +++ b/api-ref/source/appendix/obtaining_a_project_id.rst @@ -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 ` - :ref:`Obtain a Project ID from the Console ` -.. _gaussdb_10_0004__section85791974381: 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 ------------------------------------ @@ -61,6 +59,4 @@ Obtain a Project ID from the Console .. figure:: /_static/images/en-us_image_0000001423128721.jpg - :alt: **Figure 1** Viewing project IDs - - **Figure 1** Viewing project IDs + :alt: diff --git a/api-ref/source/before_you_start/concepts.rst b/api-ref/source/before_you_start/concepts.rst index edf7788..a842aa6 100644 --- a/api-ref/source/before_you_start/concepts.rst +++ b/api-ref/source/before_you_start/concepts.rst @@ -29,6 +29,4 @@ Concepts .. figure:: /_static/images/en-us_image_0000001422968749.gif - :alt: **Figure 1** Project isolating model - - **Figure 1** Project isolating model + :alt: diff --git a/api-ref/source/calling_apis/making_an_api_request.rst b/api-ref/source/calling_apis/making_an_api_request.rst index ecdf93a..951a545 100644 --- a/api-ref/source/calling_apis/making_an_api_request.rst +++ b/api-ref/source/calling_apis/making_an_api_request.rst @@ -60,7 +60,6 @@ You can also add additional fields to a request, such as the fields required by :ref:`Table 3 ` lists common request header fields. -.. _gaussdb_03_0005__table1986821153312: .. table:: **Table 3** Common request headers diff --git a/api-ref/source/calling_apis/response.rst b/api-ref/source/calling_apis/response.rst index 81d86b9..36045f6 100644 --- a/api-ref/source/calling_apis/response.rst +++ b/api-ref/source/calling_apis/response.rst @@ -21,12 +21,9 @@ Similar to a request, a response also has a header, for example, **Content-Type* :ref:`Figure 1 ` shows the response header for the API used to `obtain a user token `__. The **x-subject-token** header field is the desired user token. This token can then be used to authenticate the calling of other APIs. -.. _gaussdb_03_0006__fig4865141011511: .. figure:: /_static/images/en-us_image_0000001372529646.png - :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 + :alt: (Optional) Response Body ------------------------ diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 56f0702..687eafc 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -18,7 +18,7 @@ import os import sys extensions = [ - 'otcdocstheme', + 'otcdocstheme' ] otcdocs_auto_name = False