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

Descrição da operação

Para obter detalhes sobre as políticas de permissão que devem ser concedidas a um usuário ou função do Resource Access Management (RAM) para chamar esta operação de API, consulte Controle de acesso.
Antes que um aplicativo autogerenciado possa executar operações criptográficas ou obter valores de credenciais, ele deve acessar a instância do KMS usando uma ClientKey. O processo geral de criação de um ponto de acesso de aplicativo (AAP) e uma ClientKey é o seguinte:
1. Crie uma regra de controle de rede: configure o IP privado ou o bloco CIDR privado com permissão para acessar o KMS. Para obter mais informações, consulte CreateNetworkRule.
2. Crie uma política de acesso: configure as chaves e credenciais que o aplicativo tem permissão para acessar e anexe a regra de controle de rede. Para obter mais informações, consulte CreatePolicy.
3. Crie um ponto de acesso de aplicativo: configure o método de autenticação e anexe a política de acesso. Para obter mais informações, consulte CreateApplicationAccessPoint.
4. Crie uma ClientKey: configure a senha de criptografia e o período de validade da ClientKey e anexe o ponto de acesso de aplicativo. Este é o conteúdo descrito neste tópico.

Precauções

Uma ClientKey possui um período de validade. Após a expiração da ClientKey, o KMS não permite que aplicativos integrados à ClientKey acessem a instância do KMS. Substitua a ClientKey antes que ela expire. Exclua a ClientKey expirada no KMS após a conclusão da substituição.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

kms:CreateClientKey

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AapName	string	Sim	O nome do ponto de acesso de aplicativo (AAP) anexado.	aap_test
Password	string	Sim	A senha da ClientKey. A senha deve ter de 8 a 64 caracteres e pode conter dígitos, letras maiúsculas e minúsculas e caracteres especiais como `~!@#$%^&*?_-`. Deve conter pelo menos dois desses tipos de caracteres.	bcfefe15-46f0****
NotAfter	string	Não	A hora de término do período de validade da ClientKey. A hora é especificada no padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ssZ. A hora deve estar em UTC. Nota Se você não especificar NotAfter, o valor padrão é a hora de criação da ClientKey mais 5 anos. Se você especificar NotAfter, também deverá especificar NotBefore.	2028-08-31T17:14:33Z
NotBefore	string	Não	A hora de início do período de validade da ClientKey. A hora é especificada no padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ssZ. A hora deve estar em UTC. Nota Se você não especificar NotBefore, o valor padrão é a hora de criação da ClientKey. Se você especificar NotBefore, também deverá especificar NotAfter.	2023-08-31T17:14:33Z

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. É um identificador exclusivo gerado pela Alibaba Cloud para a solicitação e pode ser usado para solucionar e localizar problemas.	2312e45f-b2fa-4c34-ad94-3eca50932916
ClientKeyId	string	O ID da ClientKey.	KAAP.66abf237-63f6-4625-b8cf-47e1086e****
KeyAlgorithm	string	O algoritmo usado para criptografar o conteúdo da chave privada da ClientKey. Apenas RSA_2048 é suportado.	RSA_2048
PrivateKeyData	string	O conteúdo da chave privada da ClientKey.	MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******
NotBefore	string	A hora de início do período de validade da ClientKey.	2023-08-31T17:14:33Z
NotAfter	string	A hora de término do período de validade da ClientKey.	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.