更新时间:2025-12-02 GMT+08:00
查询配额-QueryingResourceQuotas
接口说明
查询单租户在DDS服务下的资源配额,包括集群实例配额、单节点实例配额和副本集实例配额。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
dds:instance:getQuotas
read
-
-
dds:instance:list
-
URI
|
名称 |
类型 |
IN |
是否必选 |
描述 |
|---|---|---|---|---|
|
X-Auth-Token |
string |
header |
是 |
参数解释: 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
project_id |
string |
path |
是 |
参数解释: 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求消息
无。
响应消息
- 参数说明
表2 响应Body参数 参数
参数类型
是否必选
描述
quotas
Object
是
配额信息。
详情请参见表3。
- 响应示例
{
"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
} ]
}
}
SDK
单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
父主题: 配额管理