Todos os produtos
Search
Central de documentação

Key Management Service:CreateKey

Última atualização: Oct 26, 2026

Cria uma chave mestra.

Descrição da operaçã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:CreateKey

create

*Todos os recursos.

*

  • kms:tag
Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Description

string

Não

A descrição da chave.
A descrição deve ter de 0 a 8.192 caracteres.

key description example

KeyUsage

string

Não

A finalidade da chave. Valores válidos:

  • ENCRYPT/DECRYPT: Criptografia e descriptografia de dados.

  • SIGN/VERIFY: Geração e verificação de assinatura digital.

Valor padrão: Se a chave suportar geração e verificação de assinatura, o valor padrão será SIGN/VERIFY. Caso contrário, o valor padrão será ENCRYPT/DECRYPT.

ENCRYPT/DECRYPT

Origin

string

Não

A origem do material da chave. Valores válidos:

  • Aliyun_KMS (padrão): O material da chave é gerado pelo Alibaba Cloud KMS.

  • EXTERNAL: O material da chave é importado por você.

Nota
  • O valor diferencia maiúsculas de minúsculas.

Aliyun_KMS

ProtectionLevel

string

Não

Você não precisa especificar este parâmetro. O KMS configurará as definições de proteção apropriadas para a sua chave.

O nível de proteção da chave. Valores válidos:

  • SOFTWARE

  • HSM

Nota
  • Se DKMSInstanceId for especificado, este parâmetro não entrará em vigor. Se a instância for uma instância de gerenciamento de chaves de software, o nível de proteção será SOFTWARE. Se a instância for uma instância de gerenciamento de chaves de hardware, o nível de proteção será HSM.

  • Se DKMSInstanceId não for especificado, recomendamos que você não especifique este parâmetro e confie nas configurações do KMS. Se o KMS tiver um HSM gerenciado na região, este parâmetro será definido como HSM. Caso contrário, será definido como SOFTWARE. Para obter mais informações, consulte Visão geral do HSM gerenciado.

SOFTWARE

EnableAutomaticRotation

boolean

Não

Especifica se a rotação automática de chaves deve ser ativada. Valores válidos:

  • true: Ativa a rotação automática de chaves.

  • false (padrão): Desativa a rotação automática de chaves.

Este parâmetro só entra em vigor quando o tipo de gerenciamento de chaves ao qual a chave pertence suporta rotação automática. Para obter mais informações, consulte Rotação de chaves.

true

RotationInterval

string

Não

O período para rotação automática. O formato é inteiro[unidade], onde inteiro indica a duração do tempo e unidade indica a unidade de tempo. As unidades válidas são d (dias), h (horas), m (minutos) e s (segundos). Tanto 7d quanto 604800s indicam um período de 7 dias.

  • Se a chave for uma chave padrão, o valor será de 365 dias.

  • Se a chave for uma chave protegida por software, o valor será de 7 a 365 dias.

  • Se a chave for uma chave protegida por hardware, a rotação automática não é suportada.

Nota

Você deve especificar este parâmetro quando EnableAutomaticRotation estiver definido como true.

365d

KeySpec

string

Não

A especificação da chave. Os valores válidos variam de acordo com o tipo de gerenciamento de chaves. Para obter mais informações sobre especificações de chaves, padrões seguidos e algoritmos de chaves, consulte Tipos de gerenciamento de chaves e especificações de chaves.

Nota

Se você não especificar este parâmetro, a especificação de chave padrão será Aliyun_AES_256.

Aliyun_AES_256

DKMSInstanceId

string

Não

O ID da instância da instância do KMS.

Nota

Você deve especificar este parâmetro ao criar uma chave para uma instância do KMS. Você não precisa especificar este parâmetro ao criar uma chave padrão (chave mestra).

kst-bjj62d8f5e0sgtx8h****

Tags

string

Não

As tags a serem vinculadas à chave. Cada tag consiste em um par chave-valor, que inclui uma chave de tag e um valor de tag.

Você pode especificar até 20 tags. Para especificar várias tags, use o seguinte formato: [{"TagKey":"key1","TagValue":"value1"},{"TagKey":"key2","TagValue":"value2"},...].

Cada chave de tag e valor de tag pode ter até 128 caracteres e pode conter letras maiúsculas e minúsculas, dígitos, barras (/), barras invertidas (), sublinhados (_), hifens (-), pontos (.), sinais de mais (+), sinais de igual (=), dois-pontos (:) e arrobas (@).

