On this page

Show all

Help Center/ EventGrid/ API Reference/ APIs/ Quota Management/ Obtaining the Quota

Obtaining the Quota

Updated on 2023-05-24 GMT+08:00

View PDF

Function

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

URI

GET /v1/{project_id}/quotas

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Type of the resources for which the quota is to be queried. Enumeration values: CHANNEL CHANNEL_SUBSCRIPTION SOURCE SUBSCRIPTION SUBSCRIPTION_TARGET SCHEMA SCHEMA_VERSION CONNECTION PRIVATE_ENDPOINT SOURCE_RABBITMQ SOURCE_ROCKETMQ

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. Minimum: 1 Maximum: 16384

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. Enumeration values: CHANNEL CHANNEL_SUBSCRIPTION SOURCE SUBSCRIPTION SUBSCRIPTION_TARGET SCHEMA SCHEMA_VERSION CONNECTION PRIVATE_ENDPOINT SOURCE_RABBITMQ SOURCE_ROCKETMQ
max	Integer	Maximum quota.
min	Integer	Minimum quota.
quota	Integer	Current quota.
used	Integer	Used quota.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 1 Maximum: 128
error_msg	String	Error message. Minimum: 1 Maximum: 512
error_details	String	Error details. Minimum: 1 Maximum: 1024
request_id	String	Request ID. Minimum: 1 Maximum: 128

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 1 Maximum: 128
error_msg	String	Error message. Minimum: 1 Maximum: 512
error_details	String	Error details. Minimum: 1 Maximum: 1024
request_id	String	Request ID. Minimum: 1 Maximum: 128

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 1 Maximum: 128
error_msg	String	Error message. Minimum: 1 Maximum: 512
error_details	String	Error details. Minimum: 1 Maximum: 1024
request_id	String	Request ID. Minimum: 1 Maximum: 128

Status code: 404

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 1 Maximum: 128
error_msg	String	Error message. Minimum: 1 Maximum: 512
error_details	String	Error details. Minimum: 1 Maximum: 1024
request_id	String	Request ID. Minimum: 1 Maximum: 128

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 1 Maximum: 128
error_msg	String	Error message. Minimum: 1 Maximum: 512
error_details	String	Error details. Minimum: 1 Maximum: 1024
request_id	String	Request ID. Minimum: 1 Maximum: 128

Example Requests

None

Example Responses

Status code: 400

{
  "error_code" : "EG.00014000",
  "error_msg" : "Bad request"
}

Status code: 401

{
  "error_code" : "EG.00014010",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

{
  "error_code" : "EG.00014030",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

{
  "error_code" : "EG.00014040",
  "error_msg" : "Not request resource found"
}

Status code: 500

{
  "error_code" : "EG.00015000",
  "error_msg" : "Internal Server Error"
}

Status Codes

Status Code	Description
200	Operation successful.
400	Invalid request.
401	Unauthorized.
403	Access denied.
404	Resource not found.
500	Internal service error.

Error Codes

See Error Codes.

Parent topic: Quota Management

Previous topic: Quota Management

Next topic: API Version Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel