為密鑰建立新的密鑰版本。
- 僅軟體密鑰管理執行個體中的對稱金鑰支援建立密鑰版本,且密鑰狀態必須處於啟用中。您可以調用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. | 請求被拒絕,原因是密鑰狀態為待刪除。 |
訪問錯誤中心查看更多錯誤碼。