查询密钥详情

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

接口描述

本接口(DescribeApiKey)用于查询密钥详情。
用户在创建密钥后,可用此接口查询一个 API 密钥的详情,该接口会显示密钥 Key。

输入参数

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

参数名称 是否必选 类型 描述
secretId String API 密钥 ID

输出参数

参数名称 类型 描述
code Int 公共错误码,0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因。
message String 模块错误信息描述,与接口相关。
secretName String 用户自定义密钥名称。
secretId String API 密钥 ID。
secretKey String API 密钥 Key。
status Int API 密钥状态。1:使用中;0:禁用。
type String API 密钥类型。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=DescribeApiKey
&secretId=AKIDXXXXWKipDlK

返回示例如下:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "secretId": "AKIDXXXXWKipDlK",
    "secretKey": "asdkXXXXKOlhKn",
    "secretName": "mytest",
    "status": 1,
    "type": "auto",
    "createdTime": "2017-08-07T00:00:00Z",
    "modifiedTime": "2017-08-07T00:00:00Z"
}