文档首页/代码托管 CodeArts Repo/API参考/API/V4/Tenant/获取当前租户的在KMS托管的主密钥CMK列表 - ListTenantCMKs
更新时间：2026-04-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取当前租户的在KMS托管的主密钥CMK列表 - ListTenantCMKs

功能介绍

获取当前租户的在KMS托管的主密钥CMK列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

当前API调用无需身份策略权限。

URI

GET /v4/tenants/{tenant_id}/repo-encryption/cmks

表1 路径参数

参数

是否必选

参数类型

描述

tenant_id

是

String

参数解释：

租户id

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量，从0开始。

取值范围：

0~2147483647

默认取值：

0

limit

否

Integer

参数解释：

返回数量。

取值范围：

1~100

默认取值：

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码：202

表4 响应Body参数

参数

参数类型

描述

cmk_key_name

String

参数解释：

加密主密钥的名称。

取值范围：

字符串长度不少于1，不超过1000。

cmk_key_id

String

参数解释：

加密主密钥的id。

取值范围：

字符串长度不少于1，不超过1000。

key_state

Integer

参数解释：

加密主密钥key的状态。

取值范围：

1表示待激活状态,2 表示启用状态,3 表示禁用状态,4 表示计划删除状态,5 表示等待导入状态。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/tenants/{tenant_id}/repo-encryption/cmks?offset=0&limit=10

响应示例

状态码：202

获取当前租户的在KMS托管的主密钥CMK列表

{
  "cmk_key_name" : "test111",
  "cmk_key_id" : "7308c1b8-557f-453a-aef7-28643f49cf1e",
  "key_state" : 2
}

状态码：401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码：403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限，请升级权限后重试。"
}

状态码

状态码

描述

202

获取当前租户的在KMS托管的主密钥CMK列表

401

Unauthorized

403

Bad Request

错误码

请参见错误码。

父主题：Tenant

相关文档