カスタマーマスターキー (CMK) の削除保護を有効または無効にします。
操作説明
-
この操作を呼び出すために RAM ユーザーまたは RAM ロールに付与する必要があるアクセスポリシーの詳細については、「アクセスの制御」をご参照ください。
-
CMK の削除保護を有効にすると、その CMK を削除できなくなります。CMK を削除するには、まず削除保護を無効にする必要があります。
-
SetDeletionProtection 操作を呼び出す前に、CMK が PendingDeletion 状態ではないことを確認してください。 DescribeKey 操作を呼び出して、CMK のステータス (KeyState) をクエリできます。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProtectedResourceArn |
string |
任意 |
削除保護を設定する CMK の Amazon リソースネーム (ARN)。 DescribeKey 操作を呼び出して、CMK の Amazon リソースネーム (ARN) (Arn) をクエリできます。 |
acs:kms:cn-hangzhou:123213123****:key/0225f411-b21d-46d1-be5b-93931c82**** |
| EnableDeletionProtection |
boolean |
必須 |
削除保護を有効にするかどうかを指定します。有効な値:
|
true |
| DeletionProtectionDescription |
string |
任意 |
削除保護の説明。 説明
このパラメーターは、EnableDeletionProtection が true に設定されている場合にのみ有効です。 |
该密钥正在被XXX服务使用。已为您设置删除保护。 |
| KeyId |
string |
任意 |
キーの ID。 |
key-hzz65f3a68554s6ms**** |
| KmsInstanceId |
string |
任意 |
共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。Alibaba Cloud は各 API リクエストに対して一意の識別子を生成します。この ID を使用して問題のトラブルシューティングを行えます。 |
3455b9b4-95c1-419d-b310-db6a53b09a39 |
例
成功レスポンス
JSONJSON
{
"RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。