Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (Kms/2016-01-20) utiliza o estilo de assinatura RPC. Encapsulamos SDKs para linguagens de programação comuns para desenvolvedores. Os desenvolvedores podem baixar o SDK para chamar diretamente a OpenAPI deste produto sem se preocupar com detalhes técnicos. Se o SDK existente não atender às suas necessidades, você pode usar o mecanismo de assinatura para integração com assinatura própria. Como os detalhes da autoassinatura são muito complexos, isso pode levar cerca de 5 dias úteis. Portanto, recomendamos ingressar em nosso grupo de serviço DingTalk (147535001692) e realizar a integração de assinatura sob orientação especializada.
Antes de usar a API, você precisa preparar sua conta de identidade e chave de acesso (AccessKey) para acessar efetivamente a API por meio de ferramentas cliente (SDK, CLI, etc.). Para obter detalhes, consulte Obter um AccessKey.
Cenários de assinatura personalizada
Se o seu cenário de negócios tiver requisitos especiais e você precisar integrar a API por meio de autoassinatura, recomendamos consultar primeiro nossa equipe de suporte técnico (grupo de serviço DingTalk: 147535001692) para obter orientação profissional e garantir uma integração eficiente.
Preparação de conta e segurança
As contas da Alibaba Cloud têm permissões administrativas completas sobre todos os recursos. Quando um AccessKey é comprometido, todos os recursos associados estarão em risco de acesso não autorizado. Para garantir a segurança, recomenda-se criar um usuário RAM com apenas permissões de acesso à API e configurar seu AccessKey, além de configurar políticas RAM com base no princípio do menor privilégio (PoLP). Use a conta da Alibaba Cloud apenas em cenários específicos em que as permissões da conta da Alibaba Cloud sejam explicitamente necessárias.
Gerenciamento de serviços
|
API |
Título |
Descrição |
| DescribeAccountKmsStatus | DescribeAccountKmsStatus. | Consulta o status do Key Management Service (KMS) em sua conta do Alibaba Cloud. |
| OpenKmsService | OpenKmsService. | Ativa o Key Management Service (KMS) para a sua conta Alibaba Cloud. |
Gerenciamento de instâncias
|
API |
Título |
Descrição |
| ListKmsInstances | ListKmsInstances. | Consulta todas as instâncias do KMS na região atual. |
| ConnectKmsInstance | ConnectKmsInstance. | Ativa uma instância do Key Management Service (KMS). |
| GetKmsInstance | GetKmsInstance. | Obtém os detalhes de uma instância KMS. |
| UpdateKmsInstanceBindVpc | UpdateKmsInstanceBindVpc. | Atualiza as vinculações de VPC de uma instância KMS. |
| ReleaseKmsInstance | ReleaseKmsInstance. | Libera uma instância KMS com pagamento conforme o uso. |
| GetDefaultKmsInstance | GetDefaultKmsInstance. | Consulta a instância padrão do KMS em uma região especificada. |
Gerenciamento de chaves
|
API |
Título |
Descrição |
| CreateKey | CreateKey. | Cria uma chave mestra do cliente (CMK) para criptografia de envelope, assinaturas digitais ou outras operações criptográficas. |
| ListKeys | ListKeys. | Consulta os IDs e ARNs de todas as CMKs na região atual. |
| DescribeKey | DescribeKey. | Consulta os metadados de uma CMK, como o estado da chave, o uso e a configuração de rotação. |
| UpdateKeyDescription | UpdateKeyDescription. | Atualiza a descrição de uma CMK. |
| EnableKey | EnableKey. | Ativa uma chave para criptografar e descriptografar dados. |
| DisableKey | DisableKey. | Desativa uma chave. |
| GetPublicKey | GetPublicKey. | Obtém a chave pública de uma chave assimétrica. Você pode usar a chave pública para criptografar dados ou verificar uma assinatura no seu dispositivo. |
| CreateAlias | CreateAlias. | Cria um alias para uma chave. |
| ListAliases | ListAliases. | Consulta todos os aliases na região atual para a conta atual. |
| ListAliasesByKeyId | ListAliasesByKeyId. | Consulta todos os aliases vinculados a uma chave. |
| DeleteAlias | DeleteAlias. | Exclui um alias. |
| UpdateAlias | UpdateAlias. | Vincula um alias existente a um ID de chave mestra do cliente (CMK) diferente. |
| GetParametersForImport | GetParametersForImport. | Consulta os parâmetros usados para importar material de chave para uma Chave Mestra do Cliente (CMK). |
| ImportKeyMaterial | ImportKeyMaterial. | Importa material de chave gerado externamente para uma CMK cuja origem é EXTERNAL. |
| DeleteKeyMaterial | DeleteKeyMaterial. | Exclui o material de chave importado de uma CMK. Após a exclusão, a CMK entra no estado PendingImport até que você reimporte o material de chave. |
| ScheduleKeyDeletion | ScheduleKeyDeletion. | Exclui uma chave mestra de cliente (CMK) especificada. |
| CancelKeyDeletion | CancelKeyDeletion. | Cancela a tarefa de exclusão de uma CMK. |
| SetDeletionProtection | SetDeletionProtection. | Ativa ou desativa a proteção contra exclusão para uma chave mestra do cliente (CMK). |
| UpdateRotationPolicy | UpdateRotationPolicy. | Atualiza a política de rotação automática de uma CMK. |
| DescribeKeyVersion | DescribeKeyVersion. | Consulta os metadados de uma versão específica de CMK. |
| CreateKeyVersion | CreateKeyVersion. | Cria uma versão para uma chave mestra de cliente (CMK). |
| ListKeyVersions | ListKeyVersions. | Consulta todas as versões de uma CMK especificada. |
| SetKeyPolicy | SetKeyPolicy. | Define a política de chave para uma CMK em uma instância KMS. |
| GetKeyPolicy | GetKeyPolicy. | Consulta a política de chave de uma CMK em uma instância KMS. |
Operações criptográficas
|
API |
Título |
Descrição |
| GenerateDataKey | GenerateDataKey. | Gera uma chave de dados aleatória para criptografia de envelope. A chave de dados é retornada nas formas de texto simples e texto cifrado. |
| GenerateAndExportDataKey | GenerateAndExportDataKey. | Gera uma chave de dados aleatória, criptografa-a usando uma CMK e uma chave pública que você especificar e retorna ambos os textos cifrados. |
| Encrypt | Encrypt. | Criptografa texto simples usando uma CMK simétrica. |
| Decrypt | Decrypt. | Descriptografa o texto cifrado que foi criptografado usando uma CMK. |
| ReEncrypt | ReEncrypt. | Recriptografa o texto cifrado sob uma CMK diferente sem expor o texto simples. |
| ExportDataKey | ExportDataKey. | Exporta uma chave de dados criptografada por uma CMK. A chave de dados é recriptografada por uma chave pública que você especifica para transmissão segura. |
| GenerateDataKeyWithoutPlaintext | GenerateDataKeyWithoutPlaintext. | Gera uma chave de dados aleatória apenas em formato de texto cifrado, sem a cópia em texto simples. |
| AsymmetricSign | AsymmetricSign. | Gera uma assinatura digital usando uma CMK assimétrica. |
| AsymmetricVerify | AsymmetricVerify. | Verifica uma assinatura digital utilizando a chave pública de uma CMK assimétrica. |
| AsymmetricEncrypt | AsymmetricEncrypt. | Criptografa dados usando a chave pública de uma CMK assimétrica. |
| AsymmetricDecrypt | AsymmetricDecrypt. | Descriptografa dados usando a chave privada de uma CMK assimétrica. |
| GenerateMac | Gerar código de autenticação de mensagem HMAC. | Gera um código de autenticação de mensagem HMAC para uma mensagem usando uma chave especificada. |
| VerifyMac | Verificação do código de autenticação de mensagem HMAC. | Verifica o código de autenticação de mensagem HMAC de uma mensagem específica usando uma chave especificada. |
Gerenciamento de segredos
|
API |
Título |
Descrição |
| ListSecrets | ListSecrets. | Consulta todos os segredos na região atual. |
| GetSecretValue | Retrieve a secret value. | Obtém um valor de segredo. |
| BatchGetSecretValue | Retrieve secret values in batches | Obtém valores de segredos em lotes. |
| DeleteSecret | DeleteSecret. | Exclui um segredo. |
| CreateSecret | CreateSecret. | Cria um segredo e armazena sua versão inicial. |
| UpdateSecret | UpdateSecret. | Atualiza os metadados de um segredo. |
| UpdateSecretVersionStage | UpdateSecretVersionStage. | Move um rótulo de estágio de versão para uma versão diferente de um segredo. |
| UpdateSecretRotationPolicy | UpdateSecretRotationPolicy. | Atualiza a política de rotação de um segredo. |
| DescribeSecret | DescribeSecret. | Consulta os metadados de um segredo. |
| ListSecretVersionIds | Consultar todas as informações de versão de um segredo. | Consulta todas as informações de versão de um segredo. |
| GetRandomPassword | GetRandomPassword. | Gera uma string de senha aleatória. |
| PutSecretValue | PutSecretValue | Armazena uma nova versão de um valor de segredo para um segredo genérico. |
| RestoreSecret | RestoreSecret. | Restaura um segredo excluído. |
| RotateSecret | RotateSecret. | Rotaciona imediatamente um segredo. |
| SetSecretPolicy | SetSecretPolicy. | Define a política de acesso para um segredo em uma instância KMS. |
| GetSecretPolicy | GetSecretPolicy. | Consulta a política de acesso de um segredo especificado em uma instância KMS. |
Gerenciamento de tags
|
API |
Título |
Descrição |
| UntagResources | UntagResources. | Remove tags de chaves ou secrets. |
| TagResources | TagResources. | Adiciona tags a uma ou mais chaves ou segredos. |
| ListTagResources | ListTagResources. | Lista as tags vinculadas a uma chave ou a um segredo. |
| GetKmsInstanceQuotaInfos | GetKmsInstanceQuotaInfos. | Consulta o uso de cotas e os limites de uma instância KMS. |
| ListResourceTags | ListResourceTags. | Consulta as tags de uma chave mestra de cliente (CMK). |
| TagResource | TagResource. | Adiciona tags a uma CMK, segredo ou certificado. |
| UntagResource | UntagResource. | Remove tags de uma CMK, segredo ou certificado. |
Gerenciamento de aplicativos
|
API |
Título |
Descrição |
| CreateNetworkRule | CreateNetworkRule. | Cria uma regra de acesso à rede para configurar os endereços IP privados ou blocos CIDR privados com permissão para acessar uma instância do Key Management Service (KMS). |
| ListNetworkRules | ListNetworkRules. | Consulta todas as regras de acesso à rede na região atual. |
| DescribeNetworkRule | DescribeNetworkRule. | Obtém os detalhes de uma regra de acesso à rede. |
| UpdateNetworkRule | UpdateNetworkRule. | Atualiza uma regra de acesso à rede. |
| DeleteNetworkRule | DeleteNetworkRule. | Exclui uma regra de acesso à rede. |
| CreatePolicy | CreatePolicy. | Cria uma política de permissão para configurar as chaves e os segredos cujo acesso é permitido. |
| ListPolicies | ListPolicies. | Consulta todas as políticas de permissão na região atual. |
| DescribePolicy | DescribePolicy. | Obtém os detalhes de uma política de permissão. |
| UpdatePolicy | UpdatePolicy. | Atualiza uma política de permissão. |
| DeletePolicy | DeletePolicy. | Exclui uma política de permissão. |
| CreateApplicationAccessPoint | CreateApplicationAccessPoint. | Cria um ponto de acesso de aplicativo (AAP). |
| ListApplicationAccessPoints | ListApplicationAccessPoints. | Consulta todos os pontos de acesso de aplicativo (AAPs) na região atual. |
| DescribeApplicationAccessPoint | DescribeApplicationAccessPoint. | Obtém os detalhes de um ponto de acesso de aplicativo (AAP). |
| UpdateApplicationAccessPoint | UpdateApplicationAccessPoint. | Atualiza as informações sobre um ponto de acesso de aplicação (AAP). |
| DeleteApplicationAccessPoint | DeleteApplicationAccessPoint. | Exclui um ponto de acesso de aplicativo (AAP). |
| CreateClientKey | CreateClientKey. | Cria uma chave de cliente. |
| ListClientKeys | ListClientKeys. | Consulta todas as chaves de cliente dentro de um AAP. |
| GetClientKey | GetClientKey. | Obtém informações sobre uma chave de cliente. |
| DeleteClientKey | DeleteClientKey. | Exclui uma chave de cliente. |
Outros
|
API |
Título |
Descrição |
| DescribeRegions | DescribeRegions. | Consulta as regiões onde o KMS está disponível. |
| GetManagedDataKey | Obter texto simples da chave de dados gerenciada. | Obtém o texto simples de uma chave de dados gerenciada (DK). |
| ListManagedDataKeyVersions | Listar versões de chave de uma chave de dados gerenciada. | Lista as versões de chave de uma chave de dados gerenciada (DK) especificada. |