查询租户配额 - ShowQuota
功能介绍
查询租户配额。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/sfs-turbo/quotas
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权认证。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求消息体MIME类型,用于标识请求正文的数据格式。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| quotas | ShowQuotaResource object | 参数解释: 租户配额信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| type | String | 参数解释: 租户资源类型。 取值范围: |
| used | Integer | 参数解释: 已用配额。 取值范围: 不涉及。 |
| quota | Integer | 参数解释: 总配额。 取值范围: 不涉及。 |
| unit | String | 参数解释: 配额单位。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 参数解释: 错误码,用于标识请求失败的原因。详细错误码请参见错误码。 取值范围: 不涉及。 |
| errMsg | String | 参数解释: 错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
请求示例
查询指定项目的租户配额信息。
GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/quotas 响应示例
状态码:200
{
"quotas" : {
"resources" : [ {
"type" : "shares",
"used" : 5,
"quota" : 400
}, {
"type" : "capacity",
"used" : 0,
"quota" : 20,
"unit" : "GB"
} ]
}
} 状态码:400
{
"errCode" : "SFS.TURBO.0001",
"errMsg" : "parameter error"
} 状态码:500
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功 |
| 400 | 错误响应 |
| 500 | 错误响应 |
错误码
请参见错误码。