This API enables you to cancel the scheduled deletion of a CMK.
You can cancel the scheduled deletion for a CMK only when the CMK's status is Scheduled deletion.
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Content-Type |
Yes |
String |
application/json |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
key_id |
Yes |
String |
36-byte key ID that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. For example, 0d0466b0-e727-4d9c-b35d-f84bb474a37f |
sequence |
No |
String |
A 36-byte serial number of a request message. For example, 919c82d4-8046-4722-9094-35c3c6524cff |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
key_id |
Yes |
String |
CMK ID |
key_state |
Yes |
String |
CMK status:
|
The following example describes how to cancel the scheduled deletion of a CMK whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.
{
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
}
{
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
"key_state": "3"
}
or
{
"error": {
"error_code": "KMS.XXXX",
"error_msg": "XXX"
}
}
Exception status code. For details, see Status Codes.