Updated on 2026-01-08 GMT+08:00

Querying Resource Quotas

Description

This API is used to query the DDS resource quotas of a tenant, including the cluster instance quota, single node instance quota, and replica set instance quota.

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/quotas

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

project_id

string

path

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token

Response Parameters

Table 3 Response body parameters

Parameter

Type

Mandatory

Description

quotas

Object

Yes

Quota information.

For more information, see Table 4.

Table 4 ShowResourcesListResponseBody

Parameter

Type

Mandatory

Description

resources

Objects

Yes

The resource objects.

For more information, see Table 5.

Table 5 ShowResourcesDetailResponseBody

Parameter

Type

Mandatory

Description

type

String

Yes

The quota resource type. Only the instance type is supported.

mode

String

Yes

The instance type.

  • If the value is Single, the quota information of a single node instance is displayed.
  • If the value is ReplicaSet, the quota information of a replica set instance is displayed.
  • If the value is Sharding, the quota information of a cluster instance is displayed.

quota

Integer

Yes

The existing quota.

used

Integer

Yes

The number of the used instances.

  • Example response
{
  "quotas" : {
    "resources" : [ {
      "type" : "instance",
      "mode" : "Sharding",
      "quota" : 80,
      "used" : 6
    }, {
      "type" : "instance",
      "mode" : "ReplicaSet",
      "quota" : 80,
      "used" : 9
    }, {
      "type" : "instance",
      "mode" : "Single",
      "quota" : 1000,
      "used" : 5
    } ]
  }
}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.