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/ Dedicated Host/ Referência de API/ API/ Gerenciamento de tags do DeH/ Consulta de DeHs por tag
Atualizado em 2024-01-26 GMT+08:00
Ver PDF
Compartilhar

Consulta de DeHs por tag

Função

  • Esta API é usada para filtrar DeHs por tag e retornar a lista de todas as tags de um DeH.
  • Tag Management Service (TMS) usa essa API para filtrar os DeHs.

URI

POST /v1.0/{project_id}/dedicated-host-tags/resource_instances/action

Tabela 1 descreve os parâmetros.

Tabela 1 Descrição dos parâmetros

Parâmetro

Tipo

Obrigatório

Descrição

project_id

String

Sim

Especifica o ID do projeto.

Solicitação

Tabela 2 Parâmetros de solicitação

Parâmetro

Tipo

Obrigatório

Descrição

tags

Array of objects

Não

Exibe todos os DeHs com tags especificadas. Para obter mais informações, consulte Tabela 3.

  • Um máximo de 10 chaves podem ser incluídas. Cada chave pode ter um máximo de 10 valores.
  • O corpo da estrutura deve ser incluído.
  • A chave de tag não pode ser deixada em branco ou definida como uma cadeia vazia.
  • Uma chave deve ser única.
  • Os valores da mesma chave devem ser exclusivos.

not_tags

Array of objects

Não

Exibe os DeHs sem nenhuma das tags especificadas. Para obter mais informações, consulte Tabela 3.

  • Um máximo de 10 chaves podem ser incluídas. Cada chave pode ter um máximo de 10 valores.
  • O corpo da estrutura deve ser incluído.
  • A chave de tag não pode ser deixada em branco ou definida como uma cadeia vazia.
  • As chaves devem ser únicas.
  • Os valores da mesma chave devem ser exclusivos.

limit

Integer

Não

Limita o número máximo dos DeHs consultados. O valor não pode ser um número negativo. O valor máximo é 1000.

  • Se o valor de action for count, esse parâmetro será inválido.
  • Se o valor de action for filter, o valor padrão será 1000.

offset

Integer

Não

Especifica a posição do índice. A consulta começa a partir da próxima parte dos dados indexados por este parâmetro. O valor deve ser um número não negativo.

Você não precisa especificar esse parâmetro ao consultar recursos na primeira página. Ao consultar recursos nas páginas subsequentes, defina valor de offset para o local retornado no corpo da resposta da consulta anterior.

  • Se o valor da action for count, esse parâmetro será inválido.
  • Se o valor da action for filter, o valor padrão será 0.

action

String

Sim

Especifica a operação, que pode ser filter ou count.

  • filter: filtra os DeHs por tag e lista os DeHs que atendem aos critérios de pesquisa. Os DeHs listados são consultados por página.
  • count: pesquisa DeHs por tag e retorna o número de DeHs que atendem aos critérios de pesquisa.

tags_any

Array of objects

Não

Inclui qualquer uma das tags especificadas. Para obter mais informações, consulte Tabela 3.

  • Este campo contém um máximo de 10 chaves de tag e cada chave de tag tem um máximo de 10 valores de tag. O valor da tag correspondente a cada chave da tag pode ser uma matriz vazia, mas a estrutura não pode estar faltando.
  • Cada chave deve ser exclusiva e não pode conter valores duplicados.
  • A resposta retorna recursos que contêm as tags nesta lista. As chaves nesta lista estão em uma relação OR e os valores em cada estrutura chave-valor também estão em uma relação OR.
  • Se nenhuma condição de filtragem de tag for especificada, os dados completos serão retornados.

not_tags_any

Array of objects

Não

Exclui qualquer uma das tags especificadas. Para obter mais informações, consulte Tabela 3.

  • Este campo contém um máximo de 10 chaves de tag e cada chave de tag tem um máximo de 10 valores de tag. O valor da tag correspondente a cada chave da tag pode ser uma matriz vazia, mas a estrutura não pode estar faltando.
  • Cada chave deve ser exclusiva e não pode conter valores duplicados.
  • A resposta retorna recursos que não contêm tags nesta lista. As chaves nesta lista estão em uma relação OR e os valores em cada estrutura chave-valor também estão em uma relação OR.
  • Se nenhuma condição de filtragem de tag for especificada, os dados completos serão retornados.

