获取主密钥列表
最近更新时间: 2025-01-20 17:15:22
1. 接口描述
接口请求域名: kms.api3.fincloud.tencent.cn。
列出账号下面状态为Enabled, Disabled 和 PendingImport 的CMK KeyId 列表
默认接口请求频率限制:50次/秒。
接口更新时间:2020-01-15 20:31:15。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:ListKeys |
Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-18 |
Region | 是 | 否 | String | 公共参数,详见产品支持的地域列表(TODO) |
Offset | 否 | 否 | Uint64 | 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0 |
Limit | 否 | 否 | Uint64 | 含义跟 SQL 查询的 Limit 一致,表示本次获最多获取 Limit 个元素。缺省值为10,最大值为200 |
Role | 否 | 否 | Uint64 | 根据创建者角色筛选,默认 0 表示用户自己创建的cmk, 1 表示授权其它云产品自动创建的cmk |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Keys | Key | CMK列表数组 |
TotalCount | Uint64 | CMK的总数量 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | |
InternalError | |
UnauthorizedOperation |