Files

chenjunjie 719d8b18de RocketMQ API 20250723 version

Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>

2026-03-18 20:25:09 +00:00

11 KiB

Raw Blame History

Querying Tenant Quotas

Function

This API is used to query the maximum number of instances that a tenant can create, the number of created instances, and the maximum number of tags that can be created for each instance.

URI

GET /v2/{project_id}/quotas

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
includeTagsQuota	No	String	Definition Whether a tag quota flag is included. Constraints N/A Range true: Yes false: No Default Value true
onlyQuota	No	String	Definition Queries a specified quota engine. Constraints N/A Range reliability: RocketMQ message engine alias. kafka: Kafka message engine alias. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
quotas	quotas object	Definition Quota information. Constraints N/A Range N/A Default Value N/A

**Table 4** quotas
Parameter	Type	Description
resources	Array of QuotaResourceEntity objects	Definition Quota list. Constraints N/A Range N/A Default Value N/A

**Table 5** QuotaResourceEntity
Parameter	Type	Description
type	String	Definition Supports kafkaInstance, rocketmqInstance, and tags. kafkaInstance: Kafka instance quotas rocketmqInstance: RocketMQ instance quotas tags: Tag quotas kafkaInstancePublic: Kafka public network quotas (deprecated). Constraints N/A Range N/A Default Value N/A
quota	Integer	Definition The maximum number of instances that a tenant can create, or the maximum number of tags that can be created for each instance. Constraints N/A Range N/A Default Value N/A
used	Integer	Definition Number of created instances. Constraints N/A Range N/A Default Value N/A

Example Requests

GET https://{endpoint}/v2/{project_id}/quotas?includeTagsQuota=false&onlyQuota=reliability

Example Responses

Status code: 200

Successful

{
  "quotas" : {
    "resources" : [ {
      "type" : "rocketmqInstance",
      "quota" : 100,
      "used" : 17
    } ]
  }
}

Status Codes

Status Code	Description
200	Successful

Error Codes

See Error Codes.

Parent topic: Other APIs

11 KiB Raw Blame History