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

Updated on 2024-09-11 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	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

**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 range: 0–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 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
quota_list	Array of quota objects	Resource list objects.
total_count	Integer	Number of quota records.

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

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