Cria uma chave mestra.
Descrição da operação
-
Para obter detalhes sobre a política de acesso necessária para que usuários do Resource Access Management (RAM) ou funções do RAM chamem esta operação de API, consulte Controle de acesso.
-
O Alibaba Cloud KMS suporta especificações de chaves simétricas e assimétricas comuns. Para obter mais informações, consulte Tipos de gerenciamento de chaves e especificações de chaves.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
kms:CreateKey |
create |
*Todos os recursos.
|
|
Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| Description |
string |
Não |
A descrição da chave. |
key description example |
| KeyUsage |
string |
Não |
A finalidade da chave. Valores válidos:
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:
Nota
|
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:
Nota
|
SOFTWARE |
| EnableAutomaticRotation |
boolean |
Não |
Especifica se a rotação automática de chaves deve ser ativada. Valores válidos:
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.
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: 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:
A política de chave usa o seguinte formato:
Detalhes da instrução:
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 |
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. |
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). |
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). |
2025-03-25T10:00:00Z |
| AutomaticRotation |
string |
Indica se a rotação automática de chaves está ativada. Valores válidos:
|
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.