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/ Image Management Service/ Referência de API/ As API do IMS/ Marcação de imagem/ Consulta de imagens por tag

Atualizado em 2022-11-16 GMT+08:00

Ver PDF

Consulta de imagens por tag

Função

Esta API é usada para filtrar ou contar imagens usando tags ou outras condições.

Restrições

Para ser compatível com as tags restantes, o sistema não verificará o conjunto de caracteres das chaves e valores das tags na condição de consulta quando os parâmetros tags not_tags, tags_any, e not_tags_any forem usados.

URI

POST /v2/{project_id}/images/resource_instances/action

Tabela 1 lista os parâmetros no URI.

**Tabela 1** Descrição do parâmetro
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	Cadeia	Especifica o ID do projeto.

Solicitação

Parâmetros de solicitação

Parâmetro	Obrigatório	Tipo	Descrição
Ação	Sim	Cadeia	Identifica a operação. Este parâmetro é sensível a maiúsculas e minúsculas e seu valor pode ser filter ou count. O valor filter indica a consulta de paginação. O valor count indica que o número total de resultados de consulta que atendem aos critérios de pesquisa será retornado.
Tags	Não	Matriz de objetos	Inclui todas as tags especificadas. Um máximo de 10 chaves de tag são permitidas para cada operação de consulta. Cada chave de tag pode conter um máximo de 10 valores de tag. Tanto as chaves de tag quanto os valores devem ser exclusivos. As teclas de tag não podem ser deixadas em branco. Para mais detalhes, consulte Tabela 2.
tags_any	Não	Matriz de objetos	Inclui qualquer uma das tags especificadas. Um máximo de 10 chaves de tag são permitidas para cada operação de consulta. Cada chave de tag pode conter um máximo de 10 valores de tag. Tanto as chaves de tag quanto os valores devem ser exclusivos. As chaves de tag não podem ser deixadas em branco e definidas como uma string vazia. Para mais detalhes, consulte Tabela 3.
not_tags	Não	Matriz de objetos	Exclui todas as tags especificadas. Um máximo de 10 chaves de tag são permitidas para cada operação de consulta. Cada chave de tag pode conter um máximo de 10 valores de tag. Tanto as chaves de tag quanto os valores devem ser exclusivos. As teclas de tag não podem ser deixadas em branco. Para mais detalhes, consulte Tabela 4.
not_tags_any	No	Matriz de objetos	Exclui qualquer uma das tags especificadas. Um máximo de 10 chaves de tag são permitidas para cada operação de consulta. Cada chave de tag pode conter um máximo de 10 valores de tag. Tanto as chaves de tag quanto os valores devem ser exclusivos. As teclas de tag não podem ser deixadas em branco. Para mais detalhes, consulte Tabela 5.
without_any_tag	Não	Booleano	Se esse parâmetro for definido como true, todos os recursos sem tags serão consultados. Nesse caso, os campos tag, not_tags, tags_any, e not_tags_any são ignorados.
Limite	Não	Cadeia	Especifica o número máximo de registros de consulta. Este parâmetro é inválido quando action é definida para count. Se action for definida como filter, o parâmetro limit entra em vigor e seu valor padrão é 10. O valor do limit varia de 1 a 1000.
Deslocamento	Não	Cadeia	Especifica a posição do índice. A consulta começa a partir da próxima imagem indexada por esse parâmetro. Esse parâmetro não é necessário quando os dados na primeira página são consultados e é inválido quando action é definida como count. Se action for definida como filter, o valor padrão de offset é 0. O valor de offset não pode ser um número negativo.
matches	Não	Matriz de objetos	Especifica os critérios de pesquisa. A chave da tag é o campo a ser correspondido, por exemplo, resource_name ou resource_id. value indica o valor correspondido. As chaves nesta lista devem ser exclusivas. O parâmetro não pode ser deixado em branco e não pode ser transferido. Para mais detalhes, consulte Tabela 6.

**Tabela 2** Descrição da estrutura de dados do campo tags
Parâmetro	Obrigatório	Tipo	Descrição
chave	Sim	Cadeia	Especifica a chave de tag. A chave de etiqueta contém um máximo de 127 caracteres Unicode e não pode ser deixada em branco.
values	Sim	Matriz de strings	Lista os valores da tag. Cada valor pode conter um máximo de 255 caracteres Unicode. Se este parâmetro for deixado em branco, qualquer valor será correspondido. Se vários valores forem listados, as imagens que tiverem qualquer um dos valores serão retornadas.

**Tabela 3** Descrição da estrutura de dados do campo tags_any
Parâmetro	Obrigatório	Tipo	Descrição
chave	Sim	Cadeia	Especifica a chave de tag. A chave de etiqueta contém um máximo de 127 caracteres Unicode e não pode ser deixada em branco.
values	Sim	Matriz de strings	Lista os valores da tag. Cada valor pode conter um máximo de 255 caracteres Unicode. Se este parâmetro for deixado em branco, qualquer valor será correspondido. Se vários valores forem listados, as imagens que tiverem qualquer um dos valores serão retornadas.

**Tabela 4** Descrição da estrutura de dados do campo not_tags
Parâmetro	Obrigatório	Tipo	Descrição
chave	Sim	Cadeia	Especifica a chave de tag. A chave de etiqueta contém um máximo de 127 caracteres Unicode e não pode ser deixada em branco.
values	SIM	Matriz de strings	Lista os valores da tag. Cada valor pode conter um máximo de 255 caracteres Unicode. Se este parâmetro for deixado em branco, qualquer valor será correspondido. Se vários valores forem listados, as imagens que tiverem qualquer um dos valores serão retornadas.

