Todos os produtos
Search
Central de documentação

Key Management Service:SetDeletionProtection

Última atualização: Jul 15, 2026

Ativa ou desativa a proteção contra exclusão para uma chave mestra do cliente (CMK).

Descrição da operação

  • Para obter detalhes sobre a política de acesso que deve ser concedida a um usuário do Resource Access Management (RAM) ou a uma função do RAM para invocar esta operação, consulte Controle de acesso.

  • Após ativar a proteção contra exclusão para uma CMK, você não poderá excluir a CMK. Para excluir a CMK, desative primeiro a proteção contra exclusão.

  • Antes de invocar a operação SetDeletionProtection, certifique-se de que a CMK não esteja no estado PendingDeletion. Você pode invocar a operação DescribeKey para consultar o status (KeyState) da CMK.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

ProtectedResourceArn

string

Não

O ARN da CMK para a qual você deseja definir a proteção contra exclusão.
Você pode chamar a operação DescribeKey para consultar o ARN da CMK (Arn).

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

EnableDeletionProtection

boolean

Sim

Especifica se a proteção contra exclusão deve ser ativada. Valores válidos:

  • true: ativa a proteção contra exclusão.

  • false (valor padrão): desativa a proteção contra exclusão.

true

DeletionProtectionDescription

string

Não

A descrição da proteção contra exclusão.

Nota

Este parâmetro é válido apenas quando EnableDeletionProtection é definido como true.

The CMK is being used by XXX. Deletion protection is set.

KeyId

string

Não

O ID da chave.

key-hzz65f3a68554s6ms****

KmsInstanceId

string

Não

Para obter mais informações sobre os parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

RequestId

string

O ID da solicitação. O Alibaba Cloud gera um identificador exclusivo para cada solicitação de API. Você pode usar este ID para solucionar problemas.

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

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.