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> VPC Endpoint> Referência de API> API> Tags> Consulta de recursos por tag

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

Ver PDF

Consulta de recursos por tag

Função

Função Essa API é usada para consultar recursos usando tags.

URI

POST /v1/{project_id}/{resource_type}/resource_instances/action

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatoriedade	Tipo	Descrição
project_id	Sim	String	ID do projeto.
resource_type	Sim	String	Especifica o tipo de recurso. O tipo é endpoint_service ou endpoint.

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	Especifica o token do usuário. Ele pode ser obtido chamando a API do IAM. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário.
Content-Type	Sim	String	Especifica o tipo MIME do corpo da solicitação. O valor padrão application/json é recomendado. Para as API usadas para carregar objetos ou imagens, o tipo MIME pode variar dependendo do tipo de fluxo.

**Tabela 3** Parâmetros de corpo de solicitação
Parâmetro	Obrigatoriedade	Tipo	Descrição
tags	Não	Array of TagValuesList objects	As tags estão incluídas. Um máximo de 10 chaves de tag são incluídas, e cada valor de tag pode ter um máximo de 10 valores. Cada valor da tag pode ser uma matriz vazia, mas a estrutura não pode estar faltando. As chaves de tag devem ser únicas. Os valores da mesma chave de tag devem ser exclusivos. Especifica todas as tags retornadas do recurso. As chaves estão na relação AND, enquanto os valores na estrutura chave-valor estão na relação OR. Se nenhuma condição de filtragem para tags for especificada, os dados completos serão retornados.
tags_any	Não	Array of TagValuesList objects	Quaisquer tags estão incluídas. Um máximo de 10 chaves de tag são incluídas, e cada chave de tag pode ter um máximo de 10 valores. Os valores de cada chave de tag podem ser uma matriz vazia, mas a estrutura de tags não pode estar faltando. Ambas as chaves de tag e os valores da mesma chave de tag devem ser exclusivos. Especifica recursos, incluindo tags retornadas. Chaves e valores na estrutura chave-valor estão na relação OR. Se nenhuma condição de filtragem for especificada, os dados completos serão retornados.
not_tags	Não	Array of TagValuesList objects	As tags são excluídas, um máximo de 10 chaves de tag são incluídas e cada valor de tag pode ter um máximo de 10 valores. Cada valor da tag pode ser uma matriz vazia, mas a estrutura não pode estar ausente. As chaves de tag devem ser únicas. Os valores da mesma chave de tag devem ser exclusivos. Especifica recursos incluindo tags retornadas. As chaves estão na relação AND, enquanto os valores na estrutura chave-valor estão na relação OR. Se nenhuma condição de filtragem for especificada, os dados completos serão retornados.
not_tags_any	Não	Array of TagValuesList objects	Quaisquer tags são excluídas, um máximo de 10 chaves de tag são incluídas e cada valor de tag pode ter um máximo de 10 valores. Cada valor da tag pode ser uma matriz vazia, mas a estrutura não pode estar faltando. As chaves de tag devem ser únicas. Os valores da mesma chave de tag devem ser exclusivos. Especifica recursos incluindo tags retornadas. As chaves estão na relação AND, enquanto os valores na estrutura chave-valor estão na relação OR. Se nenhuma condição de filtragem for especificada, os dados completos serão retornados.
sys_tags	Não	Array of TagValuesList objects	Especifica as tags do sistema.
limit	Não	String	Especifica o número de registros a serem consultadas. Este parâmetro não está disponível quando action está definida como count. Se action estiver definida como filter, o valor padrão será 1000. O valor máximo do limite é 1000 e o valor mínimo é 1.
offset	Não	String	Especifica a posição do índice e o deslocamento. A consulta começa a partir dos dados após o primeiro deslocamento de dados. Este parâmetro não está disponível quando action está definida como count. Se a ação for definida como filter, o valor padrão será 0, o que indica que a consulta começa a partir dos primeiros dados. O valor deve ser um número não negativo.
action	Sim	String	Especifica a ação, que só pode ser filter e count. Se esse parâmetro for definido como filter, a consulta será executada com base nos critérios de filtro. Se o parâmetro estiver definido para count, apenas o número total de recursos precisará ser retornado.
matches	Não	Array of Match objects	Especifica o campo de pesquisa. A chave da tag é o campo a ser correspondido, por exemplo, resource_name. O valor da tag indica o valor correspondente. A chave de tag é um valor de dicionário fixo e não pode ser uma chave duplicada ou uma chave não suportada. Especifica se a correspondência difusa é necessária com base no valor da chave de tag. Por exemplo, se a chave da tag for resource_name, a pesquisa difusa (não diferencia maiúsculas de minúsculas) será usada por padrão. Se value for uma cadeia vazia, a correspondência exata será usada. Uma lista vazia é retornada porque o resource_name para a maioria dos serviços não pode ser deixado em branco. Se a chave de tag for resources_id, a correspondência exata será usada. Somente resource_name para key é suportado. Outros valores de key estarão disponíveis posteriormente.
without_any_tag	Não	Boolean	O valor padrão é false. O valor pode ser true ou false. Quando withoutAnyTag estiver definido como true, ignore a verificação de parâmetros em tags, tagsAny, notTags e notTagsAny.

