API 网关
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 网关 > API 文档 > 使用计划相关接口 > 查询使用计划绑定密钥列表

查询使用计划绑定密钥列表

最近更新时间：2024-03-12 01:08:42

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeUsagePlanSecretIds）用于查询使用计划绑定的密钥列表。
在 API 网关中，一个使用计划可绑定多个密钥对，可使用本接口查询使用计划绑定的密钥列表。

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

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

2. 输入参数

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

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

3. 输出参数

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

4. 示例

示例1 查询使用计划绑定的密钥

输入示例

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

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "AccessKeyList": [
                {
                    "SecretName": "xx",
                    "AccessKeyId": "AKIDmyE2z0gvi2p6i9lWr3bbetpTaquaxQ8s8iob",
                    "Status": 1
                }
            ]
        },
        "RequestId": "61f694d3-9c8b-4c4e-8d51-b2ab087c0d36"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue.InvalidRegion 地域错误。
ResourceNotFound.InvalidUsagePlan 使用计划不存在。
中国站