From d01f123ec6d43bb02a31af771f372e4393723759 Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Wed, 23 Nov 2022 02:23:55 +0000 Subject: [PATCH] Update content --- ...0.png => en-us_image_0000001372529646.png} | Bin ...8.gif => en-us_image_0000001422968749.gif} | Bin ...6.jpg => en-us_image_0000001423128721.jpg} | Bin api-ref/source/api/index.rst | 16 +- .../creating_a_db_instance.rst | 90 +++++----- .../deleting_a_db_instance.rst | 28 ++-- .../api/managing_db_instances/index.rst | 12 +- .../querying_a_db_instance_list.rst | 152 ++++++++--------- .../querying_details_of_a_db_instance.rst | 156 +++++++++--------- .../managing_parameter_templates/index.rst | 6 +- .../querying_a_parameter_template.rst | 96 +++++------ .../configuring_resource_quotas.rst | 50 +++--- api-ref/source/api/managing_quotas/index.rst | 10 +- .../modifying_resource_quotas.rst | 32 ++-- .../querying_resource_quotas.rst | 32 ++-- .../source/api/obtaining_task_information.rst | 146 ++++++++-------- .../api/querying_database_specifications.rst | 64 +++---- ..._version_information_about_a_db_engine.rst | 28 ++-- api-ref/source/api_overview.rst | 34 ++-- .../appendix/abnormal_request_results.rst | 18 +- api-ref/source/appendix/error_codes.rst | 10 +- .../gaussdbfor_mysql_monitoring_metrics.rst | 4 +- api-ref/source/appendix/index.rst | 14 +- .../appendix/obtaining_a_project_id.rst | 16 +- api-ref/source/appendix/status_codes.rst | 4 +- .../source/before_you_start/api_calling.rst | 2 +- api-ref/source/before_you_start/concepts.rst | 4 +- api-ref/source/before_you_start/overview.rst | 6 +- .../source/calling_apis/authentication.rst | 6 +- api-ref/source/calling_apis/index.rst | 10 +- .../calling_apis/making_an_api_request.rst | 12 +- api-ref/source/calling_apis/response.rst | 12 +- api-ref/source/change_history.rst | 15 +- api-ref/source/conf.py | 14 +- 34 files changed, 551 insertions(+), 548 deletions(-) rename api-ref/source/_static/images/{en-us_image_0264049300.png => en-us_image_0000001372529646.png} (100%) rename api-ref/source/_static/images/{en-us_image_0264049268.gif => en-us_image_0000001422968749.gif} (100%) rename api-ref/source/_static/images/{en-us_image_0264049266.jpg => en-us_image_0000001423128721.jpg} (100%) diff --git a/api-ref/source/_static/images/en-us_image_0264049300.png b/api-ref/source/_static/images/en-us_image_0000001372529646.png similarity index 100% rename from api-ref/source/_static/images/en-us_image_0264049300.png rename to api-ref/source/_static/images/en-us_image_0000001372529646.png diff --git a/api-ref/source/_static/images/en-us_image_0264049268.gif b/api-ref/source/_static/images/en-us_image_0000001422968749.gif similarity index 100% rename from api-ref/source/_static/images/en-us_image_0264049268.gif rename to api-ref/source/_static/images/en-us_image_0000001422968749.gif diff --git a/api-ref/source/_static/images/en-us_image_0264049266.jpg b/api-ref/source/_static/images/en-us_image_0000001423128721.jpg similarity index 100% rename from api-ref/source/_static/images/en-us_image_0264049266.jpg rename to api-ref/source/_static/images/en-us_image_0000001423128721.jpg diff --git a/api-ref/source/api/index.rst b/api-ref/source/api/index.rst index 863633b..008af25 100644 --- a/api-ref/source/api/index.rst +++ b/api-ref/source/api/index.rst @@ -1,16 +1,16 @@ -:original_name: rds_09_0000.html +:original_name: gaussdb_04_0000.html -.. _rds_09_0000: +.. _gaussdb_04_0000: API === -- :ref:`Querying Version Information About a DB Engine ` -- :ref:`Querying Database Specifications ` -- :ref:`Managing DB Instances ` -- :ref:`Managing Parameter Templates ` -- :ref:`Managing Quotas ` -- :ref:`Obtaining Task Information ` +- :ref:`Querying Version Information About a DB Engine ` +- :ref:`Querying Database Specifications ` +- :ref:`Managing DB Instances ` +- :ref:`Managing Parameter Templates ` +- :ref:`Managing Quotas ` +- :ref:`Obtaining Task Information ` .. toctree:: :maxdepth: 1 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 1f125fb..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 @@ -1,6 +1,6 @@ -:original_name: en-us_topic_0264049265.html +:original_name: gaussdb_04_0004.html -.. _en-us_topic_0264049265: +.. _gaussdb_04_0004: Creating a DB instance ====================== @@ -10,7 +10,7 @@ Function This API is used to create a GaussDB(for MySQL) DB instance -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -28,13 +28,13 @@ URI .. table:: **Table 1** Parameter description - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+========================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ Request ------- @@ -46,7 +46,7 @@ Request +==========================+=========================================================================================+=================+===========================================================================================================================================================================================================================================+ | charge_info | No | Object | Billing mode. | | | | | | - | | | | For details, see :ref:`Table 3 `. | + | | | | For details, see :ref:`Table 3 `. | +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | Yes | String | DB instance name. | | | | | | @@ -56,7 +56,7 @@ Request +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | datastore | Yes | Object | Database information. | | | | | | - | | | | For details, see :ref:`Table 4 `. | + | | | | For details, see :ref:`Table 4 `. | +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | mode | Yes | String | DB instance type. Currently, only the cluster type is supported. | +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,7 +91,7 @@ Request +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | backup_strategy | No | Object | Automated backup policy. | | | | | | - | | | | For details, see :ref:`Table 5 `. | + | | | | For details, see :ref:`Table 5 `. | +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | time_zone | No | String | UTC time zone. | | | | | | @@ -113,7 +113,7 @@ Request | enterprise_project_id | No | String | Enterprise project ID. This parameter is mandatory only when the enterprise project is enabled. | +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _en-us_topic_0264049265__table1935491614524: +.. _gaussdb_04_0004__table1935491614524: .. table:: **Table 3** charge_info field data structure description @@ -125,21 +125,21 @@ Request | | | | Value: **postPaid** | +-----------------+-----------------+-----------------+---------------------+ -.. _en-us_topic_0264049265__table64243102: +.. _gaussdb_04_0004__table64243102: .. table:: **Table 4** datastore field data structure description - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================+ - | type | Yes | String | DB engine. Currently, only gaussdb-mysql is supported. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | version | Yes | String | DB version. | - | | | | | - | | | | For details about supported DB versions, see section :ref:`Querying Version Information About a DB Engine `. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+===============================================================================================================================+ + | type | Yes | String | DB engine. Currently, only gaussdb-mysql is supported. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | version | Yes | String | DB version. | + | | | | | + | | | | For details about supported DB versions, see section :ref:`Querying Version Information About a DB Engine `. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ -.. _en-us_topic_0264049265__table0863181193416: +.. _gaussdb_04_0004__table0863181193416: .. table:: **Table 5** backup_strategy field data structure description @@ -191,17 +191,17 @@ Response .. table:: **Table 6** Parameter description - +-----------------------+-----------------------+------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==============================================================================+ - | instance | Object | DB instance information. | - | | | | - | | | For details, see :ref:`Table 7 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------+ - | job_id | String | DB instance creation task ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================+ + | instance | Object | DB instance information. | + | | | | + | | | For details, see :ref:`Table 7 `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------+ + | job_id | String | DB instance creation task ID. | + +-----------------------+-----------------------+-----------------------------------------------------------------------+ - .. _en-us_topic_0264049265__table175305610274: + .. _gaussdb_04_0004__table175305610274: .. table:: **Table 7** instance field data structure description @@ -216,9 +216,9 @@ Response +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | status | String | DB instance status. | +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore | Object | DB information. | + | datastore | Object | Database information. | | | | | - | | | For details, see :ref:`Table 8 `. | + | | | For details, see :ref:`Table 8 `. | +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | mode | String | DB instance type. Currently, only the cluster type is supported. | +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -228,7 +228,7 @@ Response +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | backup_strategy | Object | Automated backup policy. | | | | | - | | | For details, see :ref:`Table 9 `. | + | | | For details, see :ref:`Table 9 `. | +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | region | String | Region ID. | +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -246,10 +246,10 @@ Response +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | charge_info | Object | Billing mode. | | | | | - | | | For details, see :ref:`Table 10 `. | + | | | For details, see :ref:`Table 10 `. | +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - .. _en-us_topic_0264049265__table766045720277: + .. _gaussdb_04_0004__table766045720277: .. table:: **Table 8** datastore field data structure description @@ -260,7 +260,7 @@ Response version String DB version. ======= ====== ============= - .. _en-us_topic_0264049265__table81249589270: + .. _gaussdb_04_0004__table81249589270: .. table:: **Table 9** backup_strategy field data structure description @@ -272,7 +272,7 @@ Response | keep_days | Integer | Backup retention days. | +------------+---------+----------------------------------------------------------------------------------------+ - .. _en-us_topic_0264049265__table207147873611: + .. _gaussdb_04_0004__table207147873611: .. table:: **Table 10** charge_info field data structure description @@ -294,7 +294,7 @@ Response "instance":{ "id":"5eebbb4c0f9f4a99b42ed1b6334569aain07", "name":"gaussdb-2d34", - "status":"creating", + "status":"BUILD", "datastore":{ "type":"gaussdb-mysql", "version":"8.0" @@ -324,9 +324,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_db_instances/deleting_a_db_instance.rst b/api-ref/source/api/managing_db_instances/deleting_a_db_instance.rst index 17b2f15..caa7f8f 100644 --- a/api-ref/source/api/managing_db_instances/deleting_a_db_instance.rst +++ b/api-ref/source/api/managing_db_instances/deleting_a_db_instance.rst @@ -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 ====================== @@ -10,7 +10,7 @@ Function This API is used to delete a DB instance. -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -28,15 +28,15 @@ URI .. table:: **Table 1** Parameter description - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+========================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | instance_id | Yes | DB instance ID, which is compliant with the UUID format. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | instance_id | Yes | DB instance ID, which is compliant with the UUID format. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ Request ------- @@ -67,9 +67,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_db_instances/index.rst b/api-ref/source/api/managing_db_instances/index.rst index c641990..9e1ac64 100644 --- a/api-ref/source/api/managing_db_instances/index.rst +++ b/api-ref/source/api/managing_db_instances/index.rst @@ -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 ===================== -- :ref:`Creating a DB instance ` -- :ref:`Querying a DB Instance List ` -- :ref:`Querying Details of a DB Instance ` -- :ref:`Deleting a DB Instance ` +- :ref:`Creating a DB instance ` +- :ref:`Querying a DB Instance List ` +- :ref:`Querying Details of a DB Instance ` +- :ref:`Deleting a DB Instance ` .. toctree:: :maxdepth: 1 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 b129e2e..464bdef 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 @@ -1,6 +1,6 @@ -:original_name: en-us_topic_0264049278.html +:original_name: gaussdb_04_0005.html -.. _en-us_topic_0264049278: +.. _gaussdb_04_0005: Querying a DB Instance List =========================== @@ -10,7 +10,7 @@ Function This API is used to query a DB instance list according to search criteria. -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -33,15 +33,15 @@ URI +=================+=================+=================+=========================================================================================================================================================================================================================================+ | project_id | String | Yes | Project ID of a tenant in a region. | | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + | | | | To obtain this value, see :ref:`Obtaining a Project 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. | | | | | | - | | | | 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. | +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -74,77 +74,77 @@ Response .. table:: **Table 2** Parameter description - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================================+ - | instances | Array of objects | DB instance information. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | total_count | Integer | Total number of records. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+========================================================================+ + | instances | Array of objects | DB instance information. | + | | | | + | | | For details, see :ref:`Table 3 `. | + +-----------------------+-----------------------+------------------------------------------------------------------------+ + | total_count | Integer | Total number of records. | + +-----------------------+-----------------------+------------------------------------------------------------------------+ - .. _en-us_topic_0264049278__table2058713718267: + .. _gaussdb_04_0005__table2058713718267: .. table:: **Table 3** instances field data structure description - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================================================================================+ - | id | String | DB instance ID. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | DB instance name. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | DB instance status. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | private_ips | List | Private IP address for write. It is a blank string until an ECS is created. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | public_ips | List | Public IP address list. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | Integer | Database port number. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | DB instance type. The value is **Cluster**. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region | String | Region where the DB instance is deployed. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore | Object | Database information. | - | | | | - | | | For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. | - | | | | - | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as **+0800**. | - | | | | - | | | The value is empty unless the DB instance creation is complete. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated | String | Update time. The format is the same as that of the **created** field. | - | | | | - | | | The value is empty unless the DB instance creation is complete. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | db_user_name | String | Default username. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC ID. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Network ID of the subnet. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Security group ID. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_ref | String | Specification code. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_info | Object | Specification description. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volume | Object | Volume information. | - | | | | - | | | For details, see :ref:`Table 5 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_strategy | Object | Backup policy. | - | | | | - | | | For details, see :ref:`Table 7 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_zone | String | Time zone. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+====================================================================================================================+ + | id | String | DB instance ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | DB instance status. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | private_ips | List | Private IP address for write. It is a blank string until an ECS is created. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | public_ips | List | Public IP address list. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | port | Integer | Database port number. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | type | String | DB instance type. The value is **Cluster**. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | region | String | Region where the DB instance is deployed. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | datastore | Object | Database information. | + | | | | + | | | For details, see :ref:`Table 4 `. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + | | | | + | | | The value is empty unless the DB instance creation is complete. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time. The format is the same as that of the **created** field. | + | | | | + | | | The value is empty unless the DB instance creation is complete. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | db_user_name | String | Default username. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Network ID of the subnet. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | String | Specification code. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | flavor_info | Object | Specification description. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | volume | Object | Volume information. | + | | | | + | | | For details, see :ref:`Table 5 `. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | Object | Backup policy. | + | | | | + | | | For details, see :ref:`Table 7 `. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | time_zone | String | Time zone. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - .. _en-us_topic_0264049278__table187591675262: + .. _gaussdb_04_0005__table187591675262: .. table:: **Table 4** datastore field data structure description @@ -155,7 +155,7 @@ Response version String DB version. ======= ====== =========== - .. _en-us_topic_0264049278__table14771167122611: + .. _gaussdb_04_0005__table14771167122611: .. table:: **Table 5** volume field data structure description @@ -175,7 +175,7 @@ Response ram String Memory size in GB. ===== ====== ================== - .. _en-us_topic_0264049278__table578797132615: + .. _gaussdb_04_0005__table578797132615: .. table:: **Table 7** backup_strategy field data structure description @@ -232,9 +232,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. 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 3cca17d..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 @@ -1,6 +1,6 @@ -:original_name: en-us_topic_0264049244.html +:original_name: gaussdb_04_0006.html -.. _en-us_topic_0264049244: +.. _gaussdb_04_0006: Querying Details of a DB Instance ================================= @@ -10,7 +10,7 @@ Function This API is used to query the details of a specified DB instance. -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -28,15 +28,15 @@ URI .. table:: **Table 1** Parameter description - +-----------------+-----------------+-----------------+------------------------------------------------------------------------+ - | Name | Type | Mandatory | Description | - +=================+=================+=================+========================================================================+ - | project_id | String | Yes | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------+ - | instance_id | String | Yes | DB instance ID. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Name | Type | Mandatory | Description | + +=================+=================+=================+============================================================================+ + | project_id | String | Yes | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | String | Yes | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request ------- @@ -50,71 +50,71 @@ Response .. table:: **Table 2** Parameter description - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================================+ - | instance | Object | DB instance information. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+========================================================================+ + | instance | Object | DB instance information. | + | | | | + | | | For details, see :ref:`Table 3 `. | + +-----------------------+-----------------------+------------------------------------------------------------------------+ - .. _en-us_topic_0264049244__table2058713718267: + .. _gaussdb_04_0006__table2058713718267: .. table:: **Table 3** instance field data structure description - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+==================+====================================================================================================+ - | id | String | DB instance ID. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | name | String | DB instance name. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID of a tenant in a region. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | status | String | DB instance status. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | type | String | DB instance type. Currently, only the cluster type is supported. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | node_count | Integer | Number of nodes. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | datastore | Object | Database information. For details, see :ref:`Table 4 `. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | backup_used_space | Integer | Used backup space, in GB. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | created | String | DB instance creation time. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | updated | String | DB instance update time. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | public_ips | String | Public IP address of the DB instance. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | private_write_ips | Array of List | Private IP address for write. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | db_user_name | String | Default username. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | port | String | Database port number. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC ID. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | subnet_id | String | Subnet ID. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | security_group_id | String | Security group ID. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | volume | Object | Disk information. For details, see :ref:`Table 8 `. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | backup_strategy | Object | Backup policy. For details, see :ref:`Table 6 `. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | nodes | Arrays of object | Node information. For details, see :ref:`Table 7 `. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | time_zone | String | Time zone. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | az_mode | String | AZ. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ - | master_az_code | String | Primary AZ. | - +-----------------------+------------------+----------------------------------------------------------------------------------------------------+ + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+==================+=============================================================================================+ + | id | String | DB instance ID. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | name | String | DB instance name. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | project_id | String | Project ID of a tenant in a region. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | status | String | DB instance status. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | type | String | DB instance type. Currently, only the cluster type is supported. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | node_count | Integer | Number of nodes. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | datastore | Object | Database information. For details, see :ref:`Table 4 `. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | backup_used_space | Integer | Used backup space, in GB. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | created | String | DB instance creation time. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | updated | String | DB instance update time. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | public_ips | String | Public IP address of the DB instance. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | private_write_ips | Array of List | Private IP address for write. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | db_user_name | String | Default username. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | port | String | Database port number. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | subnet_id | String | Subnet ID. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | volume | Object | Disk information. For details, see :ref:`Table 8 `. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | backup_strategy | Object | Backup policy. For details, see :ref:`Table 6 `. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | nodes | Arrays of object | Node information. For details, see :ref:`Table 7 `. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | time_zone | String | Time zone. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | az_mode | String | AZ. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ + | master_az_code | String | Primary AZ. | + +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - .. _en-us_topic_0264049244__table187591675262: + .. _gaussdb_04_0006__table187591675262: .. table:: **Table 4** datastore field data structure description @@ -134,7 +134,7 @@ Response name String Parameter template name. ==== ====== ======================== - .. _en-us_topic_0264049244__table37991653839: + .. _gaussdb_04_0006__table37991653839: .. table:: **Table 6** backup_strategy field data structure description @@ -143,10 +143,10 @@ Response +============+=========+========================================================================================+ | start_time | String | Backup time window. Automated backups will be triggered during the backup time window. | +------------+---------+----------------------------------------------------------------------------------------+ - | Keep_days | Integer | Backup retention days. | + | keep_days | Integer | Backup retention days. | +------------+---------+----------------------------------------------------------------------------------------+ - .. _en-us_topic_0264049244__table5182635134511: + .. _gaussdb_04_0006__table5182635134511: .. table:: **Table 7** nodes field data structure description @@ -188,7 +188,7 @@ Response | priority | String | Failover priority. | +------------------+-----------------+-------------------------------------------------------------------------+ - .. _en-us_topic_0264049244__table14771167122611: + .. _gaussdb_04_0006__table14771167122611: .. table:: **Table 8** volume field data structure description @@ -297,9 +297,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_parameter_templates/index.rst b/api-ref/source/api/managing_parameter_templates/index.rst index 0ae8156..9288fcd 100644 --- a/api-ref/source/api/managing_parameter_templates/index.rst +++ b/api-ref/source/api/managing_parameter_templates/index.rst @@ -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 ============================ -- :ref:`Querying a Parameter Template ` +- :ref:`Querying a Parameter Template ` .. toctree:: :maxdepth: 1 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 9dfcccb..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 @@ -1,6 +1,6 @@ -:original_name: en-us_topic_0264049285.html +:original_name: gaussdb_04_0009.html -.. _en-us_topic_0264049285: +.. _gaussdb_04_0009: Querying a Parameter Template ============================= @@ -10,7 +10,7 @@ Function This API is used to obtain a parameter template list, including all databases' default and custom parameter templates. -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -28,13 +28,13 @@ URI .. table:: **Table 1** Parameter description - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+========================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ Request ------- @@ -48,46 +48,46 @@ Response .. table:: **Table 2** Parameter description - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================================+ - | configurations | Array of objects | Parameter template list. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | total_count | Integer | Total number of parameter templates. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+========================================================================+ + | configurations | Array of objects | Parameter template list. | + | | | | + | | | For details, see :ref:`Table 3 `. | + +-----------------------+-----------------------+------------------------------------------------------------------------+ + | total_count | Integer | Total number of parameter templates. | + +-----------------------+-----------------------+------------------------------------------------------------------------+ - .. _en-us_topic_0264049285__table1324110018258: + .. _gaussdb_04_0009__table1324110018258: .. table:: **Table 3** configurations field data structure description - +------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +========================+=======================+=======================================================================================================================================================================================================+ - | id | String | Parameter template ID. | - +------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Parameter template name. | - +------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Parameter template description. | - +------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore_version_name | String | DB version name. | - +------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore_name | String | DB name. | - +------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created | String | Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format. | - | | | | - | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as **+0800**. | - +------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated | String | Update time in the "yyyy-MM-ddTHH:mm:ssZ" format. | - | | | | - | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as **+0800**. | - +------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_defined | Boolean | Whether the parameter template is a custom template. | - | | | | - | | | - **false**: The parameter template is a default template. | - | | | - **true**: The parameter template is a custom template. | - +------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +========================+=======================+====================================================================================================================+ + | id | String | Parameter template ID. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Parameter template name. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Parameter template description. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | datastore_version_name | String | DB version name. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | datastore_name | String | DB name. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time in the "yyyy-MM-ddTHH:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | user_defined | Boolean | Whether the parameter template is a custom template. | + | | | | + | | | - **false**: The parameter template is a default template. | + | | | - **true**: The parameter template is a custom template. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - Example normal response @@ -111,9 +111,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. 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 e0c8b9f..6ad80e9 100644 --- a/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst +++ b/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst @@ -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 =========================== @@ -10,7 +10,7 @@ Function This API is used to set resource quotas for a specified enterprise project. -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -28,24 +28,24 @@ URI .. table:: **Table 1** Parameter description - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+===========================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | quota_list | Yes | Quota details. A maximum of 10 quota records can be configured at a time. | - | | | | - | | | For details, see :ref:`Table 2 `. | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | quota_list | Yes | Quota details. A maximum of 10 quota records can be configured at a time. | + | | | | + | | | For details, see :ref:`Table 2 `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ Request ------- - Parameter description - .. _rds_06_0002__table1453814912427: + .. _gaussdb_04_0012__table1453814912427: .. table:: **Table 2** quota_list field data structure description @@ -83,15 +83,15 @@ Response .. table:: **Table 3** Parameter description - +-----------------------+-----------------------+---------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================+ - | quota_list | Array of objects | Configured quota information. | - | | | | - | | | For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+---------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===================================================================+ + | quota_list | Array of objects | Configured quota information. | + | | | | + | | | For details, see :ref:`Table 4 `. | + +-----------------------+-----------------------+-------------------------------------------------------------------+ - .. _rds_06_0002__table66531170: + .. _gaussdb_04_0012__table66531170: .. table:: **Table 4** quota_list data structure description @@ -122,9 +122,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_quotas/index.rst b/api-ref/source/api/managing_quotas/index.rst index d9aefb6..1981941 100644 --- a/api-ref/source/api/managing_quotas/index.rst +++ b/api-ref/source/api/managing_quotas/index.rst @@ -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 =============== -- :ref:`Querying Resource Quotas ` -- :ref:`Configuring Resource Quotas ` -- :ref:`Modifying Resource Quotas ` +- :ref:`Querying Resource Quotas ` +- :ref:`Configuring Resource Quotas ` +- :ref:`Modifying Resource Quotas ` .. toctree:: :maxdepth: 1 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 4141dae..ea0afa0 100644 --- a/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst +++ b/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst @@ -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 ========================= @@ -10,7 +10,7 @@ Function This API is used to modify the resource quota of a specified enterprise project. -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -33,11 +33,11 @@ URI +=======================+=======================+====================================================================================================+ | project_id | Yes | Project ID of a tenant in a region. | | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ | 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 `. | + | | | For details, see :ref:`Table 2 `. | +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ Request @@ -45,7 +45,7 @@ Request - Parameter description - .. _rds_04_0002__table1252104315240: + .. _gaussdb_04_0013__table1252104315240: .. table:: **Table 2** quota_list field data structure description @@ -85,15 +85,15 @@ Response .. table:: **Table 3** Parameter description - +-----------------------+-----------------------+---------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================+ - | quota_list | Array of objects | Configured quota information. | - | | | | - | | | For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+---------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===================================================================+ + | quota_list | Array of objects | Configured quota information. | + | | | | + | | | For details, see :ref:`Table 4 `. | + +-----------------------+-----------------------+-------------------------------------------------------------------+ - .. _rds_04_0002__table66531170: + .. _gaussdb_04_0013__table66531170: .. table:: **Table 4** quota_list field data structure description @@ -124,9 +124,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. 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 98c43cc..633fdbd 100644 --- a/api-ref/source/api/managing_quotas/querying_resource_quotas.rst +++ b/api-ref/source/api/managing_quotas/querying_resource_quotas.rst @@ -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 ======================== @@ -10,7 +10,7 @@ Function This API is used to obtain the resource quota of a specified enterprise project. -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -33,7 +33,7 @@ URI +=======================+=======================+=========================================================================================================================================================================================================================================+ | project_id | Yes | Project ID of a tenant in a region. | | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 - +-----------------------+-----------------------+---------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================+ - | quota_list | Array of objects | Quota information list. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+---------------------------------------------------------------+ - | total_count | Integer | Number of quota records. | - +-----------------------+-----------------------+---------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===================================================================+ + | quota_list | Array of objects | Quota information list. | + | | | | + | | | For details, see :ref:`Table 3 `. | + +-----------------------+-----------------------+-------------------------------------------------------------------+ + | total_count | Integer | Number of quota records. | + +-----------------------+-----------------------+-------------------------------------------------------------------+ - .. _rds_06_0001__table66531170: + .. _gaussdb_04_0011__table66531170: .. table:: **Table 3** quota_list field data structure description @@ -108,9 +108,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/obtaining_task_information.rst b/api-ref/source/api/obtaining_task_information.rst index 6ad200c..0e4154e 100644 --- a/api-ref/source/api/obtaining_task_information.rst +++ b/api-ref/source/api/obtaining_task_information.rst @@ -1,6 +1,6 @@ -:original_name: en-us_topic_0264049301.html +:original_name: gaussdb_04_0014.html -.. _en-us_topic_0264049301: +.. _gaussdb_04_0014: Obtaining Task Information ========================== @@ -10,7 +10,7 @@ Function This API is used to obtain task information from the task center. -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -28,15 +28,15 @@ URI .. table:: **Table 1** Parameter description - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+========================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | id | Yes | Task ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | id | Yes | Task ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ Request ------- @@ -50,49 +50,49 @@ Response .. table:: **Table 2** Parameter description - +------+--------+--------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +======+========+==================================================================================================+ - | job | Object | Task information. For details, see :ref:`Table 3 `. | - +------+--------+--------------------------------------------------------------------------------------------------+ + +------+--------+-------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +======+========+===========================================================================================+ + | job | Object | Task information. For details, see :ref:`Table 3 `. | + +------+--------+-------------------------------------------------------------------------------------------+ - .. _en-us_topic_0264049301__table54571314103317: + .. _gaussdb_04_0014__table54571314103317: .. table:: **Table 3** job field data structure description - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================================================================================+ - | id | String | Task ID. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Task name. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Task execution status. | - | | | | - | | | Valid value: | - | | | | - | | | - **Running**: The task is being executed. | - | | | - **Completed**: The task is successfully executed. | - | | | - **Failed**: The task fails to be executed. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. | - | | | | - | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as **+0800**. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | process | String | Task execution progress. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance | Object | DB instance on which the task is executed. | - | | | | - | | | For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | entities | Object | Displayed information varies depending on tasks. | - | | | | - | | | For details, see :ref:`Table 5 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fail_reason | String | Task failure information. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+====================================================================================================================+ + | id | String | Task ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Task name. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Task execution status. | + | | | | + | | | Valid value: | + | | | | + | | | - **Running**: The task is being executed. | + | | | - **Completed**: The task is successfully executed. | + | | | - **Failed**: The task fails to be executed. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | process | String | Task execution progress. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | instance | Object | DB instance on which the task is executed. | + | | | | + | | | For details, see :ref:`Table 4 `. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | entities | Object | Displayed information varies depending on tasks. | + | | | | + | | | For details, see :ref:`Table 5 `. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | fail_reason | String | Task failure information. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - .. _en-us_topic_0264049301__table4062895917262: + .. _gaussdb_04_0014__table4062895917262: .. table:: **Table 4** instances field data structure description @@ -103,35 +103,35 @@ Response name String DB instance name. ==== ====== ================= - .. _en-us_topic_0264049301__table1014617554138: + .. _gaussdb_04_0014__table1014617554138: .. table:: **Table 5** entities field data structure description - +-----------------------+-----------------------+------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==============================================================================+ - | instance | Object | DB instance queried in the task. | - | | | | - | | | For details, see :ref:`Table 6 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------+ - | resource_ids | List | Resource ID involved in a task. | - +-----------------------+-----------------------+------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================+ + | instance | Object | DB instance queried in the task. | + | | | | + | | | For details, see :ref:`Table 6 `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------+ + | resource_ids | List | Resource ID involved in a task. | + +-----------------------+-----------------------+-----------------------------------------------------------------------+ - .. _en-us_topic_0264049301__table975183423611: + .. _gaussdb_04_0014__table975183423611: .. table:: **Table 6** entities.instance field data structure description - +-----------+--------+----------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +===========+========+==============================================================================================+ - | endpoint | String | DB instance connection address. | - +-----------+--------+----------------------------------------------------------------------------------------------+ - | type | String | DB instance type. | - +-----------+--------+----------------------------------------------------------------------------------------------+ - | datastore | Object | DB information. For details, see :ref:`Table 7 `. | - +-----------+--------+----------------------------------------------------------------------------------------------+ + +-----------+--------+---------------------------------------------------------------------------------------+ + | Name | Type | Description | + +===========+========+=======================================================================================+ + | endpoint | String | DB instance connection address. | + +-----------+--------+---------------------------------------------------------------------------------------+ + | type | String | DB instance type. | + +-----------+--------+---------------------------------------------------------------------------------------+ + | datastore | Object | DB information. For details, see :ref:`Table 7 `. | + +-----------+--------+---------------------------------------------------------------------------------------+ - .. _en-us_topic_0264049301__table173094268581: + .. _gaussdb_04_0014__table173094268581: .. table:: **Table 7** datastore field data structure description @@ -178,9 +178,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/querying_database_specifications.rst b/api-ref/source/api/querying_database_specifications.rst index 1ca2ad3..1338106 100644 --- a/api-ref/source/api/querying_database_specifications.rst +++ b/api-ref/source/api/querying_database_specifications.rst @@ -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 ================================ @@ -10,7 +10,7 @@ Function This API is used to query the database specifications of a specified DB engine version. -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -28,25 +28,25 @@ URI .. table:: **Table 1** Parameter description - +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +========================+=================+=================+==============================================================================================================================+ - | project_id | Yes | String | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ - | database | Yes | String | DB engine. Its value can be any of the following and is case-insensitive: | - | | | | | - | | | | - gaussdb-mysql | - +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ - | version_name | No | String | DB version number. To obtain this value, see :ref:`Querying Version Information About a DB Engine `. | - | | | | | - | | | | Currently, only MySQL 8.0 is supported. | - +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone_mode | Yes | String | AZ type of the specification. The value can be **single** or **multi**. | - +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ - | spec_code | No | String | Specification code. | - +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +========================+=================+=================+=======================================================================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | database | Yes | String | DB engine. Its value can be any of the following and is case-insensitive: | + | | | | | + | | | | - gaussdb-mysql | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | version_name | No | String | DB version number. To obtain this value, see :ref:`Querying Version Information About a DB Engine `. | + | | | | | + | | | | Currently, only MySQL 8.0 is supported. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | availability_zone_mode | Yes | String | AZ type of the specification. The value can be **single** or **multi**. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | spec_code | No | String | Specification code. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ Request ------- @@ -60,15 +60,15 @@ Response .. table:: **Table 2** Parameter description - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================+ - | flavors | Array of objects | DB instance specification list. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===================================================================+ + | flavors | Array of objects | DB instance specification list. | + | | | | + | | | For details, see :ref:`Table 3 `. | + +-----------------------+-----------------------+-------------------------------------------------------------------+ - .. _en-us_topic_0264049275__table66531170: + .. _gaussdb_04_0002__table66531170: .. table:: **Table 3** flavors field data structure description @@ -134,9 +134,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. 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 bcca2db..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 @@ -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 ============================================== @@ -10,7 +10,7 @@ Function This API is used to query the DB version information of a specified DB engine. -- Learn how to :ref:`authorize and authenticate ` this API before using it. +- Learn how to :ref:`authorize and authenticate ` this API before using it. - Before calling this API, obtain the required :ref:`region and endpoint `. URI @@ -33,7 +33,7 @@ URI +=======================+=======================+===================================================================================+ | project_id | Yes | Project ID of a tenant in a region. | | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ | 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 - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================+ - | datastores | Array of objects | DB version list. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===================================================================+ + | datastores | Array of objects | DB version list. | + | | | | + | | | For details, see :ref:`Table 3 `. | + +-----------------------+-----------------------+-------------------------------------------------------------------+ - .. _en-us_topic_0264049311__table66531170: + .. _gaussdb_04_0001__table66531170: .. table:: **Table 3** datastores field data structure description @@ -84,9 +84,9 @@ Response Status Code ----------- -For details, see :ref:`Status Codes `. +For details, see :ref:`Status Codes `. Error Code ---------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api_overview.rst b/api-ref/source/api_overview.rst index b66bcb5..1c9e176 100644 --- a/api-ref/source/api_overview.rst +++ b/api-ref/source/api_overview.rst @@ -1,24 +1,24 @@ -:original_name: rds_02_0000.html +:original_name: gaussdb_02_0000.html -.. _rds_02_0000: +.. _gaussdb_02_0000: API Overview ============ With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas. -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Type | Description | -+===============================+===================================================================================================================================================================================================+ -| 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 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. | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Parameter template management | Query parameter templates. | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Quota management | Query, set, and modify resource quotas. | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Task information query | Obtain task information about the task center. | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| Type | Description | ++===============================+===============================================================================================================================================+ +| 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 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. | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| Quota management | Query, set, and modify resource quotas. | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| Task information query | Obtain task information about the task center. | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendix/abnormal_request_results.rst b/api-ref/source/appendix/abnormal_request_results.rst index 519d547..fc0d398 100644 --- a/api-ref/source/appendix/abnormal_request_results.rst +++ b/api-ref/source/appendix/abnormal_request_results.rst @@ -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 ======================== @@ -9,13 +9,13 @@ Abnormal Request Results .. table:: **Table 1** Abnormal response description - +------------+--------+-----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +============+========+=================================================================================================================+ - | error_code | String | Returned error code when a task submission exception occurs. For details, see :ref:`Error Codes `. | - +------------+--------+-----------------------------------------------------------------------------------------------------------------+ - | error_msg | String | Returned error description when a task submission exception occurs. | - +------------+--------+-----------------------------------------------------------------------------------------------------------------+ + +------------+--------+---------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+========+=====================================================================================================================+ + | error_code | String | Returned error code when a task submission exception occurs. For details, see :ref:`Error Codes `. | + +------------+--------+---------------------------------------------------------------------------------------------------------------------+ + | error_msg | String | Returned error description when a task submission exception occurs. | + +------------+--------+---------------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/appendix/error_codes.rst b/api-ref/source/appendix/error_codes.rst index 614688d..dfa5a25 100644 --- a/api-ref/source/appendix/error_codes.rst +++ b/api-ref/source/appendix/error_codes.rst @@ -1,6 +1,6 @@ -:original_name: rds_10_0201.html +:original_name: gaussdb_10_0003.html -.. _rds_10_0201: +.. _gaussdb_10_0003: Error Codes =========== @@ -18,8 +18,6 @@ The following table describes error codes. +------------+---------------+-------------------------------------------------------------------------------------------------+ | 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.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.280432 | 400 | Invalid duration for yearly/monthly DB instances. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ | DBS.280433 | 400 | Invalid enterprise project ID. | +------------+---------------+-------------------------------------------------------------------------------------------------+ | DBS.280434 | 400 | Invalid specification code | @@ -82,7 +78,7 @@ The following table describes error codes. +------------+---------------+-------------------------------------------------------------------------------------------------+ | 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. | +------------+---------------+-------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst b/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst index d2b0548..c83fa50 100644 --- a/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst +++ b/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst @@ -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 ===================================== diff --git a/api-ref/source/appendix/index.rst b/api-ref/source/appendix/index.rst index 14df032..414b142 100644 --- a/api-ref/source/appendix/index.rst +++ b/api-ref/source/appendix/index.rst @@ -1,15 +1,15 @@ -:original_name: rds_01_0000.html +:original_name: gaussdb_10_0000.html -.. _rds_01_0000: +.. _gaussdb_10_0000: Appendix ======== -- :ref:`Abnormal Request Results ` -- :ref:`Status Codes ` -- :ref:`Error Codes ` -- :ref:`Obtaining a Project ID ` -- :ref:`GaussDB(for MySQL) Monitoring Metrics ` +- :ref:`Abnormal Request Results ` +- :ref:`Status Codes ` +- :ref:`Error Codes ` +- :ref:`Obtaining a Project ID ` +- :ref:`GaussDB(for MySQL) Monitoring Metrics ` .. toctree:: :maxdepth: 1 diff --git a/api-ref/source/appendix/obtaining_a_project_id.rst b/api-ref/source/appendix/obtaining_a_project_id.rst index b982e94..c03b2d1 100644 --- a/api-ref/source/appendix/obtaining_a_project_id.rst +++ b/api-ref/source/appendix/obtaining_a_project_id.rst @@ -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 ====================== @@ -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: -- :ref:`Obtaining the Project ID by Calling an API ` -- :ref:`Obtain a Project ID from the Console ` +- :ref:`Obtaining the Project ID by Calling an API ` +- :ref:`Obtain a Project ID from the Console ` -.. _rds_03_0002__section85791974381: +.. _gaussdb_10_0004__section85791974381: 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 `__. For details about API authentication, see :ref:`Authentication `. +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 `__. For details about API authentication, see :ref:`Authentication `. 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 ------------------------------------ @@ -60,7 +60,7 @@ Obtain a Project ID from the Console 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 **Figure 1** Viewing project IDs diff --git a/api-ref/source/appendix/status_codes.rst b/api-ref/source/appendix/status_codes.rst index 0f077ab..727eb55 100644 --- a/api-ref/source/appendix/status_codes.rst +++ b/api-ref/source/appendix/status_codes.rst @@ -1,6 +1,6 @@ -:original_name: rds_10_0200.html +:original_name: gaussdb_10_0002.html -.. _rds_10_0200: +.. _gaussdb_10_0002: Status Codes ============ diff --git a/api-ref/source/before_you_start/api_calling.rst b/api-ref/source/before_you_start/api_calling.rst index 1fd77f4..d5add04 100644 --- a/api-ref/source/before_you_start/api_calling.rst +++ b/api-ref/source/before_you_start/api_calling.rst @@ -5,4 +5,4 @@ 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 `. +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 `. diff --git a/api-ref/source/before_you_start/concepts.rst b/api-ref/source/before_you_start/concepts.rst index 19345d2..edf7788 100644 --- a/api-ref/source/before_you_start/concepts.rst +++ b/api-ref/source/before_you_start/concepts.rst @@ -25,10 +25,10 @@ Concepts - 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 **Figure 1** Project isolating model diff --git a/api-ref/source/before_you_start/overview.rst b/api-ref/source/before_you_start/overview.rst index 5f8b6b3..5ace8db 100644 --- a/api-ref/source/before_you_start/overview.rst +++ b/api-ref/source/before_you_start/overview.rst @@ -5,8 +5,6 @@ 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 `. -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 `. - -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*. +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*. diff --git a/api-ref/source/calling_apis/authentication.rst b/api-ref/source/calling_apis/authentication.rst index 0262946..0a507ac 100644 --- a/api-ref/source/calling_apis/authentication.rst +++ b/api-ref/source/calling_apis/authentication.rst @@ -1,6 +1,6 @@ -:original_name: rds_03_0001.html +:original_name: gaussdb_03_0001.html -.. _rds_03_0001: +.. _gaussdb_03_0001: 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. -In :ref:`Making an API Request `, the process of calling the API used to `obtain a user token `__ is described. +In :ref:`Making an API Request `, the process of calling the API used to `obtain a user token `__ 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: diff --git a/api-ref/source/calling_apis/index.rst b/api-ref/source/calling_apis/index.rst index 83bf7f6..308827b 100644 --- a/api-ref/source/calling_apis/index.rst +++ b/api-ref/source/calling_apis/index.rst @@ -1,13 +1,13 @@ -:original_name: rds_02_0001.html +:original_name: gaussdb_03_0000.html -.. _rds_02_0001: +.. _gaussdb_03_0000: Calling APIs ============ -- :ref:`Making an API Request ` -- :ref:`Authentication ` -- :ref:`Response ` +- :ref:`Making an API Request ` +- :ref:`Authentication ` +- :ref:`Response ` .. toctree:: :maxdepth: 1 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 5612dc1..ecdf93a 100644 --- a/api-ref/source/calling_apis/making_an_api_request.rst +++ b/api-ref/source/calling_apis/making_an_api_request.rst @@ -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 ===================== @@ -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. -:ref:`Table 3 ` lists common request header fields. +:ref:`Table 3 ` lists common request header fields. -.. _rds_03_0005__table1986821153312: +.. _gaussdb_03_0005__table1986821153312: .. 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 | +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+--------------------------------------------+ - | X-Project-Id | Specifies the project ID. Obtain the project ID by following the instructions in :ref:`Obtaining a Project ID `. | No | e9993fc787d94b6c886cbaa340f9c0f4 | + | X-Project-Id | Specifies the project ID. Obtain the project ID by following the instructions in :ref:`Obtaining a Project ID `. | No | e9993fc787d94b6c886cbaa340f9c0f4 | +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+--------------------------------------------+ | 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 `. +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 `. For example, if status code **201** is returned for calling the API used to `obtain a user token `__, the request is successful. @@ -19,11 +19,11 @@ Response Header 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. +: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. -.. _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 **Figure 1** Header fields of the response to the request for obtaining a user token diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 60e76e9..75d9734 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -5,8 +5,13 @@ Change History ============== -=========== ========================================= -Released On Description -=========== ========================================= -2020-05-30 This issue is the first official release. -=========== ========================================= ++-----------------------------------+-------------------------------------------------------------------------------------+ +| Released On | Description | ++===================================+=====================================================================================+ +| 2022-10-30 | This issue is the second official release. | +| | | +| | - Optimized the content in :ref:`Querying a Parameter Template `. | +| | - Optimized the content in :ref:`Querying a DB Instance List `. | ++-----------------------------------+-------------------------------------------------------------------------------------+ +| 2020-05-30 | This issue is the first official release. | ++-----------------------------------+-------------------------------------------------------------------------------------+ diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 9424a7c..d67562c 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -26,6 +26,9 @@ otcdocs_auto_version = False project = 'GaussDB Enterprise-class Distributed Database compatible with 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, # add these directories to sys.path here. If the directory is relative to the @@ -72,11 +75,12 @@ show_authors = False html_theme = 'otcdocs' # Theme options are theme-specific and customize the look and feel of a theme -# 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. html_theme_options = { - 'disable_search': True, - 'site_name': 'Internal Documentation Portal' + "disable_search": True, + "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 @@ -92,8 +96,8 @@ html_static_path = ['_static'] # -- Options for PDF output -------------------------------------------------- latex_documents = [ -('index', + ('index', 'gaussdb_mysql-api-ref.tex', u'GaussDB Enterprise-class Distributed Database compatible with MySQL - API Reference', u'OpenTelekomCloud', 'manual'), -] \ No newline at end of file +]