**Tabela 4** TagValuesList
Parâmetro	Obrigatoriedade	Tipo	Descrição
key	Sim	String	Especifica a chave de tag. Ele contém um máximo de 127 caracteres Unicode. Uma chave de tag não pode ser deixada em branco. (O conjunto de caracteres deste parâmetro não é verificado durante a pesquisa.) A chave da tag não pode ser deixada em branco, cadeias vazias ou espaços. Antes de verificar e usá-lo, exclua os espaços no início e no final da chave de tag. Mínimo: 1 Máximo: 36
values	Sim	Array of strings	Especifica os valores de tag. Cada valor de tag contém um máximo de 255 caracteres Unicode. Antes de verificar e usá-lo, exclua os espaços no início e no final do valor de tag. O valor de tag pode ser uma matriz vazia, mas não pode ser deixado em branco. Se values for deixado em branco, ele indicará any_value (consultar qualquer valor). Os valores estão na relação OR. O sistema não verifica o conjunto de caracteres de values ao pesquisar recursos, mas apenas verifica o comprimento.

**Tabela 5** Match
Parâmetro	Obrigatoriedade	Tipo	Descrição
key	Sim	String	Indica a chave da tag. Somente resource_name para key é suportado. Outros valores de key estarão disponíveis posteriormente. Mínimo: 1 Máximo: 36
value	Sim	String	Valor. Cada valor pode conter um máximo de 255 caracteres Unicode. O conjunto de caracteres de value não é verificado. Mínimo: 1 Máximo: 43

Parâmetros de resposta

Código de estado: 200

**Tabela 6** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
resources	Array of ResourceInstance objects	Detalhes da instância do recurso
total_count	Integer	Especifica o número total de registros de consulta. Mínimo: 1

**Tabela 7** ResourceInstance
Parâmetro	Tipo	Descrição
resource_id	String	Indica o ID do recurso, o ID do serviço do ponto de extremidade ou o ID do ponto de extremidade.
tags	Array of TagList objects	Indica a lista de tags.
resource_name	String	Nome do recurso. Se o recurso não tiver um nome, o ID é retornado.

**Tabela 8** TagList
Parâmetro	Tipo	Descrição
key	String	Especifica a chave de tag. Uma chave de tag contém um máximo de 36 caracteres Unicode. Não pode ser deixado em branco. Não pode conter sinais iguais (=), asteriscos (*), sinais menores (<), sinais maiores (>), barras invertidas (), vírgulas (,), barras verticais (\|) e barras (/), e o primeiro e último caracteres não podem ser espaços. Mínimo: 1 Máximo: 36
value	String	Especifica a chave de tag. Um valor de tag contém um máximo de 43 caracteres Unicode e pode ser uma cadeia vazia. Não pode conter sinais iguais (=), asteriscos (*), sinais menores (<), sinais maiores (>), barras invertidas (), vírgulas (,), barras verticais (\|) e barras (/), e o primeiro e último caracteres não podem ser espaços. Mínimo: 1 Máximo: 43

Código de estado: 400

**Tabela 9** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 10** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 401

**Tabela 11** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 12** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 403

**Tabela 13** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 14** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 404

**Tabela 15** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 16** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 405

**Tabela 17** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 18** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 406

**Tabela 19** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 20** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 407

**Tabela 21** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 22** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 408

**Tabela 23** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 24** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 409

**Tabela 25** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 26** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 500

**Tabela 27** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 28** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 501

**Tabela 29** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 30** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 502

**Tabela 31** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 32** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 503

**Tabela 33** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 34** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 504

**Tabela 35** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 36** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Exemplo de solicitações

POST https://{endpoint}/v1/{project_id}/endpoint/resource_instances/action

When action is set to filter:    "offset": "100",
    "limit": "100",
    "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"
            ]
        }
    ]
}

https://{endpoint}/v1/{project_id}/endpoint_service/ resource_instances/action

When action is set to count:
{
    "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"
            ]
        }
    ],
    "matches": [
        {
            "key": "resource_name",
            "value": "resource1"
        }
    ]
}

Exemplo de respostas

Código de estado: 200

O servidor processou a solicitação com sucesso.

- When action is set to filter:
{
"resources": [
{
"resource_detail": null,
"resource_id": "cdfs_cefs_wesas_12_dsad",
"resource_name": "resource1",
"tags": [
{
"key": "key1","value": "value1"
},
{
"key": "key2","value": "value1"
}
]
}
],
"total_count": 1000
}
- When action is set to be count:
{
"total_count": 1000
}

Códigos de estado

Código de estado	Descrição
200	O servidor processou a solicitação com sucesso.
400	A solicitação não pôde ser entendida pelo servidor devido à sintaxe mal formada.
401	A página solicitada requer um nome de usuário e senha.
403	O servidor entendeu o pedido, mas está se recusando a cumpri-lo.
404	A página solicitada não foi encontrada.
405	O método especificado na linha de solicitação não é permitido para o recurso identificado pelo URI da solicitação.
406	O recurso identificado pela solicitação só é capaz de gerar entidades de resposta que tenham características de conteúdo não aceitáveis de acordo com os cabeçalhos de aceitação enviados na solicitação.
407	O cliente deve primeiro autenticar-se com o proxy.
408	O cliente não produziu uma solicitação dentro do tempo que o servidor estava preparado para esperar.
409	A solicitação não pôde ser concluída devido a um conflito com o estado atual do recurso.
500	Falhou ao concluir a solicitação. Anormalidade de serviço.
501	Falhou ao concluir a solicitação. O servidor não suporta a função solicitada.
502	Falhou ao concluir a solicitação. porque o servidor recebe uma resposta inválida.
503	Falhou ao concluir a solicitação. porque o sistema não está disponível.
504	Gateway expirou o tempo limite