文档中心 API 网关 API 文档 使用计划相关接口 查询使用计划绑定密钥列表

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

最近更新时间:2019-04-26 15:29:42

接口描述

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

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数可参考 公共请求参数

参数名称 是否必选 类型 描述
usagePlanId String 待绑定的使用计划唯一 ID
limit Int 返回数量
offset Int 偏移量。(从第几个密钥对开始查询)

输出参数

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因
message String 模块错误信息描述,与接口相关
totalCount String 密钥数目
secretIdList List of Array 密钥详情列表

secretIdList 是 secretStatus 组成的列表,其中 secretStatus 的组成如下:

参数名称 类型 描述
secretName String 密钥名称
secretId String 密钥 ID
status Int 密钥状态,0 表示已禁用,1 表示启用中

示例

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=DescribeUsagePlanSecretIds
&usagePlanId=usagePlan-XX

返回示例如下:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "totalCount": 2,
    "secretIdList": [{
            "secretName": "hwpwolmy",
            "secretId": "AKIDckpbbu0uogyngvbjuhn3z1mbqfy1db7h2cs9",
            "status": 1
        },
        {
            "secretName": "8jsuxt2i",
            "secretId": "AKIDFD3ZD5rq48TQKH61Lh6l37m0w507rD3h79z",
            "status": 0
        }
    ]
}