Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Quota Management/ Querying the Resource Quotas of a Specified Enterprise Project

Updated on 2025-07-29 GMT+08:00

View PDF

Querying the Resource Quotas of a Specified Enterprise Project

Function

This API is used to query the resource quotas of a specified enterprise project. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

Constraints

This API is in the open beta test (OBT) phase. To use this API, submit a service ticket.

URI

GET /v3/{project_id}/quotas

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	String	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be an integer and cannot be a negative number. Range ≥ 0 Default Value 0
limit	No	String	Definition Number of records to be queried. Constraints The value must be an integer and cannot be a negative number. Range 1–100 Default Value 100
enterprise_project_name	No	String	Definition Enterprise project name. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
quota_list	Array of quota objects	Definition Resource objects.
total_count	Integer	Definition Number of quota records. Range N/A

**Table 5** quota
Parameter	Type	Description
enterprise_project_id	String	Definition Enterprise project ID. Range N/A
enterprise_project_name	String	Definition Enterprise project name. Range N/A
instance_quota	Integer	Definition Instance quantity quota. The value -1 indicates no limit. Range N/A
vcpus_quota	Integer	Definition vCPU quota. The value -1 indicates no limit. Range N/A
ram_quota	Integer	Definition Memory quota, in GB. The value -1 indicates no limit. Range N/A
availability_instance_quota	Integer	Definition Remaining instance quota. The value -1 indicates no limit. Range N/A
availability_vcpus_quota	Integer	Definition Remaining vCPU quota. The value -1 indicates no limit. Range N/A
availability_ram_quota	Integer	Definition Remaining memory quota. The value -1 indicates no limit. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying resource quotas

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas

Example Response

Status code: 200

Success.

{
  "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
  } ]
}