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.
Atualizado em 2023-02-20 GMT+08:00

Consulta de recursos por tag

Função

Essa API é usada para consultar recursos como gateways virtuais e interfaces virtuais por tag.

URI

POST /v3/{project_id}/{resource_type}/resource-instances/action

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

Especifica o ID do projeto.

resource_type

Sim

String

Especifica o tipo de recurso da Direct Connect.

  • dc-directconnect: conexão
  • dc-vgw: gateway virtual
  • dc-vif: interface virtual

Valores de enumeração:

  • dc-directconnect
  • dc-vgw
  • dc-vif
  • dc-lag

Parâmetros de solicitação

Tabela 2 Parâmetros de corpo de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

offset

Não

String

Especifica a posição do índice. A consulta começa a partir do próximo registro de dados indexado por esse parâmetro. Não é necessário especificar esse parâmetro ao consultar recursos na primeira página. Ao consultar recursos em páginas subsequentes, defina esse parâmetro como o valor retornado no corpo da resposta da consulta anterior. Este parâmetro não está disponível quando action é definida como count. Se action estiver definida como filter, o valor deve ser um número e o valor padrão é 0. O valor não pode ser um número negativo.

limit

Não

String

Especifica o número de registros a serem consultadas. Este parâmetro não está disponível quando action é definida como count. Se action estiver definida como filter, o valor padrão é 1000. O valor máximo é 1000 e o valor mínimo é 1. O valor não pode ser um número negativo.

action

Sim

String

Especifica a operação a ser executada, que só pode ser filter (filtragem) ou count (consultando o número total). O filter indica consulta de paginação. O count indica que o número total de resultados de consulta que atendem aos critérios de pesquisa será retornado. Não é permitido devolver outros campos.

Valores de enumeração:

  • filter
  • count

matches

Não

Array of Match objects

Especifica os critérios de pesquisa. A key é o campo a ser correspondido, por exemplo, resource_name. O value indica o valor a ser correspondido. Este campo é um valor de dicionário fixo. Determine se a correspondência difusa é necessária com base em campos diferentes. Por exemplo, se a key for resource_name, a pesquisa difusa (sem distinção entre maiúsculas e minúsculas) será usada por padrão. Se o value for uma cadeia vazia, a correspondência exata será usada. Se key for resource_id, a correspondência exata será usada. Atualmente, somente resource_name é suportado.

not_tags

Não

Array of Tags objects

Especifica as tags que não estão incluídas. Cada tag contém um máximo de 10 chaves, e cada chave contém um máximo de 10 valores. O corpo da estrutura não pode estar ausente e a chave não pode ser deixada em branco ou definida como uma cadeia vazia. As chaves devem ser únicas e os valores de uma chave devem ser exclusivos. Os recursos não identificados por chaves diferentes estão no relacionamento AND e os valores em uma tag estão no relacionamento OR. Se nenhuma condição de filtragem for especificada, os dados completos serão retornados.

tags

Não

Array of Tags objects

Especifica as tags que estão incluídas. Cada tag contém um máximo de 10 chaves, e cada chave contém um máximo de 10 valores. O corpo da estrutura não pode estar ausente e a chave não pode ser deixada em branco ou definida como uma cadeia vazia. As chaves devem ser únicas e os valores de uma chave devem ser exclusivos. Os recursos identificados por chaves diferentes estão no relacionamento AND e os valores em uma tag estão no relacionamento OR. Se nenhum critério de filtragem de tag for especificado, dados completos serão retornados.

tags_any

Não

Array of Tags objects

Especifica qualquer tag incluída. Cada tag contém um máximo de 10 chaves, e cada chave contém um máximo de 10 valores. O corpo da estrutura não pode estar ausente e a chave não pode ser deixada em branco ou definida como uma cadeia vazia. As chaves devem ser únicas e os valores de uma chave devem ser exclusivos. Os recursos identificados por chaves diferentes estão no relacionamento OR e os valores em uma tag estão no relacionamento OR. Se nenhuma condição de filtragem for especificada, os dados completos serão retornados.

not_tags_any

Não

Array of Tags objects

