文档中心 API 网关 API 文档 使用计划相关接口 查询使用计划绑定环境列表

查询使用计划绑定环境列表

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

接口描述

本接口(DescribeUsagePlanEnvironments)用于查询使用计划绑定的环境列表。
用户在绑定了某个使用计划到环境后,可使用本接口查询这个使用计划绑定的所有服务的环境。

输入参数

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

参数名称 是否必选 类型 描述
usagePlanId String 待查询的使用计划唯一 ID
limit Int 返回数量。当绑定多个服务的环境时,返回的数量若不配置则默认20
offset Int 当有多个返回值时,从此偏移量开始查询
bindType String 绑定类型,取值为 API、SERVICE,默认值为 SERVICE

输出参数

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因
message String 模块错误信息描述,与接口相关
totalCount Int 绑定的服务的环境数
environmentList List of Array 使用计划已经绑定的各个服务的环境状态

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

参数名称 类型 描述
seviceId String 绑定的服务唯一 ID
serviceName String 绑定的服务名称
environmentName String 已经绑定的环境名称
apiId String API唯一ID,当入参bindType=API时返回此参数
inUseRequestNum Int 已经使用的配额
maxRequestNum Int 请求配额总量,-1表示没有限制

示例

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

返回示例如下:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "totalCount": 2,
    "environmentList": [{
            "seviceId": "sevice-XX",
            "serviceName": "xxx",
            "environmentName": "Test",
            "inUseRequestNum": 0,
            "maxRequestNum": -1

        },
        {
            "seviceId": "sevice-XXXX",
            "serviceName": "xxx",
            "environmentName": "release",
            "inUseRequestNum": 10,
            "maxRequestNum": 100
        }
    ]
}