获取套餐额度信息 - ShowQuotaInfo
功能介绍
获取当前租户的配额信息，例如剩余任务数、资源使用情况等。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
codeartsgovernance::getBinaryUser |
Read |
- |
- |
- |
- |
URI
GET /v1/{project_id}/sbc/quota/info
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 用户项目ID，获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 32位项目ID。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
|
Content-Type |
是 |
String |
参数解释： 编码格式。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： application/json：传任何值，接口返回值均为json格式。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
参数解释： 响应内容。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
package_quota |
Integer |
参数解释： 剩余套餐配额。 取值范围： 0-2147483647。 |
|
concurrent_task |
Integer |
参数解释： 当前并发运行任务数。 取值范围： 0-2147483647。 |
|
valid |
Boolean |
参数解释： 是否可以下发任务。 取值范围：
|
|
resource_id |
String |
参数解释： 套餐资源ID。 取值范围： 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：429
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 错误描述。 取值范围： 不涉及。 |
请求示例
获取套餐额度信息。
GET https://{endpoint}/v1/{project_id}/sbc/quota/info
响应示例
状态码：200
Request succeeded!
{
"data" : {
"package_quota" : 5000,
"concurrent_task" : 3,
"valid" : true,
"resource_id" : 1234567
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
429 |
Too Many Requests |
错误码
请参见错误码。
