文档

DescribeKmsKeys - 查询用户KMS密钥列表

更新时间:

查询用户KMS密钥列表。如果是第一次访问,将尝试创建一个EDS的服务密钥,并返回结果。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云桌面支持的地域列表。

cn-hangzhou

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
KmsServiceStatusstring

KMS 服务状态。

枚举值:
  • disabled 未开启服务
  • enabled 已开启服务
enabled
AuthorizeStatusstring

授权状态。

枚举值:
  • not_authorized未完成授权
  • authorized授权完成
authorized
Keysobject []

用户主密钥 CMK(Customer Master Key)。

KeyIdstring

密钥 ID。

05754286-3ba2-4fa6-8d41-4323aca6****
Arnstring

ARN 资源描述。

acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6****
Aliasstring

密钥别名。

TestAlias
Typestring

密钥类型。

枚举值:
  • ServiceKey 服务密钥
  • CustomKey 用户密钥
ServiceKey

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "KmsServiceStatus": "enabled",
  "AuthorizeStatus": "authorized",
  "Keys": [
    {
      "KeyId": "05754286-3ba2-4fa6-8d41-4323aca6****",
      "Arn": "acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6****",
      "Alias": "TestAlias",
      "Type": "ServiceKey"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