Nota

Uma chave de tag não pode começar com aliyun ou acs:.

[{"TagKey":"disk-encryption","TagValue":"true"}]

Policy

string

Não

O conteúdo da política de chave no formato JSON. O comprimento máximo é de 32.768 bytes. Para obter mais informações sobre políticas de chave, consulte Visão geral da política de chave. Se você não especificar este parâmetro, a política de chave padrão será usada.

A política de chave inclui os seguintes campos:

  • Version: A versão da política de chave. Apenas a versão 1 é suportada.

  • Statement: As instruções da política de chave. Cada política de chave contém uma ou mais instruções.

A política de chave usa o seguinte formato:

{
  "Version": "1",
  "Statement": [
    {
      "Sid": "Enable RAM User Permissions",
      "Effect": "Allow",
      "Principal": {
        "RAM": ["acs:ram::112890462****:root"]
      },
      "Action": [
        "kms:*"
      ],
      "Resource": [
        "*"
      ],
      "Condition": {
        "condition operator": {
          "condition key": "condition value"
        }
      }
    }
  ]
}

Detalhes da instrução:

  • Sid: Opcional. O identificador de instrução personalizado. Pode ter até 128 caracteres e pode conter letras maiúsculas (A-Z), letras minúsculas (a-z), dígitos (0-9) e caracteres especiais (_/+=.@-).

  • Effect: Obrigatório. Especifica se deve permitir ou negar as permissões na instrução da política. Valores válidos: Allow e Deny.

  • Principal: Obrigatório. A entidade à qual a política está anexada. Você pode definir este campo como a conta atual do Alibaba Cloud (a conta à qual a chave pertence), usuários do RAM ou funções do RAM na conta atual do Alibaba Cloud, ou usuários do RAM ou funções do RAM em outras contas do Alibaba Cloud.

  • Action: Obrigatório. As operações de API a serem permitidas ou negadas. O valor deve começar com "kms:". Para o escopo da lista de permissões de operação, consulte Visão geral da política de chave. Se você especificar operações fora da lista, as configurações não entrarão em vigor.

  • Resource: Obrigatório. O valor só pode ser *, que indica a chave atual do KMS.

  • Condition: Opcional. As condições que devem ser atendidas para que a autorização entre em vigor. Você pode usar condições para avaliar o contexto das solicitações de API e determinar se a instrução da política se aplica. O formato é "Condition": {"condition operator": {"condition key": "condition value"}}. Para obter mais informações, consulte Visão geral da política de chave.

Nota

Depois de conceder permissões a usuários do RAM ou funções do RAM em outras contas do Alibaba Cloud, você ainda deve usar as contas do Alibaba Cloud dos usuários do RAM ou funções do RAM para autorizá-los a usar a chave no console do RAM. Somente então os usuários do RAM ou funções do RAM poderão usar a chave. Para operações específicas, consulte Exemplos de políticas personalizadas para o KMS, Conceder permissões a um usuário do RAM e Conceder permissões a uma função do RAM.

{"Statement":[{"Action":["kms:*"],"Effect":"Allow","Principal":{"RAM":["acs:ram::119285303511****:*"]},"Resource":["*"],"Sid":"kms default key policy"},{"Action":["kms:List*","kms:Describe*","kms:Create*","kms:Enable*","kms:Disable*","kms:Get*","kms:Set*","kms:Update*","kms:Delete*","kms:Cancel*","kms:TagResource","kms:UntagResource","kms:ImportKeyMaterial","kms:ScheduleKeyDeletion"],"Effect":"Allow","Principal":{"RAM":["acs:ram::119285303511****:user/for_test_policy"]},"Resource":["*"]}],"Version":"1"}

KeyStorageMechanism

string

Não

O local de armazenamento da chave protegida por hardware. Este parâmetro só entra em vigor quando DKMSInstanceId está definido como o ID de uma instância de gerenciamento de chaves de hardware. Valores válidos:

  • HsmInternal (padrão): A chave protegida por hardware é armazenada no HSM e não suporta rotação.

  • HsmEncryptedDatabase: A chave protegida por hardware é armazenada no banco de dados.
    • Chaves simétricas: Suportam rotação.

    • Chaves assimétricas: Não suportam rotação.

HsmInternal

Para obter mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

RequestId

string

O ID da solicitação. É um identificador exclusivo gerado pelo Alibaba Cloud para a solicitação e pode ser usado para solução de problemas.

