创建使用计划

最近更新时间:2019-04-26 15:28:41

接口描述

本接口(CreateUsagePlan)用于创建使用计划。
用户在使用 API 网关时,需要创建使用计划并将其绑定到服务的环境中使用。

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数可参考 公共请求参数

参数名称 是否必选 类型 描述
usagePlanName String 用户自定义的使用计划名称
usagePlanDesc String 用户自定义的使用计划描述
maxRequestNumPreSec Int 每秒请求限制数,默认1000
maxRequestNum Int 请求配额总数,不传为-1表示不开启

输出参数

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详见错误码页面的公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因
message String 模块错误信息描述,与接口相关
usagePlanId String 使用计划唯一 ID,由系统生成,全局唯一
usagePlanName String 用户自定义的使用计划名字
usagePlanDesc String 用户自定义的使用计划描述
createdTime Timestamp 创建时间。按照 ISO8601 标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ

示例

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=CreateUsagePlan
&usagePlanName=test
&usagePlanDesc=testDesc
&maxRequestNumPreSec=100

返回示例如下:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "usagePlanId": "usagePlan-XX",
    "usagePlanName": "name",
    "usagePlanDesc": "desc",
    "createdTime": "2017-08-07T00:00:00Z"
}