ScheduleKeyDeletion - Key Management Service

在密鑰預刪除期間，密鑰狀態處於待刪除狀態，無法用於加密、解密、產生資料密鑰操作。

主要金鑰一旦刪除，將無法恢複，使用該主要金鑰加密的內容及產生的資料密鑰也將無法解密。因此，對於主要金鑰的刪除，KMS只提供計劃刪除的方式，而不提供直接刪除的方式。如果您有刪除密鑰方面的需求，可以通過DisableKey禁用密鑰。

在申請刪除主要金鑰的同時，需要指定一個預刪除周期，該周期最少為7天，最多為366天。從申請刪除主要金鑰的時刻開始，到刪除周期之前，可以通過CancelKeyDeletion撤銷密鑰刪除的申請。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ScheduleKeyDeletion	要執行的操作。取值：ScheduleKeyDeletion。
KeyId	String	是	7906979c-8e06-46a2-be2d-68e3ccbc****	密鑰ID。CMK通用唯一識別碼。
PendingWindowInDays	Integer	是	7	密鑰預刪除周期。在這段時間內，您可以撤銷刪除處於待刪除狀態的密鑰；預刪除時間過後無法撤銷刪除。取值範圍：7~366。單位：天。

返回資料

名稱	類型	樣本值	描述
RequestId	String	3da5b8cc-8107-40ac-a170-793cd181d7b7	本次調用請求的ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。

樣本

請求樣本

http(s)://[Endpoint]/?Action=ScheduleKeyDeletion
&KeyId=7906979c-8e06-46a2-be2d-68e3ccbc****
&PendingWindowInDays=7
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ScheduleKeyDeletionResponse>
    <RequestId>3da5b8cc-8107-40ac-a170-793cd181d7b7</RequestId>
</ScheduleKeyDeletionResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "3da5b8cc-8107-40ac-a170-793cd181d7b7"
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	InvalidParameter	The specified parameter is not valid.	參數非法。
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.	提供的 Access Key ID不存在

訪問錯誤中心查看更多錯誤碼。