为用户主密钥(CMK)创建密钥版本。
接口说明
-
RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制。
-
仅软件密钥管理实例中的对称密钥支持创建密钥版本,且密钥状态必须处于启用中。您可以调用 DescribeKey 接口查询密钥状态。
-
每创建一个密钥版本,就会消耗一个密钥额度。
本文将提供一个示例,为密钥 ID 为key-hzz62f1cb66fa42qo****
的密钥创建密钥版本。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
KeyId | string | 是 | 密钥 ID,即密钥的全局唯一标识符。 | key-hzz62f1cb66fa42qo*** |
返回参数
示例
正常返回示例
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. | 请求被拒绝,原因是密钥状态为待删除。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-18 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |