SetDeletionProtection - - Centre de documentation Alibaba Cloud

Description de l'opération

Pour plus de détails sur la stratégie d'accès qui doit être accordée à un utilisateur Resource Access Management (RAM) ou à un rôle RAM pour appeler cette opération, consultez Contrôle d'accès.
Après avoir activé la protection contre la suppression pour une CMK, vous ne pouvez pas supprimer la CMK. Pour supprimer la CMK, désactivez d'abord la protection contre la suppression.
Avant d'appeler l'opération SetDeletionProtection, assurez-vous que la CMK n'est pas dans l'état PendingDeletion. Vous pouvez appeler l'opération DescribeKey pour interroger l'état (KeyState) de la CMK.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

kms:SetDeletionProtection

update

*Key

acs:kms:{#regionId}:{#accountId}:key/{#keyId}

kms:tag

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ProtectedResourceArn	string	Non	L'ARN de la CMK pour laquelle vous souhaitez définir la protection contre la suppression. Vous pouvez appeler l'opération DescribeKey pour interroger l'ARN (Arn) de la CMK.	acs:kms:cn-hangzhou:123213123**:key/0225f411-b21d-46d1-be5b-93931c82**
EnableDeletionProtection	boolean	Oui	Indique si la protection contre la suppression doit être activée. Valeurs valides : true : active la protection contre la suppression. false (par défaut) : désactive la protection contre la suppression.	true
DeletionProtectionDescription	string	Non	La description de la protection contre la suppression. Remarque Ce paramètre n'est valide que lorsque EnableDeletionProtection est défini sur true.	La CMK est utilisée par XXX. La protection contre la suppression est activée
KeyId	string	Non	L'identifiant de la clé.	key-hzz65f3a68554s6ms****
KmsInstanceId	string	Non

Pour plus d'informations sur les paramètres de requête courants, consultez Paramètres courants.

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête. Alibaba Cloud génère un identifiant unique pour chaque requête API. Vous pouvez utiliser cet identifiant pour résoudre les problèmes.	3455b9b4-95c1-419d-b310-db6a53b09a39

Exemples

JSON format

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

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.