調用SetDeletionProtection接口為用戶主密鑰（CMK）開啟或關閉刪除保護。
使用說明：
- 當您為CMK開啟刪除保護后，將無法刪除該CMK。如果需要刪除CMK，需提前關閉刪除保護。
- 調用SetDeletionProtection接口前，請確保CMK不處于待刪除狀態。您可以調用DescribeKey接口查看CMK的狀態（KeyState）。
本文將提供一個示例，為CMK ARN（ProtectedResourceArn）為acs:kms:cn-hangzhou:123213123****:key/0225f411-b21d-46d1-be5b-93931c82****的CMK開啟刪除保護。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | SetDeletionProtection |
要執行的操作。取值：SetDeletionProtection。 |
| ProtectedResourceArn | String | 是 | acs:kms:cn-hangzhou:123213123****:key/0225f411-b21d-46d1-be5b-93931c82**** |
待設置刪除保護的CMK ARN。 您可以調用DescribeKey接口查看CMK ARN（Arn）。 |
| EnableDeletionProtection | Boolean | 是 | true |
是否開啟刪除保護，取值：
|
| DeletionProtectionDescription | String | 否 | 該密鑰正在被XXX服務使用。已為您設置刪除保護。 |
刪除保護描述。 說明 當EnableDeletionProtection取值為true時該參數有效。
|
關于公共請求參數的詳情，請參見公共參數。
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 3455b9b4-95c1-419d-b310-db6a53b09a39 |
本次調用請求的ID，是由阿里云為該請求生成的唯一標識符，可用于排查和定位問題。 |
示例
請求示例
http(s)://[Endpoint]/?Action=SetDeletionProtection
&ProtectedResourceArn=acs:kms:cn-hangzhou:123213123****:key/0225f411-b21d-46d1-be5b-93931c82****
&EnableDeletionProtection=true
&DeletionProtectionDescription=該密鑰正在被XXX服務使用。已為您設置刪除保護。
&公共請求參數正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SetDeletionProtectionResponse>
<RequestId>3455b9b4-95c1-419d-b310-db6a53b09a39</RequestId>
</SetDeletionProtectionResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "3455b9b4-95c1-419d-b310-db6a53b09a39"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。