Help Center/ EventGrid/ API Reference/ APIs/ Quota Management/ Obtaining the Quota
Updated on 2025-05-06 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Quota

Function

This API is used to obtain the quota of the current tenant. If no quota is configured, the default one is returned.

URI

GET /v1/{project_id}/quotas

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant resource space ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

No

String

Type of the resources for which the quota is to be queried.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token 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 user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

quotas

QuotaResourceResp object

Description about the quota.
Table 5 QuotaResourceResp

Parameter

Type

Description

resources

Array of QuotaItemInfo objects

Error description.
Table 6 QuotaItemInfo

Parameter

Type

Description

name

String

Name.

type

String

Quota type.

max

Integer

Maximum quota.

min

Integer

Minimum quota.

quota

Integer

Current quota.

used

Integer

Used quota.

Example Requests

Query the resource quotas.

GET https://{endpoint}/v1/{project_id}/quotas

Example Responses

Status code: 200

Operation successful.

{
  "quotas" : { }
}

Status Codes

Status Code

Description

200

Operation successful.

Error Codes

See Error Codes.

Parent topic: Quota Management