API 网关绑定使用计划到服务或API-使用计划相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： apigateway.tencentcloudapi.com 。

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

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：BindEnvironment。
Version	是	String	公共参数，本接口取值：2018-08-08。
Region	是	String	公共参数，详见产品支持的地域列表。
UsagePlanIds.N	是	Array of String	待绑定的使用计划唯一 ID 列表。示例值：["usagePlan-quqxvett\r\n"]
BindType	是	String	绑定类型，取值为API、SERVICE，默认值为SERVICE。示例值：SERVICE
Environment	是	String	待绑定的环境。示例值：test
ServiceId	是	String	待绑定的服务唯一 ID。示例值：service-ody35h5e
ApiIds.N	否	Array of String	API唯一ID数组，当bindType=API时，需要传入此参数。

3. 输出参数

参数名称	类型	描述
Result	Boolean	绑定操作是否成功。注意：此字段可能返回 null，表示取不到有效值。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 绑定使用计划

输入示例

https://apigateway.tencentcloudapi.com/?Action=BindEnvironment
&BindType=SERVICE
&Environment=test
&ServiceId=service-ody35h5e
&UsagePlanIds.0=usagePlan-quqxvett
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": true,
        "RequestId": "a6c567f9-7a55-43b9-81d2-f721da5e271a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

绑定使用计划到服务或API

本页目录：