API operations provided by KMS and their descriptions - : Central de Documentação do Alibaba Cloud

Gerenciamento de serviço

API	Descrição
DescribeRegions	Consulta a lista de regiões disponíveis para a conta atual do Alibaba Cloud.
OpenKmsService	Ative o KMS para a conta atual do Alibaba Cloud.
DescribeAccountKmsStatus	Consulta o status do KMS na conta atual do Alibaba Cloud.

Gerenciamento de instâncias

API	Descrição
ConnectKmsInstance	Ative uma instância do KMS.
GetKmsInstance	Obtém os detalhes de uma instância do KMS.
ListKmsInstances	Lista as instâncias do KMS.
UpdateKmsInstanceBindVpc	Atualiza a Virtual Private Cloud (VPC) associada a uma instância do KMS.

Gerenciamento de chaves

Gerencie chaves por meio das operações de API abaixo, incluindo criação e exclusão de chaves e aliases.

API	Descrição
CreateKey	Cria uma chave. Use material de chave gerado pelo KMS ou importe seu próprio material. A importação de material próprio é conhecida como Bring Your Own Key (BYOK).
GetParametersForImport	Obtém os parâmetros necessários para importar material de chave para uma chave.
ImportKeyMaterial	Importa material de chave para uma chave.
EnableKey	Altera o status de uma chave para Enabled.
DisableKey	Altera o status de uma chave para Disabled.
DescribeKey	Consulta as informações de uma chave.
ListKeys	Lista todas as chaves de uma conta do Alibaba Cloud em uma região.
UpdateKeyDescription	Atualiza a descrição de uma chave.
CreateAlias	Cria um alias e o vincula a uma chave.
UpdateAlias	Atualiza o ID da chave vinculada a um alias.
DeleteAlias	Exclua um alias.
ListAliases	Lista todos os aliases de uma conta do Alibaba Cloud em uma região.
ListAliasesByKeyId	Lista os aliases vinculados a uma chave específica.
SetDeletionProtection	Ative ou desative a proteção contra exclusão.
ScheduleKeyDeletion	Agenda a exclusão de uma chave. Após essa chamada, a chave entra no estado Pending Deletion e é excluída automaticamente ao término do período de espera especificado.
CancelKeyDeletion	Cancele a exclusão agendada de uma chave. É possível cancelar a exclusão antes do término do período de espera. Após o cancelamento, a chave retorna ao estado Enabled.
DeleteKeyMaterial	Exclua o material de chave. Importante Somente é possível excluir material de chave externo da chave mestra do cliente (CMK) usada como chave padrão.
CreateKeyVersion	Cria uma versão. Chaves simétricas em instâncias do KMS do tipo gerenciamento de chaves por software suportam esta operação. Chaves assimétricas fora do KMS também são compatíveis.
DescribeKeyVersion	Consulta as informações de uma versão de chave.
ListKeyVersions	Lista todas as versões de uma chave.
UpdateRotationPolicy	Atualiza a política de rotação de uma chave. Se a rotação automática estiver ativada, o KMS gera periodicamente uma nova versão da chave.

Operações criptográficas

Execute operações criptográficas em dados usando chaves do KMS, como criptografia, geração de chaves de dados, descriptografia e cálculo de assinaturas.

API	Descrição
Encrypt	Criptografa texto simples em texto cifrado usando uma chave simétrica.
GenerateDataKey	Gera uma chave de dados aleatória para criptografia local de dados.
GenerateDataKeyWithoutPlaintext	Gera uma chave de dados aleatória para criptografia local sem retornar o texto simples da chave.
ExportDataKey	Criptografa uma chave de dados com uma chave pública especificada e exporta a chave resultante.
GenerateAndExportDataKey	Gera uma chave de dados aleatória e a criptografa com a chave do KMS e a chave pública especificadas. Retorna o texto cifrado da chave protegida por ambas as chaves.
Decrypt	Descriptografa texto cifrado.
ReEncrypt	Recriptografa texto cifrado. O KMS descriptografa o conteúdo original, recriptografa o texto simples ou a chave de dados gerada com outra chave e retorna o novo texto cifrado.
AsymmetricSign	Gera uma assinatura digital usando uma chave assimétrica.
AsymmetricVerify	Verifique uma assinatura digital usando uma chave assimétrica.
AsymmetricDecrypt	Descriptografa dados usando uma chave assimétrica.
AsymmetricEncrypt	Criptografa dados usando uma chave assimétrica.
GetPublicKey	Obtém a chave pública de um par de chaves assimétricas. Use-a para criptografar dados locais e verificar assinaturas.

