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/ Gerenciamento de tags/ Consulta de instâncias de CMK
Atualizado em 2023-02-28 GMT+08:00
Ver PDF
Compartilhar

Consulta de instâncias de CMK

Função

Essa API permite consultar instâncias de CMK. Você pode usar a função de filtragem de tags para consultar as informações detalhadas sobre uma CMK especificada.

URI

POST /v1.0/{project_id}/kms/resource_instances/action

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

limit

Não

String

Número de registros em uma consulta. Se a ação for contar, você não precisa definir esse parâmetro. Se a ação for filtro, o valor padrão desse parâmetro será 10. O valor do limite está nos intervalos de 1 a 1.000.

offset

Não

String

Localização do índice. A consulta começa a partir do próximo recurso do local especificado. Quando os dados em uma página são consultados, o valor no corpo da resposta da página anterior é transferido para esse parâmetro. (Se a ação for contar, você não precisa definir esse parâmetro.) Se o valor da ação for filtro, o valor padrão será 0. O valor de offset deve ser um número e não pode ser negativo.

action

Não

String

Tipo de operação. Pode ser:

  • filtro: registro do filtro.
  • contagem: conta o número total de registros.

tags

Não

Array of Tag objects

Lista de tags, que é uma coleção de pares de chave-valor.

  • chave: chave da tag. Uma CMK pode ter no máximo 10 chaves, e cada uma delas é exclusiva e não pode estar vazia. Uma chave não pode ter valores duplicados. É composta por até 36 caracteres.
  • valor: valor da tag. Cada valor de tag pode conter no máximo 43 caracteres. Os valores estão na relação AND.

matches

Não

Array of TagItem objects

Campo a ser correspondido.

  • chave: o campo a ser correspondido, por exemplo, resource_name.
  • valor: o valor a ser correspondido. Contém um máximo de 255 caracteres e não pode estar vazio.

sequence

Não

String

Número de sequência de 36-byte de uma mensagem de solicitação. Exemplo: 919c82d4-8046-4722-9094-35c3c6524cff
Tabela 4 Tag

Parâmetro

Obrigatoriedade

Tipo

Descrição

key

Não

String

Chave. Uma chave de tag contém um máximo de 36 caracteres Unicode. Não pode ser deixado em branco. Ele não pode conter caracteres ASCII (0–31), asteriscos (*), colchetes angulares (< e >), barras invertidas () e sinais de igual (=).

values

Não

Array of strings

Conjunto de valores de tag.
Tabela 5 TagItem

Parâmetro

Obrigatoriedade

Tipo

Descrição

key

Não

String

Chave. Uma chave de tag contém um máximo de 36 caracteres Unicode. Não pode ser deixado em branco. Ele não pode conter caracteres ASCII (0–31), asteriscos (*), colchetes angulares (< e >), barras invertidas () e sinais de igual (=).

value

Não

String

Valor. Um valor de marca pode conter um máximo de 43 caracteres Unicode e pode ser uma cadeia de caracteres vazia. Ele não pode conter caracteres ASCII (0–31), asteriscos (*), colchetes angulares (< e >), barras invertidas () e sinais de igual (=).

Parâmetros de resposta

Código de status: 200

Tabela 6 Parâmetros de corpo da resposta

Parâmetro

Tipo

Descrição

resources

Array of ActionResources objects

Lista de recursos.

total_count

Integer

Número total de registros.
Tabela 7 ActionResources

Parâmetro

Tipo

Descrição

resource_id

String

ID do recurso.

resource_detail

KeyDetails object

Principais detalhes.

resource_name

String

Especifica o nome de recurso. Este parâmetro é uma cadeia vazia por padrão.

tags

Array of TagItem objects

Lista de tag. Se não houver nenhuma tag na lista, uma matriz vazia é retornada.
Tabela 8 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.
Tabela 9 TagItem

Parâmetro

Tipo

Descrição

key

String

Chave. Uma chave de tag contém um máximo de 36 caracteres Unicode. Não pode ser deixado em branco. Ele não pode conter caracteres ASCII (0–31), asteriscos (*), colchetes angulares (< e >), barras invertidas () e sinais de igual (=).

value

String

Valor. Um valor de marca pode conter um máximo de 43 caracteres Unicode e pode ser uma cadeia de caracteres vazia. Ele não pode conter caracteres ASCII (0–31), asteriscos (*), colchetes angulares (< e >), barras invertidas () e sinais de igual (=).

Código de status: 400

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.

Código de status: 403

Tabela 12 Parâmetros de corpo da resposta

Parâmetro

Tipo

Descrição

error

Object

Mensagem de erro.
Tabela 13 ErrorDetail

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Informação de erro.

Exemplo de solicitações

{
  "offset" : "100",
  "limit" : "100",
  "action" : "filter",
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ],
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  } ]
}

Exemplo de respostas

Código de status: 200

Processamento da solicitação bem-sucedido.

{
  "resources" : [ {
    "resource_id" : "90c03e67-5534-4ed0-acfa-89780e47a535",
    "resource_detail" : [ {
      "key_id" : "90c03e67-5534-4ed0-acfa-89780e47a535",
      "domain_id" : "4B688Fb77412Aee5570E7ecdbeB5afdc",
      "key_alias" : "tagTest_xmdmi",
      "key_description" : "123",
      "creation_date" : 1521449277000,
      "scheduled_deletion_date" : "",
      "key_state" : 2,
      "default_key_flag" : 0,
      "key_type" : 1,
      "key_rotation_enabled" : false,
      "expiration_time" : "",
      "origin" : "kms",
      "sys_enterprise_project_id" : "0",
      "realm" : "test"
    } ],
    "resource_name" : "tagTest_xmdmi",
    "tags" : [ {
      "key" : "key",
      "value" : "testValue!"
    }, {
      "key" : "haha",
      "value" : "testValue"
    } ]
  } ],
  "total_count" : 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ó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.

Códigos de erro

Consulte Códigos de erro.

Tópico principal: Gerenciamento de tags