API 网关查询使用计划绑定环境列表-API 文档-文档中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeUsagePlanEnvironments。
Version	是	String	公共参数，本接口取值：2018-08-08。
Region	是	String	公共参数，详见产品支持的地域列表。
UsagePlanId	是	String	待查询的使用计划唯一 ID。示例值：usagePlan-quqxvett
BindType	是	String	定义类型，取值为 API、SERVICE，默认值为 SERVICE。示例值：API
Limit	否	Integer	返回数量，默认为 20，最大值为 100。
Offset	否	Integer	偏移量，默认为 0。

3. 输出参数

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

4. 示例

示例1 展示使用计划绑定详情

用户在绑定了某个使用计划到环境后，可使用本接口查询这个使用计划绑定的所有服务的环境。

输入示例

https://apigateway.tencentcloudapi.com/?Action=DescribeUsagePlanEnvironments
&UsagePlanId=usagePlan-quqxvett
&BindType=API
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "EnvironmentList": [
                {
                    "ServiceId": "service-ody35h5e",
                    "ServiceName": null,
                    "ApiId": "api-e92i2jds",
                    "ApiName": "test2",
                    "Path": "/users",
                    "Method": "POST",
                    "Environment": "test",
                    "InUseRequestNum": 0,
                    "MaxRequestNum": -1,
                    "MaxRequestNumPreSec": 0,
                    "CreatedTime": "2019-12-23T09:15:17Z",
                    "ModifiedTime": null
                }
            ]
        },
        "RequestId": "6c405f2c-ae4b-4d83-a155-522c4d3c7d3c"
    }
}

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. 错误码

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

错误码	描述
InternalError.OssException	oss内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。
ResourceNotFound.InvalidUsagePlan	使用计划不存在。

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

本页目录：