Gerenciamento de segredos

Gerencie, proteja, distribua e rotacione segredos por meio das operações de API listadas abaixo.

API	Descrição
CreateSecret	Cria um segredo e armazena seu valor na versão inicial.
ListSecrets	Lista todos os segredos de uma conta do Alibaba Cloud em uma região.
DescribeSecret	Consulta os metadados de um segredo.
UpdateSecret	Atualiza os metadados de um segredo.
PutSecretValue	Armazena o valor de uma nova versão em um segredo. Nota Apenas segredos genéricos suportam esta operação.
UpdateSecretVersionStage	Atualiza o rótulo de estágio que identifica uma versão do segredo. Nota Apenas segredos genéricos suportam esta operação.
DeleteSecret	Exclua ou agenda a exclusão de um segredo.
RestoreSecret	Restaura um segredo cuja exclusão foi agendada.
ListSecretVersionIds	Lista todas as versões de um segredo.
GetRandomPassword	Gera uma string de senha aleatória.
RotateSecret	Rotaciona manualmente um segredo.
UpdateSecretRotationPolicy	Atualiza a política de rotação de um segredo.

Recuperação de valor de segredo

GetSecretValue: Recupera o valor de um segredo.

Gerenciamento de tags

Adicione várias tags a uma chave ou segredo. Cada tag é composta por uma chave de tag e um valor de tag.

Nota

As operações TagResource, UntagResource e ListResourceTags atuam sobre um único recurso. Já as operações TagResources, UntagResources e ListTagResources permitem operações em lote em vários recursos.

API	Descrição
TagResource	Adiciona uma tag a uma chave ou segredo.
UntagResource	Remove uma tag de uma chave ou segredo.
ListResourceTags	Lista todas as tags de uma chave.
TagResources	Adiciona tags a várias chaves ou segredos simultaneamente.
UntagResources	Remove tags de várias chaves ou segredos em lote.
ListTagResources	Consulta todas as tags ou tags específicas de várias chaves ou segredos em lote.

Gerenciamento de aplicativos

API	Descrição
CreateNetworkRule	Cria uma regra de controle de acesso para definir os endereços IP privados ou blocos CIDR autorizados a acessar uma instância do KMS.
DeleteNetworkRule	Exclua uma regra de acesso de rede.
DescribeNetworkRule	Obtém os detalhes de uma regra de acesso de rede.
ListNetworkRules	Lista as regras de acesso de rede configuradas.
UpdateNetworkRule	Atualiza uma regra de acesso de rede existente.
CreatePolicy	Cria uma política de permissões para definir quais chaves e segredos um aplicativo pode acessar.
DeletePolicy	Exclua uma política de permissões.
DescribePolicy	Consulta os detalhes de uma política de permissões.
UpdatePolicy	Atualiza uma política de permissões.
ListPolicies	Lista as políticas de permissões disponíveis.
CreateApplicationAccessPoint	Cria um ponto de acesso de aplicativo (AAP).
DeleteApplicationAccessPoint	Exclua um AAP.
DescribeApplicationAccessPoint	Obtém os detalhes de um AAP.
ListApplicationAccessPoints	Lista os AAPs configurados.
UpdateApplicationAccessPoint	Atualiza as informações de um AAP.
CreateClientKey	Cria uma chave de cliente.
DeleteClientKey	Exclua uma chave de cliente.
ListClientKeys	Lista as chaves de cliente existentes.
GetClientKey	Consulta as informações de uma chave de cliente.