381D5D33-BB8F-395F-8EE4-AE3BB4B523C4

KeyMetadata

object

Os metadados da chave.

KeyId

string

O identificador globalmente exclusivo da chave.

key-hzz62f1cb66fa42qo****

NextRotationDate

string

A hora da próxima rotação da chave.

Este valor é retornado apenas quando o parâmetro AutomaticRotation está definido como Enabled ou Suspended.

2024-03-25T10:00:00Z

KeyState

string

O status da chave.
Para obter mais informações, consulte Impacto do status da chave mestra do cliente (CMK) nas chamadas de API.

Enabled

RotationInterval

string

O intervalo para rotação automática de chaves. A unidade é segundos, e o formato é um número inteiro seguido pela letra s. Por exemplo, um intervalo de rotação de 7 dias é 604800s.

Este valor é retornado apenas quando o parâmetro AutomaticRotation está definido como Enabled ou Suspended.

31536000s

Arn

string

O ARN da chave.

acs:kms:cn-qingdao:154035569884****:key/key-hzz62f1cb66fa42qo****

Creator

string

O criador da chave.

154035569884****

LastRotationDate

string

A hora da última rotação (UTC).
Se a chave foi criada recentemente, este valor é a hora de geração da versão inicial da chave.

2023-03-25T10:00:00Z

DeleteDate

string

A hora de exclusão programada da chave. Para obter mais informações, consulte ScheduleKeyDeletion.

Este parâmetro é retornado apenas quando KeyState está definido como PendingDeletion.

2025-03-25T10:00:00Z

PrimaryKeyVersion

string

O identificador da versão primária atual da chave.

7ce1d081-06cb-42e6-aab6-5c5de030****

Description

string

A descrição da chave.

key description example

KeySpec

string

A especificação da chave.

Aliyun_AES_256

Origin

string

A origem do material da chave.

Aliyun_KMS

MaterialExpireTime

string

A hora de expiração do material da chave (UTC).
Se este valor estiver vazio, o material da chave não expira.

2025-03-25T10:00:00Z

AutomaticRotation

string

Indica se a rotação automática de chaves está ativada. Valores válidos:

  • Enabled: A rotação automática está com o status de ativação.

  • Disabled: A rotação automática está desativada.

  • Suspended: A rotação automática está pausada e não será executada.

Enabled

ProtectionLevel

string

O nível de proteção da chave.

SOFTWARE

KeyUsage

string

A finalidade da chave.

ENCRYPT/DECRYPT

CreationDate

string

A data e hora em que a chave foi criada (UTC).

2024-03-25T10:00:00Z

DKMSInstanceId

string

O ID da instância da instância do KMS.

kst-bjj62d8f5e0sgtx8h****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "381D5D33-BB8F-395F-8EE4-AE3BB4B523C4",
  "KeyMetadata": {
    "KeyId": "key-hzz62f1cb66fa42qo****",
    "NextRotationDate": "2024-03-25T10:00:00Z",
    "KeyState": "Enabled",
    "RotationInterval": "31536000s",
    "Arn": "acs:kms:cn-qingdao:154035569884****:key/key-hzz62f1cb66fa42qo****",
    "Creator": "154035569884****",
    "LastRotationDate": "2023-03-25T10:00:00Z",
    "DeleteDate": "2025-03-25T10:00:00Z",
    "PrimaryKeyVersion": "7ce1d081-06cb-42e6-aab6-5c5de030****",
    "Description": "key description example",
    "KeySpec": "Aliyun_AES_256",
    "Origin": "Aliyun_KMS",
    "MaterialExpireTime": "2025-03-25T10:00:00Z",
    "AutomaticRotation": "Enabled",
    "ProtectionLevel": "SOFTWARE",
    "KeyUsage": "ENCRYPT/DECRYPT",
    "CreationDate": "2024-03-25T10:00:00Z",
    "DKMSInstanceId": "kst-bjj62d8f5e0sgtx8h****"
  }
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 Rejected.LimitExceeded The request was rejected because user create resource limit was exceeded
400 InvalidParameter The specified parameter is not valid.
400 UnsupportedOperation This action is not supported.
400 Forbidden.NoPermission This operation is forbidden by permission system.
400 Rejected.ShareQuotaExceedLimit Instance Share Quota Exceed Limit.
500 InternalFailure Internal Failure
403 Forbidden.DKMSInstanceNotFound The specified DKMS Instance is not found.
503 SerivceUnvailableTemporary Service Unvailable Temporary

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.