为密钥创建新的密钥版本。
- 仅软件密钥管理实例中的对称密钥支持创建密钥版本,且密钥状态必须处于启用中。您可以调用DescribeKey 接口查询密钥状态。
- 每创建一个密钥版本,就会消耗一个密钥额度。
本文将提供一个示例,为密钥ID为key-hzz62f1cb66fa42qo****
的密钥创建密钥版本。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | CreateKeyVersion | 要执行的操作。取值:CreateKeyVersion。 |
KeyId | String | 是 | key-hzz62f1cb66fa42qo*** | 密钥ID,即密钥的全局唯一标识符。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | b96f250a-4b75-498c-91be-22c6928f85be | 本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
KeyVersion | Object | 密钥版本的元数据。 |
|
KeyId | String | key-hzz62f1cb66fa42qo**** | 密钥ID。 |
KeyVersionId | String | key-hzz62f1cb66fa42qo****-20v29b**** | 密钥版本ID。 |
CreationDate | String | 2023-07-02T10:38:27Z | 创建密钥版本的时间(UTC时间)。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateKeyVersion
&KeyId=key-hzz62f1cb66fa42qo***
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateKeyVersionResponse>
<RequestId>b96f250a-4b75-498c-91be-22c6928f85be</RequestId>
<KeyVersion>
<KeyId>key-hzz62f1cb66fa42qo****</KeyId>
<KeyVersionId>key-hzz62f1cb66fa42qo****-20v29b****</KeyVersionId>
<CreationDate>2023-07-02T10:38:27Z</CreationDate>
</KeyVersion>
</CreateKeyVersionResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "b96f250a-4b75-498c-91be-22c6928f85be",
"KeyVersion" : {
"KeyId" : "key-hzz62f1cb66fa42qo****",
"KeyVersionId" : "key-hzz62f1cb66fa42qo****-20v29b****",
"CreationDate" : "2023-07-02T10:38:27Z"
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
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. | 请求被拒绝,原因是密钥状态为待删除。 |
访问错误中心查看更多错误码。