文档中心 API 网关 API 文档 使用计划相关接口 绑定使用计划到服务环境

绑定使用计划到服务环境

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

接口描述

本接口(BindEnvironment)用于绑定使用计划到服务环境。
用户在发布服务到某个环境中后,如此 API 需要鉴权,还需要绑定使用计划才能进行调用,此接口用户将使用计划绑定到特定环境。
目前支持绑定使用计划到API,但是同一个服务不能同时存在绑定到服务的使用计划和绑定到API的使用计划,所以对已经绑定过服务级别使用计划的环境,请先使用 服务级别使用计划降级 接口进行降级操作。

输入参数

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

参数名称 是否必选 类型 描述
usagePlanIds.n List Of String 待绑定的使用计划唯一 ID 列表。
serviceId String 待绑定的服务唯一 ID。
environment String 待绑定的环境。
bindType String 绑定类型,取值为API、SERVICE,默认值为SERVICE。
apiIds.n List of String API唯一ID数组,当bindType=API时,需要传入此参数。

输出参数

参数名称 类型 描述
code Int 公共错误码, 0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因。
message String 模块错误信息描述,与接口相关。

示例

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=BindEnvironment
&usagePlanId.0=usagePlan-XX
&usagePlanId.1=usagePlan-XXX
&serviceId=sevice-XX
&bindEnvironment=test

返回示例如下:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success"     
}
https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=BindEnvironment
&usagePlanId.0=usagePlan-XX
&usagePlanId.1=usagePlan-XXX
&serviceId=sevice-XX
&bindType=API
&apiIds.0=api-2yuua008
&bindEnvironment=test

返回示例如下:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success"     
}