帮你快速理解、总结文档立即下载

获取主密钥列表

最近更新时间:2020-02-18 14:48:04
我的收藏

1. 接口描述

本接口 (ListKey) , 用于列出账号下面的密钥列表。
kms请求域名接口和说明可参考 地域和域名说明。
任何时候,包括内测期间,如果使用外网域名产生公网下行流量,都会收取流量费用。 所以强烈建议服务在腾讯云上的用户使用内网域名,内网不会产生流量费用。
输入参数有些是可选的,不填取默认值。
输出参数在成功情况下所有出参都会返回给用户;失败情况下,至少会有 code,message, requestId 返回。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 文档。
参数名称
是否必选
类型
描述
offset
否
Int
含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始。缺省为0
limit
否
Int
含义跟 SQL 查询的 Limit 一致,表示本次获最多获取 Limit 个元素。缺省值为10

3. 输出参数

参数名称
类型
描述
code
Int
0:表示成功,其他返回值的含义可以参考 错误码
message
String
错误提示信息
requestId
String
服务器生成的请求 ID。出现服务器内部错误时,用户可提交此 ID 给后台定位问题
keys
Array
key 数组
totalCount
Int
key 的总数

Keys 的每个元素定义如下:

参数名称
类型
描述
keyId
String
CMK 的全局唯一标识

4. 示例

输入

https://kms-bj.api.tencentyun.com/v2/index.php?Action=ListKey
&offset=20
&limit=10

输出

{
"code": 0,
"message": "",
"requestId": "14534664555",
"keys": [{
"keyId": "kms-984ksdl"
},
{
"keyId": "kms-84sjkla"
}
],
"totalCount": 100
}