查询密钥列表

最近更新时间:2019-05-20 17:28:36

接口描述

本接口(DescribeApiKeysStatus)用于查询密钥列表。
当用户创建了多个密钥对时,可使用本接口查询一个或多个 API 密钥信息,本接口不会显示密钥 Key。

输入参数

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

参数名称 是否必选 类型 描述
secretIds.n Array of Strings 按照一个或者多个 API 密钥 ID 查询。如果不输入此密钥 ID,则默认返回前20个密钥的信息。
offset Int 偏移量,默认为0。
limit Int 返回数量,默认为20,最大值为100。
orderby String 根据哪个字段排序。
order String 排序方式。
searchName String 按照密钥名字模糊搜索。
searchId String 按照密钥唯一 ID 精确搜索。

输出参数

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

其中,apiKeyStatusSet 是 apiKeyStatus 构成的数组,apiKeyStatus 的构成如下:

参数名称 类型 描述
secretId String API 密钥 ID。
secretName String 用户自定义密钥名称。
status Bollen 密钥状态,现在有两种,1:表示使用中;0:表示已禁用。
type String 密钥类型,现在有两种,auto:表示普通类型; manual:表示自定义类型。
createdTime Timestamp 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
modifiedTime Timestamp 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

示例

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=DescribeApiKeysStatus
&secretIds.0=AKIDXXXXWKipDlK
&secretIds.1=AKIDXXXXAVd3EuW
&offet=0
&limit=2
&orderby=createdTime
&order=desc
&searchKey=aa

返回示例如下:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "totalCount": 2,
    "apiKeyStatusSet": [{
            "secretId": "AKIDXXXXWKipDlK",
            "secretName": "myTest",
            "status": 1,
            "createdTime": "2017-08-07T00:00:00Z",
            "modifiedTime": "2017-08-07T00:00:00Z",
            "type": "auto"
        },
        {
            "secretId": "AKIDXXXXAVd3EuW",
            "secretName": "myTest1",
            "status": 0,
            "createdTime": "2017-08-07T00:10:00Z",
            "modifiedTime": "2017-08-07T00:10:00Z",
            "type": "auto"
        }
    ]
}