Updated on 2025-06-20 GMT+08:00

Querying Quotas

Function

This API is used to query quotas.

Call Method

For details, see How to Call an API.

URI

GET /v1.0/{project_id}/quotas/dms

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Request

None.

Response

Status code: 200

Table 2 Response body parameter

Parameter

Type

Description

quotas

quotas object

Quota information.

Table 3 quotas

Parameter

Type

Description

resources

Array of QuotaResourceEntity objects

Quota list.

Table 4 QuotaResourceEntity

Parameter

Type

Description

type

String

Values: rabbitmqInstance, kafkaInstance, rocketmqInstance, and tags

  • rabbitmqInstance indicates the RabbitMQ instance quota.

  • kafkaInstance indicates the Kafka instance quota.

  • rocketmqInstance indicates the RocketMQ instance quota.

  • tags indicates the tag quota.

quota

Integer

The maximum number of instances that a tenant can create, or the maximum number of tags that can be created for each instance.

used

Integer

Number of created instances.

Example Request

GET https://{endpoint}/v1.0/{project_id}/quotas/dms

Example Response

Status code: 200

Metrics queried successfully.

{
  "quotas" : {
    "resources" : [ {
      "type" : "rabbitmqInstance",
      "quota" : 100,
      "used" : 3
    }, {
      "type" : "kafkaInstance",
      "quota" : 100,
      "used" : 17
    }, {
      "type" : "rocketmqInstance",
      "quota" : 100,
      "used" : 17
    }, {
      "tpye" : "tags",
      "quota" : 20
    } ]
  }
}

Status Code

Status Code

Description

200

Metrics queried successfully.

Error Code

See Error Codes.