查询配额 - ShowQuotas_配额管理_资源配额_API_API参考

功能介绍

查询用户可以创建的资源配额总数及当前使用量，当前仅有告警规则一种资源类型。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

ces:quotas:get

Read

-

-

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
ces:quotas:get	Read	-	-	-	-

URI

GET /V1.0/{project_id}/quotas

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。约束限制: 不涉及。取值范围: 长度为[1,64]个字符。默认取值: 不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	否	String	参数解释: 发送的实体的MIME类型。约束限制: 不涉及。取值范围: 长度为[1,64]个字符。默认取值: 默认使用 application/json; charset=UTF-8，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。
X-Auth-Token	否	String	参数解释: 用户Token。Token认证，具体操作请参考认证鉴权。约束限制: 不涉及。取值范围: 长度为[1,16384]个字符。默认取值: 不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
quotas	QuotasResp object	参数解释：配额列表。

表4 QuotasResp
参数	参数类型	描述
resources	Array of ResourceQuotasResp objects	参数解释：资源配额列表。

表5 ResourceQuotasResp
参数	参数类型	描述
type	String	参数解释：配额类型。取值范围：枚举值说明： alarm：告警规则
used	Long	参数解释：已使用配额数。取值范围：不涉及。
unit	String	参数解释：单位。取值范围：长度为[0,32]个字符。
quota	Long	参数解释：配额总数。取值范围：不涉及。
min	Long	参数解释：最小值。取值范围：不涉及。
max	Long	参数解释：最大值。取值范围：不涉及。

状态码：400

表6 响应Body参数
参数	参数类型	描述
-	String	请求错误。

状态码：401

表7 响应Body参数
参数	参数类型	描述
-	String	未提供认证信息，或认证信息错误。

状态码：403

表8 响应Body参数
参数	参数类型	描述
-	String	请求页面被禁止访问。

状态码：408

表9 响应Body参数
参数	参数类型	描述
-	String	请求超出了服务器的等待时间。

状态码：429

**表10** 响应Body参数
参数	参数类型	描述
-	String	请求过多。

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
-	String	请求未完成，服务异常。

状态码：503

**表12** 响应Body参数
参数	参数类型	描述
-	String	系统暂时不可用，请求受限。

请求示例

/V1.0/{project_id}/quotas

响应示例

状态码：200

OK

{
  "quotas" : {
    "resources" : [ {
      "unit" : "",
      "type" : "alarm",
      "quota" : 1000,
      "used" : 10
    } ]
  }
}

状态码

状态码	描述
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
408	Request Timeout
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

错误码

请参见错误码。

查询配额 - ShowQuotas