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

Descrição da operação

Para realizar operações criptográficas e recuperar valores secretos, os aplicativos autogerenciados devem usar uma chave de cliente para acessar uma instância do Key Management Service (KMS). O processo a seguir mostra como criar um ponto de acesso de aplicativo (AAP) baseado em chave de cliente:

Crie uma regra de controle de acesso: Você pode configurar os endereços IP privados ou blocos CIDR privados que têm permissão para acessar uma instância do KMS. Para obter mais informações, consulte CreateNetworkRule.
Crie uma política de permissão: Você pode configurar as chaves e os segredos que têm permissão para acessar e vincular regras de controle de acesso às chaves e aos segredos. Para obter mais informações, consulte CreatePolicy.
Crie um AAP: Você pode configurar um método de autenticação e vincular uma política de permissão a um AAP. Para obter mais informações, consulte CreateApplicationAccessPoint.
Crie uma chave de cliente: Você pode configurar a senha de criptografia e o período de validade de uma chave de cliente e vincular a chave de cliente a um AAP.

Precauções

Uma chave de cliente possui um período de validade. Após a expiração de uma chave de cliente, os aplicativos nos quais a chave de cliente está integrada não podem acessar a instância do KMS necessária. Você deve substituir a chave de cliente antes que ela expire. Recomendamos que você exclua a chave de cliente expirada no KMS após a nova chave de cliente ser utilizada.

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
AapName	string	Sim	A operação que você deseja realizar. Defina o valor como CreateClientKey.	aap_test
Password	string	Sim	O nome do AAP.	bcfefe15-46f0****
NotAfter	string	Não	A senha de criptografia da chave de cliente. A senha deve ter de 8 a 64 caracteres e deve conter pelo menos dois dos seguintes tipos: dígitos, letras e caracteres especiais. Os caracteres especiais incluem `~ ! @ # $ % ^ & * ? _ -`.	2028-08-31T17:14:33Z
NotBefore	string	Não	O fim do período de validade da chave de cliente. Especifique a hora no padrão ISO 8601. A hora deve estar em UTC. A hora deve estar no formato yyyy-MM-ddTHH:mm:ssZ. Nota Se você não configurar NotAfter, o valor padrão é a hora em que a chave de cliente foi criada mais cinco anos. Se você configurar NotAfter, deverá configurar NotBefore.	2023-08-31T17:14:33Z

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O início do período de validade da chave de cliente. Especifique a hora no padrão ISO 8601. A hora deve estar em UTC. A hora deve estar no formato yyyy-MM-ddTHH:mm:ssZ. Nota Se você não configurar NotBefore, o valor padrão é a hora em que a chave de cliente foi criada. Se você configurar NotBefore, deverá configurar NotAfter.	2312e45f-b2fa-4c34-ad94-3eca50932916
ClientKeyId	string	O ID da solicitação, que é usado para localizar e solucionar problemas.	KAAP.66abf237-63f6-4625-b8cf-47e1086e****
KeyAlgorithm	string	O ID da chave de cliente.	RSA_2048
PrivateKeyData	string	O algoritmo usado para criptografar a chave privada da chave de cliente. Atualmente, apenas RSA_2048 é suportado.	MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******
NotBefore	string	A chave privada da chave de cliente.	2023-08-31T17:14:33Z
NotAfter	string	O início do período de validade da chave de cliente.	2028-08-31T17:14:33Z

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "2312e45f-b2fa-4c34-ad94-3eca50932916",
  "ClientKeyId": "KAAP.66abf237-63f6-4625-b8cf-47e1086e****",
  "KeyAlgorithm": "RSA_2048",
  "PrivateKeyData": "MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******",
  "NotBefore": "2023-08-31T17:14:33Z",
  "NotAfter": "2028-08-31T17:14:33Z"
}

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.