すべてのプロダクト
Search
ドキュメントセンター

:SetDeletionProtection

最終更新日:Jul 30, 2025

カスタマーマスターキー (CMK) の削除保護を有効または無効にします。

操作説明

  • RAM ユーザーまたは RAM ロールがこの API 操作を呼び出すために必要なアクセス ポリシーの詳細については、「リソースアクセス管理」をご参照ください。

  • CMK の削除保護を有効にした後、それを削除することはできません。 CMK を削除するには、まず削除保護を無効にする必要があります。

  • SetDeletionProtection 操作を呼び出す前に、CMK が PendingDeletion 状態ではないことを確認してください。 DescribeKey 操作を呼び出して、CMK のステータスをクエリできます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

タイプ

必須 / 任意

説明

ProtectedResourceArn

string

任意

削除保護を設定する CMK の ARN。
DescribeKey 操作を呼び出して、CMK の ARN をクエリできます。

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

EnableDeletionProtection

boolean

必須

削除保護を有効にするかどうかを指定します。有効な値:

  • true: 削除保護を有効にします。

  • false: 削除保護を無効にします。これがデフォルト値です。

true

DeletionProtectionDescription

string

任意

削除保護の説明。

説明

このパラメーターは、EnableDeletionProtection が true に設定されている場合にのみ使用できます。

This key is being used by XXX service. You are protected from deletion.

KeyId

string

任意

キーの ID。

key-hzz65f3a68554s6ms****

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター

タイプ

説明

object

RequestId

string

リクエストの ID。 ID は、リクエストに対して Alibaba Cloud によって生成される一意の識別子です。この ID を使用して問題のトラブルシューティングを行うことができます。

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

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。