CreateKeyVersion - 为主密钥创建一个新的密钥版本

更新时间:
复制 MD 格式

为用户主密钥(CMK)创建密钥版本。

接口说明

  • RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制。

  • 仅软件密钥管理实例中的对称密钥支持创建密钥版本,且密钥状态必须处于启用中。您可以调用 DescribeKey 接口查询密钥状态。

  • 每创建一个密钥版本,就会消耗一个密钥额度。

本文将提供一个示例,为密钥 ID 为key-hzz62f1cb66fa42qo****的密钥创建密钥版本。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

kms:CreateKeyVersion

create

*Key

acs:kms:{#regionId}:{#accountId}:key/{#keyId}

  • kms:tag
无

请求参数

名称

类型

必填

描述

示例值

KeyId

string

是

密钥 ID,即密钥的全局唯一标识符。

key-hzz62f1cb66fa42qo***

返回参数

名称

类型

描述

示例值

object

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

b96f250a-4b75-498c-91be-22c6928f85be

KeyVersion

object

密钥版本的元数据。

KeyId

string

密钥 ID。

key-hzz62f1cb66fa42qo****

KeyVersionId

string

密钥版本 ID。

key-hzz62f1cb66fa42qo****-20v29b****

CreationDate

string

创建密钥版本的时间(UTC 时间)。

2023-07-02T10:38:27Z

示例

正常返回示例

JSON格式

{
  "RequestId": "b96f250a-4b75-498c-91be-22c6928f85be",
  "KeyVersion": {
    "KeyId": "key-hzz62f1cb66fa42qo****",
    "KeyVersionId": "key-hzz62f1cb66fa42qo****-20v29b****",
    "CreationDate": "2023-07-02T10:38:27Z"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 Rejected.UnsupportedOperation Unsupported operation. 不支持的操作
404 Forbidden.AliasNotFound The specified Alias is not found. 指定的别名找不到
404 Forbidden.KeyNotFound The specified Key is not found. 指定的密钥不存在。
409 Rejected.Disabled The request was rejected because the key state is Disabled. 请求被拒绝,因为密钥状态为已禁用。
409 Rejected.Unavailable The request was rejected because the key state is Unavailable. 请求被拒绝,原因是密钥状态为不可用。
409 Rejected.PendingDeletion The request was rejected because the key state is PendingDeletion. 请求被拒绝,原因是密钥状态为待删除。

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

变更历史

更多信息,参考变更详情。