查询 API 使用计划详情

1. 接口描述

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

本接口（DescribeApiUsagePlan）用于查询服务中 API 使用计划详情。
服务若需要鉴权限流生效，则需要绑定使用计划到此服务中，本接口用于查询绑定到一个服务及其中 API 的所有使用计划。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 展示使用计划绑定的api列表

输入示例

https://apigateway.tencentcloudapi.com/?Action=DescribeApiUsagePlan
&ServiceId=service-ody35h5e
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "ApiUsagePlanList": [
                {
                    "ServiceId": "service-ody35h5e",
                    "ServiceName": null,
                    "ApiId": "api-e92i2jds",
                    "ApiName": "test2",
                    "Path": "/users",
                    "Method": "POST",
                    "UsagePlanId": "usagePlan-quqxvett",
                    "UsagePlanName": "aaa",
                    "UsagePlanDesc": "xby",
                    "Environment": "test",
                    "InUseRequestNum": 0,
                    "MaxRequestNum": -1,
                    "MaxRequestNumPreSec": null,
                    "CreatedTime": "2020-02-17T11:26:42Z",
                    "ModifiedTime": "2020-02-17T13:47:47Z"
                }
            ]
        },
        "RequestId": "8783bfc8-70e3-494a-97f4-0ccc10987aa8"
    }
}

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

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