查询资源配额 - ListResourceQuotas
功能介绍
查询用户在指定项目下的计算资源、端点和工作空间的配额信息。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/quotas
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:项目ID。获取方法,请参见获取项目ID。 约束限制:不涉及。 取值范围:长度为1~36的英文字符、数字和中划线的组合。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:用户Token,通过调用获取IAM用户Token接口获取。 约束限制:不涉及。 取值范围:只能由英文字母、数字及特殊字符组成,长度不超过65534个字符。Token格式由IAM服务定义,具体字符集参见IAM服务相关文档。 默认取值:不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| quotas | ResourceQuotas object | 参数解释:查询用户的资源配额信息返回结构。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| type | String | 参数解释:配额类型名称。可通过查询资源配额获取配额类型。 取值范围:长度为0~255的英文字符、数字的组合。 |
| quota | Integer | 参数解释:当前配额值,-1表示无限制。 取值范围:整数,-1表示无限制。 |
| used | Integer | 参数解释:使用量。 取值范围:整数。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:408
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
请求示例
用户通过该接口查询指定项目下的资源配额信息,包括工作空间、端点和计算资源的配额。
GET /v2/{project_id}/quotas 响应示例
状态码:200
{
"quotas" : {
"resources" : [ {
"type" : "workspaceNum",
"quota" : 100,
"used" : 50
}, {
"type" : "endpointNum",
"quota" : 200,
"used" : 150
}, {
"type" : "computeNum",
"quota" : 100,
"used" : 80
} ]
}
} 状态码:400
{
"error_code" : "AIDataLake.00010151",
"error_msg" : "Parameter value is invalid.",
"solution_msg" : "Please input valid parameter value."
} 状态码:401
{
"error_code" : "APIGW.0301",
"error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
"solution_msg" : "Check whether the IAM authentication information is correct."
} 状态码:403
{
"error_code" : "AIDataLake.00010150",
"error_msg" : "The operation is not allowed.",
"solution_msg" : "Check whether the operation is allowed in the current status."
} 状态码:404
{
"error_code" : "AIDataLake.00010009",
"error_msg" : "No resources found.",
"solution_msg" : "Ensure the requested resource exists and the parameters are correct."
} 状态码:408
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred",
"solution_msg" : "Try again later. If the problem persists, contact technical support."
} 状态码:500
{
"error_code" : "AIDataLake.00011001",
"error_msg" : "Internal error.",
"solution_msg" : "Contact technical support or try again later."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询用户的资源配额信息。 |
| 400 | 请求参数错误。 |
| 401 | 未授权。 |
| 403 | 禁止访问。 |
| 404 | 资源未找到。 |
| 408 | 请求超时。 |
| 500 | 内部服务器错误。 |