Especifica qualquer tag que não esteja incluída. Cada tag contém um máximo de 10 chaves, e cada chave contém um máximo de 10 valores. O corpo da estrutura não pode estar ausente e a chave não pode ser deixada em branco ou definida como uma cadeia vazia. As chaves devem ser únicas e os valores de uma chave devem ser exclusivos. Os recursos não identificados por chaves diferentes estão no relacionamento OR e os valores em uma tag estão no relacionamento OR. Se nenhuma condição de filtragem for especificada, os dados completos serão retornados.

sys_tags

Não

Array of Tags objects

Somente usuários com a permissão op_service podem usar esse campo para filtrar recursos. Apenas uma estrutura de tags está contida quando essa API é chamada pelo Tag Management Service (TMS). O key é _sys_enterprise_project_id e value é a lista de IDs do projeto empresarial. Quando o TMS invoca essa API, uma chave pode ter apenas um valor. 0 indica o projeto corporativo padrão. O sys_tags e condições de filtragem de tags de locatário (without_any_tag, tags, tags_any, not_tags e not_tags_any) não podem ser usadas ao mesmo tempo.

Tabela 3 Correspondente

Parâmetro

Obrigatório

Tipo

Descrição

key

Sim

String

Especifica a chave de tag. O valor pode ser dc-directconnect, dc-vgw ou dc-vif.

value

Sim

String

Especifica o valor de tag. Cada valor pode conter um máximo de 255 caracteres Unicode.

Tabela 4 Tags

Parâmetro

Obrigatório

Tipo

Descrição

key

Sim

String

Especifica a chave de tag. Cada chave de tag pode conter no máximo 127 caracteres Unicode. A key deve ser especificada.

values

Sim

Array of strings

Especifica a lista de valores de tag. Cada valor pode conter um máximo de 255 caracteres Unicode.

Parâmetros de resposta

Código de status: 200

Tabela 5 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

resources

Array of Resource objects

Especifica a lista de recurso.

total_count

Integer

Especifica o número total de registros.

request_id

String

Especifica o ID da solicitação.

Tabela 6 Recurso

Parâmetro

Tipo

Descrição

resource_detail

Object

Especifica os detalhes do recurso.

resource_id

String

Especifica o ID do recurso.

resource_name

String

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

tags

Array of Tag objects

Especifica a lista de tags consultadas. Se nenhuma tag for correspondida, uma matriz vazia é retornada.

sys_tags

Array of Tag objects

Especifica a lista de tags consultadas. Se nenhuma tag for correspondida, uma matriz vazia é retornada.

Tabela 7 Tag

Parâmetro

Tipo

Descrição

key

String

Especifica a chave de tag. A chave pode conter no máximo 36 caracteres Unicode, incluindo letras, dígitos, hifens (-) e sublinhados (_).

Mínimo: 0

Máximo: 36

value

String

Especifica o valor de tag. O valor pode conter no máximo 43 caracteres Unicode, incluindo letras, dígitos, hifens (-) sublinhados (_) e pontos (.).

Mínimo: 0

Máximo: 43

Exemplos de solicitações

  • Corpo da solicitação quando a action é definida como filter
    https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource-instances/action
    
    {
      "offset" : "10",
      "limit" : "10",
      "action" : "filter",
      "matches" : [ {
        "key" : "resource_name",
        "value" : "resource1"
      } ],
      "not_tags" : [ {
        "key" : "key1",
        "values" : [ "*value1", "value2" ]
      } ],
      "tags" : [ {
        "key" : "key1",
        "values" : [ "*value1", "value2" ]
      } ],
      "tags_any" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ],
      "not_tags_any" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ]
    }
  • Corpo da solicitação quando a action está definida para count
    https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource_instances/action
    
    {
      "action" : "count",
      "not_tags" : [ {
        "key" : "key1",
        "values" : [ "value1", "*value2" ]
      } ],
      "tags" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      }, {
        "key" : "key2",
        "values" : [ "value1", "value2" ]
      } ],
      "tags_any" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ],
      "not_tags_any" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ],
      "sys_tags" : [ {
        "key" : "_sys_enterprise_project_id",
        "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ]
      } ],
      "matches" : [ {
        "key" : "resource_name",
        "value" : "resource1"
      } ]
    }

Exemplo de respostas

Código de status: 200

Operação bem-sucedida.

{
  "resources" : [ ],
  "total_count" : 0,
  "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535"
}

Códigos de status

Código de status

Descrição

200

Operação bem-sucedida.

Códigos de erro

Consulte Códigos de erro.