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 a5637dc..6553e62 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,6 +113,7 @@ 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 @@ -124,6 +125,7 @@ Request | | | | Value: **postPaid** | +-----------------+-----------------+-----------------+---------------------+ +.. _gaussdb_04_0004__table64243102: .. table:: **Table 4** datastore field data structure description @@ -137,6 +139,7 @@ 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 @@ -198,53 +201,55 @@ 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 @@ -255,6 +260,7 @@ Response version String DB version. ======= ====== ============= + .. _gaussdb_04_0004__table81249589270: .. table:: **Table 9** backup_strategy field data structure description @@ -266,6 +272,7 @@ 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 8dfe4c6..3bd5d35 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,6 +84,7 @@ Response | total_count | Integer | Total number of records. | +-----------------------+-----------------------+------------------------------------------------------------------------+ + .. _gaussdb_04_0005__table2058713718267: .. table:: **Table 3** instances field data structure description @@ -143,6 +144,7 @@ Response | time_zone | String | Time zone. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + .. _gaussdb_04_0005__table187591675262: .. table:: **Table 4** datastore field data structure description @@ -153,6 +155,7 @@ Response version String DB version. ======= ====== =========== + .. _gaussdb_04_0005__table14771167122611: .. table:: **Table 5** volume field data structure description @@ -172,6 +175,7 @@ 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 e9e4fbe..2cdaa9c 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,6 +58,7 @@ Response | | | For details, see :ref:`Table 3 `. | +-----------------------+-----------------------+------------------------------------------------------------------------+ + .. _gaussdb_04_0006__table2058713718267: .. table:: **Table 3** instance field data structure description @@ -113,6 +114,7 @@ Response | master_az_code | String | Primary AZ. | +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + .. _gaussdb_04_0006__table187591675262: .. table:: **Table 4** datastore field data structure description @@ -132,6 +134,7 @@ Response name String Parameter template name. ==== ====== ======================== + .. _gaussdb_04_0006__table37991653839: .. table:: **Table 6** backup_strategy field data structure description @@ -143,6 +146,7 @@ Response | keep_days | Integer | Backup retention days. | +------------+---------+----------------------------------------------------------------------------------------+ + .. _gaussdb_04_0006__table5182635134511: .. table:: **Table 7** nodes field data structure description @@ -184,6 +188,7 @@ 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 0b1c669..fc25af0 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,6 +58,7 @@ 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 737e34e..6ad80e9 100644 --- a/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst +++ b/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst @@ -45,6 +45,7 @@ Request - Parameter description + .. _gaussdb_04_0012__table1453814912427: .. table:: **Table 2** quota_list field data structure description @@ -90,6 +91,7 @@ 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 4fd1270..ea0afa0 100644 --- a/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst +++ b/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst @@ -45,6 +45,7 @@ Request - Parameter description + .. _gaussdb_04_0013__table1252104315240: .. table:: **Table 2** quota_list field data structure description @@ -92,6 +93,7 @@ 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 42230cc..633fdbd 100644 --- a/api-ref/source/api/managing_quotas/querying_resource_quotas.rst +++ b/api-ref/source/api/managing_quotas/querying_resource_quotas.rst @@ -62,6 +62,7 @@ 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 a2497a5..0e4154e 100644 --- a/api-ref/source/api/obtaining_task_information.rst +++ b/api-ref/source/api/obtaining_task_information.rst @@ -56,6 +56,7 @@ Response | job | Object | Task information. For details, see :ref:`Table 3 `. | +------+--------+-------------------------------------------------------------------------------------------+ + .. _gaussdb_04_0014__table54571314103317: .. table:: **Table 3** job field data structure description @@ -91,6 +92,7 @@ Response | fail_reason | String | Task failure information. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + .. _gaussdb_04_0014__table4062895917262: .. table:: **Table 4** instances field data structure description @@ -101,6 +103,7 @@ Response name String DB instance name. ==== ====== ================= + .. _gaussdb_04_0014__table1014617554138: .. table:: **Table 5** entities field data structure description @@ -114,6 +117,7 @@ Response | resource_ids | List | Resource ID involved in a task. | +-----------------------+-----------------------+-----------------------------------------------------------------------+ + .. _gaussdb_04_0014__table975183423611: .. table:: **Table 6** entities.instance field data structure description @@ -127,6 +131,7 @@ 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 8f1c9b5..1338106 100644 --- a/api-ref/source/api/querying_database_specifications.rst +++ b/api-ref/source/api/querying_database_specifications.rst @@ -68,6 +68,7 @@ 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 a0146fc..042ece1 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,6 +58,7 @@ 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 37d5f7f..c03b2d1 100644 --- a/api-ref/source/appendix/obtaining_a_project_id.rst +++ b/api-ref/source/appendix/obtaining_a_project_id.rst @@ -13,6 +13,7 @@ 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 ------------------------------------------ @@ -47,6 +48,7 @@ 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 ------------------------------------ @@ -59,4 +61,6 @@ Obtain a Project ID from the Console .. figure:: /_static/images/en-us_image_0000001423128721.jpg - :alt: + :alt: **Figure 1** Viewing project IDs + + **Figure 1** Viewing project IDs diff --git a/api-ref/source/before_you_start/concepts.rst b/api-ref/source/before_you_start/concepts.rst index a842aa6..edf7788 100644 --- a/api-ref/source/before_you_start/concepts.rst +++ b/api-ref/source/before_you_start/concepts.rst @@ -29,4 +29,6 @@ Concepts .. figure:: /_static/images/en-us_image_0000001422968749.gif - :alt: + :alt: **Figure 1** Project isolating model + + **Figure 1** Project isolating model 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 951a545..ecdf93a 100644 --- a/api-ref/source/calling_apis/making_an_api_request.rst +++ b/api-ref/source/calling_apis/making_an_api_request.rst @@ -60,6 +60,7 @@ 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 36045f6..81d86b9 100644 --- a/api-ref/source/calling_apis/response.rst +++ b/api-ref/source/calling_apis/response.rst @@ -21,9 +21,12 @@ 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: + :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 (Optional) Response Body ------------------------