创建凭据配额
功能介绍
创建凭据配额
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotas
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID，在API网关控制台的“实例信息”中获取。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
配额名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头 最小长度：3 最大长度：255 |
|
call_limits |
是 |
Integer |
凭据配额的访问次数限制 最小长度：1 最大长度：2147483647 |
|
time_unit |
是 |
String |
限定时间单位：SECOND:秒、MINUTE:分、HOUR:时、DAY:天 枚举值：
|
|
time_interval |
是 |
Integer |
流控的限定时间值 最小长度：1 最大长度：2147483647 |
|
reset_time |
否 |
String |
首次配额重置时间点，不配置默认为首次调用时间计算 |
|
remark |
否 |
String |
参数说明和描述。 不支持<，>字符 最大长度：255 |
响应参数
状态码： 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
错误描述 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
{
"call_limits" : 1000,
"name" : "ClientQuota_demo",
"reset_time" : "2020-09-20 00:00:00",
"time_interval" : 1,
"time_unit" : "DAY"
}
响应示例
状态码： 201
OK
{
"app_quota_id" : "c900c5612dbe451bb43cbcc49cfaf2f3",
"call_limits" : 1000,
"create_time" : "2020-09-19T15:27:47.60571141+08:00",
"name" : "ClientQuota_demo",
"reset_time" : "2020-09-20 00:00:00",
"time_interval" : 1,
"time_unit" : "DAY"
}
状态码： 400
Bad Request
{
"error_code" : "APIG.3325",
"error_msg" : "The API quota name already exists"
}
状态码： 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"
}
状态码： 404
Not Found
{
"error_code" : "APIG.3030",
"error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}
状态码： 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