**Tabela 5** Descrição da estrutura de dados do campo not_tags_any
Parâmetro	Obrigatório	Tipo	Descrição
chave	Sim	Cadeia	Especifica a chave de tag. A chave de etiqueta contém um máximo de 127 caracteres Unicode e não pode ser deixada em branco.
values	Sim	Matriz de strings	Lista os valores da tag. Cada valor pode conter um máximo de 255 caracteres Unicode. Se este parâmetro for deixado em branco, qualquer valor será correspondido. Quando vários valores são especificados e os requisitos-chave são atendidos, as imagens que têm qualquer um dos valores especificados são consultadas.

**Tabela 6** Descrição da estrutura de dados do campo de correspondências
Parâmetro	Obrigatório	Tipo	Descrição
chave	Sim	Cadeia	Especifica a chave da tag, ou seja, o nome do campo para a operação de consulta. Os valores válidos resource_name e resource_id. Se o nome do campo for resource_name e o valor for uma cadeia de caracteres vazia, a consulta exata será executada. Caso contrário, a consulta fuzzy é executada com base no nome da imagem. Se o nome do campo for resource_id, a consulta exata será executada com base no ID da imagem.
Valor	Sim	Cadeia	Especifica o valor da tag. Não pode ser deixado em branco. Cada valor pode conter um máximo de 255 caracteres Unicode.

Exemplo de solicitações

POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/resource_instances/action

Corpo da solicitação quando action estiver definida como count

        
         
           
           
             {
   "action": "count",
   "matches": [{
      "key": "resource_name",
      "value": "test100"
   }],
   "tags": [
   {
      "key": "key3",
      "values": ["valueXX"]
   }],
   "tags_any": [
   {
      "key": "key0",
      "values": ["valueXX"]
   }],
      "not_tags": [
   {
      "key": "key9",
      "values": ["value9"]
   }],
   "not_tags_any": [{
      "key": "key7",
      "values": ["value7"]
   }]
}

            

          

        
       

Corpo da solicitação quando action é definida como filter

        
         
           
           
             {
   "action": "filter",
   "limit": "1",
   "offset": "0",
   "matches": [{
      "key": "resource_name",
      "value": "test100"
   }],
   "tags": [
   {
      "key": "key3",
      "values": ["valueXX"]
   }],
   "tags_any": [
   {
      "key": "key0",
      "values": ["valueXX"]
   }],
   "not_tags": [
   {
      "key": "key9",
      "values": ["value9"]
   }],
   "not_tags_any": [{
      "key": "key7",
      "values": ["value7"]
   }]
}

            

          

        
       

Resposta

Parâmetros de resposta

Parâmetro	Tipo	Descrição
Recursos	Array of resource objects	Lista as imagens.
total_count	número inteiro	Especifica o número total de registros de consulta.

**Tabela 7** Descrição da estrutura de dados do campo de recurso
Parâmetro	Tipo	Descrição
resource_id	Cadeia	Especifica o ID da imagem.
resource_detail	ResourceDetail object	Fornece detalhes da imagem.
Tags	Array of Tags objects	Lista as tags de imagem.
resource_name	Cadeia	Especifica o nome de imagem.

**Tabela 8** objeto ResourceDetail
Parâmetro	Tipo	Obrigatório	Descrição
estado	Cadeia	Sim	Especifica a tag de imagem.

**Tabela 9** Descrição da estrutura de dados do campo Resource_tag
Parâmetro	Tipo	Descrição
chave	Cadeia	Especifica a chave da tag.
Valor	Cadeia	Especifica o valor da tag.

Exemplo de resposta

Exemplo de resposta quando action é definida como count

CÓDIGO DE STATUS 200

        
             {
   "total_count": 36
}

Exemplo de resposta quando action é definida como filter

CÓDIGO DE STATUS 200

        
         
           
           
             {
   "total_count": 36,
   "resources": [{
      "resource_name": "test10002",
      "resource_detail": {"status": "active"},
      "tags": [{
         "value": "value4",
         "key": "key4"
      },
      {
         "value": "valueXX",
         "key": "key3"
      },
      {
         "value": "value2",
         "key": "key2"
      },
      {
         "value": "value5",
         "key": "key5"
      },
      {
         "value": "value8",
         "key": "key8"
      },
      {
         "value": "valueXX",
         "key": "key6"
      },
      {
         "value": "valueXX",
         "key": "key0"
      },
      {
         "value": "value1",
         "key": "key1"
      },
      {
         "value": "value7",
         "key": "key7"
      },
      {
         "value": "valueXX",
         "key": "key9"
      }],
      "resource_id": "8693187d-1590-4f9f-ae34-eb9e3037cf68"
   }]
}

            

          

        
       

Valor retornado

Normal
200

Anormal

Valor retornado	Descrição
400 Solicitação inválida	Erro na solicitação.
401 Não autorizado	Autenticação falhou.
403 Proibido	Você não tem os direitos para realizar a operação.
404 Não encontrado	O recurso solicitado não foi encontrado.
500 Erro de servidor interno	Erro do serviço interno.
503 Serviço indisponível	Serviço não está disponível.