全部產品
Search
文件中心

Key Management Service:SetDeletionProtection

更新時間:Jul 15, 2026

為使用者主金鑰(CMK)開啟或關閉刪除保護。

介面說明

  • RAM 使用者或 RAM 角色呼叫此 OpenAPI 需要被授予的權限策略詳情,請參閱存取控制

  • 當您為 CMK 開啟刪除保護後,將無法刪除該 CMK。如果需要刪除 CMK,需提前關閉刪除保護。

  • 呼叫 SetDeletionProtection 介面前,請確保 CMK 不處於待刪除狀態。您可以呼叫 DescribeKey 介面檢視 CMK 的狀態(KeyState)。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

ProtectedResourceArn

string

待設定刪除保護的 CMK ARN。
您可以呼叫 DescribeKey 介面檢視 CMK ARN(Arn)。

acs:kms:cn-hangzhou:123213123****:key/0225f411-b21d-46d1-be5b-93931c82****

EnableDeletionProtection

boolean

是否開啟刪除保護,取值:

  • true:開啟刪除保護。

  • false(預設值):關閉刪除保護。

true

DeletionProtectionDescription

string

刪除保護描述。

說明

當 EnableDeletionProtection 取值為 true 時該參數有效。

该密钥正在被XXX服务使用。已为您设置删除保护。

KeyId

string

金鑰的 ID。

key-hzz65f3a68554s6ms****

KmsInstanceId

string

關於公用請求參數的詳情,請參閱公用參數

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

本次呼叫請求的 ID,是由阿里雲端為該請求產生的唯一識別碼,可用於排查和定位問題。

3455b9b4-95c1-419d-b310-db6a53b09a39

樣本

正常返回樣本

JSON格式

{
  "RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情