BindEnvironment

最近更新时间: 2025-10-20 17:05:59

1. 接口描述

接口请求域名: apigateway.api3.fincloud.tencent.cn。

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

默认接口请求频率限制:20次/秒。

接口更新时间:2020-08-10 10:59:06。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:BindEnvironment
Version String 公共参数,本接口取值:2018-08-08
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
UsagePlanIds Array of String 待绑定的使用计划唯一 ID 列表。
BindType String 绑定类型,取值为API、SERVICE,默认值为SERVICE。
Environment String 待绑定的环境。
ServiceId String 待绑定的服务唯一 ID。
ApiIds Array of String API唯一ID数组,当bindType=API时,需要传入此参数。

3. 输出参数

参数名称 类型 描述
Result Bool 绑定操作是否成功。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InvalidParameter.FormatError 参数格式错误。
ResourceNotFound.InvalidApi ApiId错误。
FailedOperation.ServiceError 服务相关的错误。
ResourceNotFound.InvalidUsagePlan 使用计划不存在。
UnsupportedOperation.UnsupportedUnBindEnvironment 不支持解绑环境,存在未绑定使用计划的API。
InternalError.OssException oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InvalidParameterValue.InvalidApiIds API Id错误。
UnsupportedOperation.UnsupportedBindEnvironment 不支持绑定环境。
LimitExceeded.RequestLimitExceeded 请求频率超限制,请稍等再试。