更新时间:2026-01-07 GMT+08:00

查询配额

接口说明

查询单租户在DDS服务下的资源配额,包括集群实例配额、单节点实例配额和副本集实例配额。

URI

  • URI格式

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

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

用户Token。

响应参数

表3 响应Body参数

参数

参数类型

是否必选

描述

quotas

Object

配额信息。

详情请参见表4

表4 ShowResourcesListResponseBody

参数

参数类型

是否必选

描述

resources

Objects

资源列表对象。

详情请参见表5

表5 ShowResourcesDetailResponseBody

参数

参数类型

是否必选

描述

type

String

配额资源类型,当前配额类型仅支持实例类型(instance)。

mode

String

实例类型:

  • 若值为“Single”,则表示单节点实例配额信息。
  • 若值为“ReplicaSet”,则表示副本集实例配额信息。
  • 若值为“Sharding”,则表示集群实例配额信息。

quota

Integer

当前配额值。

used

Integer

已使用的配额数。

  • 响应示例
{
  "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
    } ]
  }
}

状态码

详情请参见状态码

错误码

详情请参见错误码