获取凭据配额列表
功能介绍
获取凭据配额列表。支持根据名称模糊查询
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID，在API网关控制台的“实例信息”中获取。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Long |
偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 |
|
limit |
否 |
Integer |
每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 |
|
name |
否 |
String |
凭据配额名称 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
size |
Integer |
本次返回的列表长度 |
|
total |
Long |
满足条件的记录数 |
|
quotas |
Array of AppQuotaInfo objects |
凭据配额列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
app_quota_id |
String |
凭据配额编号 |
|
name |
String |
配额名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3-255字符 |
|
call_limits |
Integer |
凭据配额的访问次数限制 |
|
time_unit |
String |
限定时间单位：SECOND:秒、MINUTE:分、HOUR:时、DAY:天 枚举值：
|
|
time_interval |
Integer |
配额的限定时间值 |
|
remark |
String |
参数说明和描述 最大长度：255 |
|
reset_time |
String |
首次配额重置时间点，不配置默认为首次调用时间计算 |
|
create_time |
String |
创建时间 |
|
bound_app_num |
Integer |
配额策略已绑定应用数量 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码： 200
OK
{
"total" : 1,
"size" : 1,
"quotas" : [ {
"app_quota_id" : "c900c5612dbe451bb43cbcc49cfaf2f3",
"call_limits" : 1000,
"create_time" : "2020-09-19T07:27:47Z",
"name" : "ClientQuota_demo",
"reset_time" : "2020-09-20 00:00:00 +0000 +0000",
"time_interval" : 1,
"time_unit" : "DAY"
} ]
}
状态码： 400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}
状态码： 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码： 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
状态码： 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
错误码
请参见错误码。
