:original_name: gaussdb_04_0011.html
.. _gaussdb_04_0011:
Querying Resource Quotas
========================
Function
--------
This API is used to obtain the resource quotas of a specified enterprise project. Before using this API:
- Learn how to :ref:`authorize and authenticate ` it.
- Obtain the required :ref:`region and endpoint `.
URI
---
GET /v3/{project_id}/quotas
.. 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 | String | 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. Value: **0** to **10000** |
+-------------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | String | Number of records to be queried. The default value is **10**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. |
+-------------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_name | No | String | Enterprise project name. |
+-------------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
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 |
+=============+=================================================================+==========================+
| quota_list | Array of :ref:`quota ` objects | Resource list objects. |
+-------------+-----------------------------------------------------------------+--------------------------+
| total_count | Integer | Number of quota records. |
+-------------+-----------------------------------------------------------------+--------------------------+
.. _gaussdb_04_0011__response_quota:
.. table:: **Table 5** quota
=========================== ======= ==================================
Parameter Type Description
=========================== ======= ==================================
enterprise_project_id String Enterprise project ID.
enterprise_project_name String Enterprise project name.
instance_quota Integer Quota of the DB instance quantity.
vcpus_quota Integer Quota of vCPUs.
ram_quota Integer Memory quota in GB.
availability_instance_quota Integer Remaining quota of DB instances.
availability_vcpus_quota Integer Remaining quota of vCPUs.
availability_ram_quota Integer Remaining memory quota.
=========================== ======= ==================================
**Status code: 400**
.. table:: **Table 6** Response body parameters
========== ====== ==============
Parameter Type Description
========== ====== ==============
error_code String Error code.
error_msg String Error message.
========== ====== ==============
**Status code: 500**
.. table:: **Table 7** 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/quotas
Example Response
----------------
**Status code: 200**
Success.
.. code-block::
{
"quota_list" : [ {
"enterprise_project_id" : "0",
"enterprise_project_name" : "default",
"instance_quota" : 20,
"vcpus_quota" : 20,
"ram_quota" : 40,
"availability_instance_quota" : 1,
"availability_vcpus_quota" : 4,
"availability_ram_quota" : 8
} ]
}
Status Code
-----------
For details, see :ref:`Status Codes `.
Error Code
----------
For details, see :ref:`Error Codes `.