Encrypt - Key Management Service: Central de Documentação do Alibaba Cloud

Descrição da operação

Precauções

Para informações sobre a política de acesso necessária para permitir que um usuário RAM ou função RAM use esta operação, consulte Resource Access Management.
Esta operação é acessível por meio de um gateway compartilhado ou um gateway dedicado. Para mais informações, consulte Alibaba Cloud SDK.
- Gateway compartilhado: Você pode acessar o KMS pela Internet ou por uma VPC. Para usar este método, você deve habilitar o acesso à Internet. Para mais informações, consulte Acessar chaves em uma instância KMS pela Internet.
- Gateway dedicado: Você pode acessar o KMS usando o endpoint privado do KMS (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com).

Limites de QPS

Quando acessado por meio de um gateway compartilhado, o limite de consultas por segundo (QPS) para um único usuário é 1.000. Se o limite for excedido, as solicitações serão limitadas, o que pode afetar seus negócios. Recomendamos que você permaneça dentro deste limite para evitar limitação.
Quando acessado por meio de um gateway dedicado, o limite de QPS para um único usuário está sujeito às especificações de desempenho de computação da sua instância KMS. Para mais informações, consulte Métricas de desempenho.

Descrição

O KMS criptografa os dados especificados usando a versão primária de uma chave especificada.
Você pode criptografar no máximo 6 KB de dados, como uma chave RSA, uma senha de banco de dados ou outras informações sensíveis.
Se você migrar dados criptografados de uma região para outra, pode chamar a operação Encrypt na região de destino para recriptografar a chave de dados em texto simples da região de origem. Isso gera uma nova chave de dados criptografada. Você pode então chamar a operação Decrypt para descriptografar essa nova chave na região de destino.

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
KeyId	string	Sim	O ID da chave. Você também pode especificar o alias ou o Amazon Resource Name (ARN) da chave. Para mais informações sobre aliases, consulte Gerenciar aliases. Nota Quando você acessa uma chave em outra conta Alibaba Cloud, deve especificar o ARN da chave. O ARN de uma chave está no formato `acs:kms:${region}:${account}:key/${keyid}`.	key-hzz630494463ejqjx****
Plaintext	string	Sim	O texto simples a ser criptografado. O texto simples deve estar codificado em Base64.	SGVsbG8gd29y****
EncryptionContext	object	Não	Uma string JSON que consiste em pares chave-valor. Se você especificar este parâmetro, deverá especificar o mesmo parâmetro ao chamar a operação Decrypt. Para mais informações, consulte EncryptionContext.	{"Example":"Example"}
DryRun	string	Não	Especifica se o recurso de dry run deve ser ativado. true: ativa o recurso de dry run. false (padrão): desativa o recurso de dry run. O recurso de dry run é usado para testar chamadas de API e verificar as permissões nos recursos que você possui e a validade dos parâmetros da solicitação. Você pode visualizar os resultados da verificação na resposta. DryRunOperationError: As permissões e os parâmetros são válidos. Se você não especificar o parâmetro DryRun, a solicitação será bem-sucedida. ValidationError: Os parâmetros na solicitação são inválidos. AccessDeniedError: Você não está autorizado a realizar esta operação no recurso KMS.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
KeyVersionId	string	O ID da versão da chave usada para criptografar o texto simples. É a versão primária da chave especificada.	86a9efd9-3d16-4894-bd4f-1fc43f3f****
KeyId	string	O ID da chave. Se você usar um alias ou um ARN da chave na solicitação, o ID da chave será retornado.	key-hzz630494463ejqjx****
CiphertextBlob	string	O texto cifrado dos dados criptografados usando a versão primária da chave especificada.	DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****
RequestId	string	O ID da solicitação, que é um identificador único gerado pelo Alibaba Cloud para a solicitação. Você pode usar o ID para solucionar problemas.	475f1620-b9d3-4d35-b5c6-3fbdd941423d

Exemplos

Resposta de sucesso

JSON formato

{
  "KeyVersionId": "86a9efd9-3d16-4894-bd4f-1fc43f3f****",
  "KeyId": "key-hzz630494463ejqjx****",
  "CiphertextBlob": "DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****",
  "RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	The specified parameter is invalid.	An invalid value is specified for the parameter.
404	Forbidden.KeyNotFound	The specified Key is not found.	The error message returned because the specified CMK does not exist.
404	Forbidden.AliasNotFound	The specified Alias is not found.	The error message returned because the specified alias does not exist.
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.