diff --git a/api-ref/source/apis_recommended/managing_db_instances/index.rst b/api-ref/source/apis_recommended/managing_db_instances/index.rst index e7966fb..bdadb1e 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/index.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/index.rst @@ -14,6 +14,7 @@ Managing DB Instances - :ref:`Changing a DB Instance Name ` - :ref:`Resetting a Database Password ` - :ref:`Changing DB Instance Specifications ` +- :ref:`Querying Dedicated Resource Pools ` - :ref:`Changing the Collection Period of Monitoring by Seconds ` - :ref:`Querying the Collection Period of Monitoring by Seconds ` @@ -30,5 +31,6 @@ Managing DB Instances changing_a_db_instance_name resetting_a_database_password changing_db_instance_specifications + querying_dedicated_resource_pools changing_the_collection_period_of_monitoring_by_seconds querying_the_collection_period_of_monitoring_by_seconds diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_dedicated_resource_pools.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_dedicated_resource_pools.rst new file mode 100644 index 0000000..bedd9ec --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/querying_dedicated_resource_pools.rst @@ -0,0 +1,171 @@ +:original_name: ListGaussMySqlDedicatedResources.html + +.. _ListGaussMySqlDedicatedResources: + +Querying Dedicated Resource Pools +================================= + +Function +-------- + +This API is used to obtain information about all dedicated resource pools you created. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/dedicated-resources + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | 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 `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+=======================================================================================================================================================================================================================================+ + | offset | No | Integer | Index offset. 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. | + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of records to be queried. The default value is **100**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. | + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-------------+---------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ + | Parameter | Type | Description | + +=============+=======================================================================================================================================+======================================+ + | resources | Array of :ref:`DedicatedResource ` objects | Dedicated resource pool information. | + +-------------+---------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ + | total_count | Integer | Number of dedicated resource pools. | + +-------------+---------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ + +.. _listgaussmysqldedicatedresources__en-us_topic_0000001244880767_response_dedicatedresource: + +.. table:: **Table 5** DedicatedResource + + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=============================================================================================================================================+===================================================+ + | id | String | ID of the dedicated resource pool. | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ + | resource_name | String | Name of the dedicated resource pool. | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ + | engine_name | String | DB engine. | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ + | architecture | String | CPU architecture. | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ + | status | String | Status of the dedicated resource pool. | + | | | | + | | | Valid value: | + | | | | + | | | - **NORMAL** | + | | | - **BUILDING** | + | | | - **EXTENDING** | + | | | - **DELETED** | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ + | capacity | :ref:`DedicatedResourceCapacity ` object | Capacity of the dedicated resource pool. | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ + | availability_zone | Array of strings | AZ where the dedicated resource pool is deployed. | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ + +.. _listgaussmysqldedicatedresources__en-us_topic_0000001244880767_response_dedicatedresourcecapacity: + +.. table:: **Table 6** DedicatedResourceCapacity + + ========= ======= ==================== + Parameter Type Description + ========= ======= ==================== + ram Integer Memory size in GB. + volume Long Disk capacity in GB. + vcpus Integer Number of vCPUs. + ========= ======= ==================== + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/dedicated-resources + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "resources" : [ { + "id" : "1d07f7ba-f140-46a7-b002-58ba22ee6ff3", + "resource_name" : "testdcc", + "engine_name" : "gaussdb-mysql", + "architecture" : "ARM", + "status" : "NORMAL", + "capacity" : { + "ram" : 256, + "volume" : 10000000, + "vcpus" : 64 + }, + "availability_zone" : [ "az1xahz" ] + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index a5da4ab..0a752b7 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,10 @@ Change History +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | Released On | Description | +===================================+===========================================================================================================================+ +| 2023-05-15 | Modified the following content: | +| | | +| | Added :ref:`Querying Dedicated Resource Pools `. | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | 2023-04-06 | Modified the following content: | | | | | | - Deleted the parameter **backup_level** in :ref:`Querying Backups `. |