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

事前注意

  • CMKの削除保護を有効にすると、CMKは削除できません。 CMKを削除する場合は、まずCMKの削除保護を無効にする必要があります。
  • SetDeletionProtection操作を呼び出す前に、必要なCMKが [保留中の削除] 状態でないことを確認してください。 DescribeKey操作を呼び出して、KeyStateパラメーターで指定されたCMKステータスを照会できます。

このトピックで提供されているパラメーター設定を使用すると、Alibaba Cloudリソース名 (ARN) がacs:kms:cn-hangzhou:123213123 ****:key/0225f411-b21d-46d1-be5b-93931c82 **** のCMKの削除保護を有効にできます。 CMK ARNは、ProtectedResourceArnパラメーターで指定されます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 SetDeletionProtection

実行する操作です。 値をSetDeletionProtectionに設定します。

EnableDeletionProtection Boolean 必須 true

削除保護を有効にするかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: 削除保護を有効にします
  • false: 削除保護を無効にする
ProtectedResourceArn String 必須 acs:kms:cn-hangzhou:123213123 ****: キー /0225f411-b21d-46d1-be5b-93931c82 ****

削除保護を設定するCMKのARN。

DescribeKey操作を呼び出して、CMK ARNを照会できます。

DeletionProtectionDescription String 任意 CMKはXXXによって使用されています。 削除保護が設定されています。

削除保護の説明。

注 このパラメーターは、EnableDeletionProtectionパラメーターをtrueに設定した場合にのみ有効になります。

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

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String 3455b9b4-95c1-419d-b310-db6a53b09a39

リクエストの ID です。

例

リクエストの例

http(s)://[Endpoint]/?Action=SetDeletionProtection
&EnableDeletionProtection=true
&ProtectedResourceArn=acs:kms:cn-hangzhou:123213123 ****:key/0225f411-b21d-46d1-be5b-93931c82 ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<KMS>
      <RequestId>3455b9b4-95c1-419d-b310-db6a53b09a39</RequestId>
</KMS>

JSON 形式 

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

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。