查询使用计划详情

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

接口描述

本接口(DescribeUsagePlan)用于查询一个使用计划的详细信息,包括名称、QPS、创建时间绑定的环境等。

输入参数

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

参数名称 是否必选 类型 描述
usagePlanId String 待查询的使用计划唯一 ID

输出参数

参数名称 类型 描述
code Int 公共错误码,0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因
message String 模块错误信息描述,与接口相关
usagePlanId String 使用计划唯一 ID
usagePlanName String 用户自定义的使用计划名称
usagePlanDesc String 使用计划描述
maxRequestNumPreSec Int 每秒请求限制数
createdTime Timestamp 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ
modifiedTime Timestamp 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ
bindSecretIdTotalCount Int 绑定的密钥数
bindSecretIds List of String 使用计划已经绑定的密钥 ID 列表
bindEnvironmentTotalCount Int 绑定的服务的环境数
bindEnvironments List of Array 使用计划已经绑定的各个服务的环境状态

其中 bindEnvironments 表示了该服务是否绑定到各个环境,bindEnvironments 是由 bindEnvironment 组成的数组,bindEnvironment 的构成如下:

参数名称 类型 描述
seviceId String 绑定的服务唯一 ID
environmentName String 已经绑定的环境名称

示例

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=DescribeUsagePlan
&usagePlanId=usagePlan-XX

返回示例如下:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "usagePlanId": "usagePlan-XX",
    "usagePlanName": "test1",
    "usagePlanDesc": "test1",
    "maxRequestNumPreSec": 500,
    "createdTime": "2017-08-07T00:00:00Z",
    "modifiedTime": "2017-08-07T00:00:00Z",
    "bindSecretIdTotalCount": 2,
    "bindSecretIds": [
        "AKIDXXXXXwdeqDFaw",
        "AKIDXXXXXkoihMAlS"
    ],
    "bindEnvironmentTotalCount": 2,
    "bindEnvironments": [{
            "seviceId": "sevice-XX",
            "environmentName": "Test"
        },
        {
            "seviceId": "sevice-XXXX",
            "environmentName": "release"
        }
    ]
}