查询账号配额 - ListCoreGatewayQuotas
功能介绍
获取当前认证账号的有效配额信息,包括配额类型、最小值、最大值、配额值和已使用数量。
URI
GET /v1/core/gateway-quotas
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
gateway_id |
否 |
String |
参数解释: 网关的唯一标识符。 网关ID获取方式: 约束范围: 不涉及。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
|
limit |
否 |
Integer |
参数解释: 返回的最大结果数。 约束范围: 不涉及。 取值范围: int32,取值范围为1-2。 默认取值: 2 |
|
offset |
否 |
Integer |
参数解释: 返回结果偏移量。 约束范围: 不涉及。 取值范围: int32,取值范围为0-100000。 默认取值: 0 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
quotas |
Array of CoreGatewayQuota objects |
参数解释: 配额列表。 取值范围: 数组长度为 1-2。 |
|
size |
Integer |
参数解释: 当前页返回的配额数量。 取值范围: 取值为 0-2。 |
|
total |
Integer |
参数解释: 配额总数。 取值范围: 取值为 0-2。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释: 配额类型。 取值范围: |
|
min |
Integer |
参数解释: 最小允许值。 取值范围: 取值为 1-10000。 |
|
max |
Integer |
参数解释: 最大允许值。 取值范围: 取值为 1-10000。 |
|
quota |
Integer |
参数解释: 当前配置的配额值。 取值范围: 取值为 1-10000。 |
|
used |
Integer |
参数解释: 已使用数量(实时计算)。 取值范围: 取值为 0-10000。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 取值为固定18个字符,匹配以 AgentArts. 开头、后接恰好8位数字的字符串,符合正则条件^AgentArts.[0-9]{8}$。 |
|
error_msg |
String |
参数解释: 错误消息。 取值范围: 取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。 |
|
error_reason |
String |
参数解释: 错误原因。 取值范围: 取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。 |
|
error_suggestion |
String |
参数解释: 错误处理建议。 取值范围: 取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。 |
请求示例
无
响应示例
状态码:200
成功检索账号配额列表
{
"quotas" : [ {
"type" : "gateway_count",
"min" : 1,
"max" : 100,
"quota" : 20,
"used" : 5
} ],
"size" : 1,
"total" : 1
}
状态码:500
内部服务器错误
{
"error_code" : "AgentArts.02000500",
"error_msg" : "内部服务器错误"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功检索账号配额列表 |
|
500 |
内部服务器错误 |
错误码
请参见错误码。