Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda> Data Encryption Workshop> Referência de API> APIs> APIs de gerenciamento de chaves> Consulta de APIs> Consulta das informações sobre uma CMK

Atualizado em 2023-02-28 GMT+08:00

Ver PDF

Consulta das informações sobre uma CMK

Função

Essa API permite que você consulte os detalhes sobre uma CMK.

URI

POST /v1.0/{project_id}/kms/describe-key

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatoriedade	Tipo	Descrição
project_id	Sim	String	ID do projeto.

Parâmetros de solicitação

**Tabela 2** Parâmetros de cabeçalho de solicitação
Parâmetro	Obrigatoriedade	Tipo	Descrição
X-Auth-Token	Sim	String	Token do usuário. O token pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho de resposta).

**Tabela 3** Parâmetros de corpo de solicitação
Parâmetro	Obrigatoriedade	Tipo	Descrição
key_id	Sim	String	ID de CMK. Deve ter 36 bytes e corresponder à expressão regular ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Exemplo: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
sequence	Não	String	Número de sequência de 36-byte de uma mensagem de solicitação. Exemplo: 919c82d4-8046-4722-9094-35c3c6524cff

Parâmetros de resposta

Código de status: 200

**Tabela 4** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
key_info	KeyDetails object	Principais detalhes.

**Tabela 5** KeyDetails
Parâmetro	Tipo	Descrição
key_id	String	ID de CMK.
domain_id	String	ID de domínio do usuário.
key_alias	String	Alias de chave.
realm	String	Realm da chave.
key_spec	String	Tipo de algoritmo da CMK. AES_256 RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384
key_usage	String	Uso de CMK. ENCRYPT_DECRYPT SIGN_VERIFY
key_description	String	Descrição da chave.
creation_date	String	Hora em que a chave foi criada. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970).
scheduled_deletion_date	String	Hora em que a chave foi agendada para ser excluída. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970).
key_state	String	Estado da chave, que corresponde à expressão regular ^[1-5]{1}$. Pode ser: 1: a ser ativado 2: ativado 3: desativado 4: exclusão pendente 5: importação pendente
default_key_flag	String	Identificador da chave principal. O valor é 1 para chaves principais padrão e 0 para chaves principais não padrão.
key_type	String	Tipo de chave.
expiration_time	String	Hora em que o material de chave expira. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970).
origin	String	Fonte de chave. Pode ser: kms: o material de chave foi gerado pelo KMS. externa: o material da chave foi importado.
key_rotation_enabled	String	Status de rotação da chave. O valor padrão é false, indicando que a rotação da chave está desativada.
sys_enterprise_project_id	String	ID do projeto empresarial. Seu valor padrão é 0. Para usuários que ativaram a função de projeto empresarial, esse valor indica que os recursos estão no projeto empresarial padrão. Para os usuários que não ativaram a função de projeto empresarial, esse valor indica que os recursos não estão no projeto empresarial padrão.

Código de status: 400

**Tabela 6** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Object	Mensagem de erro.

**Tabela 7** ErrorDetail
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Informação de erro.

Código de status: 403

**Tabela 8** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Object	Mensagem de erro.

**Tabela 9** ErrorDetail
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Informação de erro.

Código de status: 404

**Tabela 10** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Object	Mensagem de erro.

**Tabela 11** ErrorDetail
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Informação de erro.

Exemplo de solicitações

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
}

Exemplo de respostas

Código de status: 200

Processamento da solicitação bem-sucedido.

{
  "key_info" : {
    "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
    "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd",
    "key_alias" : "test",
    "realm" : "test",
    "key_description" : "key_description",
    "creation_date" : "1502799822000",
    "scheduled_deletion_date" : "",
    "key_spec" : "AES_256",
    "key_usage" : "ENCRYPT_DECRYPT",
    "key_state" : "2",
    "default_key_flag" : "0",
    "key_type" : "1",
    "expiration_time" : "1501578672000",
    "origin" : "kms",
    "key_rotation_enabled" : "false",
    "sys_enterprise_project_id" : "0",
    "partition_type" : "1"
  }
}

Código de status: 400

Parâmetros de solicitação inválidos.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Código de status: 403

Autenticação falhou.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Código de status: 404

O recurso solicitado não existe ou não foi encontrado.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Códigos de status

Código de status	Descrição
200	Processamento da solicitação bem-sucedido.
400	Parâmetros de solicitação inválidos.
403	Autenticação falhou.
404	O recurso solicitado não existe ou não foi encontrado.