matches

Array of objects

Não

Especifica o campo de pesquisa, que é usado para pesquisar DeHs por condição.

Atualmente, somente resource_name pode ser usado para pesquisa. Para obter mais informações, consulte Tabela 4.
Tabela 3 Descrição do campo tag

Parâmetro

Tipo

Obrigatório

Descrição

key

String

Sim

Especifica a chave da tag.

  • Contém um máximo de 127 caracteres Unicode.
  • Este campo não pode ser deixado em branco.

values

Array of strings

Não

Especifica os valores de tag.

  • Cada tag contém um máximo de 10 valores.
  • Os valores da mesma tag devem ser exclusivos.
  • Cada valor pode conter um máximo de 255 caracteres Unicode.
  • Se este parâmetro não for especificado, qualquer valor pode ser usado.
  • Os recursos que contêm um ou vários valores listados em values serão encontrados e exibidos.
Tabela 4 Descrição do campo match

Parâmetro

Tipo

Obrigatório

Descrição

key

String

Sim

Especifica o parâmetro-chave a ser correspondido.

  • A chave deve ser exclusiva e o valor é usado para correspondência.
  • O campo key é um valor de dicionário fixo.
  • Este campo não pode ser deixado em branco.
NOTA:

O valor do parâmetro só pode ser resource_name, que é o nome do DeH.

value

String

Sim

Especifica o valor da tag.

  • Cada valor pode conter um máximo de 255 caracteres Unicode.
  • Este campo não pode ser deixado em branco.

Resposta

Tabela 5 Parâmetros de resposta

Parâmetro

Tipo

Descrição

resources

Array of objects

Especifica a lista de DeH retornada. Para mais detalhes, consulte Tabela 6.

total_count

Integer

Especifica o número total de recursos.
Tabela 6 Descrição do campo resource

Parâmetro

Tipo

Descrição

resource_id

String

Especifica o ID do DeH.

resouce_detail

String

Especifica os detalhes do DeH.

Este campo é usado para extensão futura e é deixado vazio por padrão.

tags

Array of objects

Especifica a lista de tags.

Para mais detalhes, consulte Tabela 7.

resource_name

String

Especifica o nome de recurso.
Tabela 7 Descrição do campo tag

Parâmetro

Tipo

Descrição

key

String

Especifica a chave da tag.

  • Contém um máximo de 36 caracteres Unicode.
  • Este campo não pode ser deixado em branco.
  • Não pode conter os seguintes caracteres ASCII: =*<>\|/,

value

String

Especifica o valor da tag.

  • Cada valor contém um máximo de 43 caracteres Unicode.
  • Este campo pode ser deixado em branco.
  • Não pode conter os seguintes caracteres ASCII: =*<>\|/,

Exemplo de solicitação

Filtre DeHs por tag. A partir do primeiro registo de dados, consulte o DeH utilizando o campo de pesquisa (campo: resource_name; valor: resource1) e a marca (chave: key1; valor: value1). 
POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/resource_instances/action 
{ 
    "offset": "0",
    "limit": "100",
    "action": "filter",
    "matches": [
        {
            "key": "resource_name",
            "value": "resource1"
        }
    ],
    "tags": [
        {
            "key": "key1",
            "values": ["value1"]
        }
    ]
}

Exemplo de resposta

Corpo da resposta quando action está definida como filter

{
    "resources": [
        {
            "resource_detail": null,
            "resource_id": "cdfs_cefs_wesas_12_dsad",
            "resource_name": "resource1",
            "tags": [
                {
                    "key": "key1",
                    "value": "value1"
                }
            ]
        }
    ],
    "total_count": 1
}

Corpo da resposta quando action está definida como count

{
    "total_count": 100
}

Código de status

Consulte Códigos de status.

Tópico principal: Gerenciamento de tags do DeH