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/ Auto Scaling/ Referência de API/ APIs/ Tags/ Consulta de recursos por tag

Atualizado em 2023-07-04 GMT+08:00

Ver PDF

Consulta de recursos por tag

Função

Essa API é usada para consultar recursos em um projeto por tag.

Por padrão, recursos e tags de recurso estão em ordem decrescente de seu tempo de criação.

URI

POST /autoscaling-api/v1/{project_id}/{resource_type}/resource_instances/action

**Tabela 1** Descrição do parâmetro
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. Um valor de exemplo é scaling_group_tag.

Mensagem de solicitação

Parâmetros de solicitação

**Tabela 2** Parâmetros de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
tags	Não	Array of Tag objects	Especifica critérios de filtro com tags incluídas. Um máximo de 10 chaves pode ser contido. O corpo da estrutura deve estar completo. Para mais detalhes, consulte Tabela 3.
tags_any	Não	Array of Tag objects	Especifica critérios de filtro com qualquer tag incluída. Um máximo de 10 chaves pode ser contido. Para mais detalhes, consulte Tabela 3.
not_tags	Não	Array of Tag objects	Especifica critérios de filtro sem tags incluídas. Um máximo de 10 chaves pode ser contido. Para mais detalhes, consulte Tabela 3.
not_tags_any	Não	Array of Tag objects	Especifica critérios de filtro sem nenhuma tag incluída. Um máximo de 10 chaves pode ser contido. Para mais detalhes, consulte Tabela 3.
limit	Não	String	Especifica o número máximo de registros de consulta. O valor máximo é 1.000 e o valor mínimo é 1. Se action estiver definida para count, este parâmetro é inválido. Se action for definida como filter, o valor padrão é 1000.
marker	Não	String	Marca o local da paginação (posição do índice). É aconselhável usar o parâmetro offset para definir a posição do índice. Marca o local da paginação (ID do recurso ou local do índice).
action	Sim	String	Especifica a operação, que pode ser filter ou count. filter: indica que os recursos são filtrados por tag e os recursos que atendem aos critérios de pesquisa são retornados nas páginas. count: indica que os recursos são pesquisados por tag e o número de recursos que atendem aos critérios de pesquisa é retornado.
offset	Não	String	Especifica a posição do índice. A consulta começa na próxima imagem indexada 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 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.
matches	Não	Array of match objects	Especifica a pesquisa difusa. Para mais detalhes, consulte Tabela 4.

**Tabela 3** Descrição do campo **Tag**
Parâmetro	Obrigatório	Tipo	Descrição
key	Sim	String	Especifica a chave de tag. Contém um máximo de 127 caracteres Unicode. Não pode ser deixado em branco (Este parâmetro não é verificado no processo de pesquisa.) Um máximo de 10 chaves são permitidas e a chave não pode ser deixada em branco ou uma cadeia vazia. Cada chave deve ser única.
values	Sim	Array of strings	Especifica os valores da tag. Um valor contém no máximo 255 caracteres Unicode. Uma chave contém no máximo 10 valores. Cada valor da mesma chave deve ser único. O asterisco () é reservado para o sistema. Se o valor começar com , indica que a correspondência difusa é executada para os dígitos seguintes a . O valor não pode conter apenas asteriscos (). Se os valores forem nulos (não padrão), ele indicará any_value (consultar qualquer valor). 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	Obrigatório	Tipo	Descrição
key	Sim	String	Especifica a chave com base na qual os recursos serão consultados. O valor do parâmetro só pode ser resource_name.
value	Sim	String	Especifica o valor. O valor é um valor de dicionário fixo. Um valor contém no máximo 255 caracteres Unicode. Se o valor for uma cadeia vazia ou resource_id, a correspondência exata será usada.

Exemplo de solicitação

Solicitação de exemplo quando action é definida como filter

Este exemplo mostra como consultar grupos de AS de um locatário usando os seguintes critérios de pesquisa: incluindo tag (chave = key1 e valor = value), tag de exclusão (chave = key2 e valor = value2), posição do índice 100 e número máximo de registros 100.

POST https: //{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/resource_instances/action

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

Solicitação de exemplo quando action é definida para count

Este exemplo mostra como consultar o número de grupos de AS para um locatário usando os seguintes critérios de pesquisa: incluindo a tag (chave = key1 e valor = value) e excluindo a tag (chave = key2 e valor = value2).

POST https: //{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/resource_instances/action

{
	"action": "count",
	"not_tags": [{
		"key": "key2",
		"values": ["value2"]
	}],
	"tags": [{
		"key": "key1",
		"values": ["value1"]
	},
	{
		"key": "key2",
		"values": ["value1",
		"value2"]
	}],
	"matches": [{
		"key": "resource_name",
		"value": "resource1"
	}]
}

Mensagem de resposta

Parâmetros de resposta

**Tabela 5** Parâmetros de resposta
Parâmetro	Tipo	Descrição
resources	Array of Resource objects	Especifica recursos de tag. Para mais detalhes, consulte Tabela 6.
total_count	Integer	Especifica o número total de registros. Quando action é definida como count, somente este parâmetro é retornado. Os valores de resources e marker não são retornados.
marker	String	Especifica o identificador de local de paginação.

**Tabela 6** Descrição do campo **Resource**
Parâmetro	Tipo	Descrição
resource_id	String	Especifica o ID do recurso.
resource_detail	String	Especifica os detalhes do recurso.
tags	Array of ResourceTag objects	Especifica as tags. Se não houver tag, tags é tomada como uma matriz vazia por padrão. Para mais detalhes, consulte Tabela 7.
resource_name	String	Especifica o nome de recurso. Se não houver nenhum recurso, esse parâmetro é uma cadeia vazia por padrão.

**Tabela 7** Descrição do campo **ResourceTag**
Parâmetro	Tipo	Descrição
key	String	Especifica a chave de tag. Ele contém um máximo de 36 caracteres Unicode.
value	String	Especifica o valor de tag. Ele contém um máximo de 36 caracteres Unicode.

Exemplo de resposta

Resposta de exemplo quando action é definida como filter

{
	"resources": [{
		"resource_id": "64af4b6f-ec51-4436-8004-7a8f30080c87",
		"resource_detail": "SCALING_GROUP_TAG",
		"tags": [{
			"key": "key1","value": "value1"
		}],
		"resource_name": "as_scaling_group_1"
	},
	{
		"resource_id": "7122ef51-604b-40e7-b9b2-1de4cd78dc60",
		"resource_detail": "SCALING_GROUP_TAG",
		"tags": [{
			"key": "key1","value": "value1"
		}],
		"resource_name": "as_scaling_group_2"
	}],
	"marker": "2",
	"total_count": 2
}

Resposta de exemplo quando action é definida como count
```
{
       "total_count": 1000
}
```

Valores retornados

Normal
200

Anormal

Valores retornados	Descrição
400 Bad Request	O servidor falhou ao processar a solicitação.
401 Unauthorized	Você deve digitar o nome de usuário e a senha para acessar a página solicitada.
403 Forbidden	Você está proibido de acessar a página solicitada.
404 Not Found	O servidor não conseguiu encontrar a página solicitada.
405 Method Not Allowed	Você não tem permissão para usar o método especificado na solicitação.
406 Not Acceptable	A resposta gerada pelo servidor não poderia ser aceita pelo cliente.
407 Proxy Authentication Required	Você deve usar o servidor proxy para autenticação para que a solicitação possa ser processada.
408 Request Timeout	A solicitação expirou o tempo limite.
409 Conflict	A solicitação não pôde ser processada devido a um conflito.
500 Internal Server Error	Falhou ao concluir a solicitação porque ocorre um erro de serviço interno.
501 Not Implemented	Falhou ao concluir a solicitação porque o servidor não suporta a função solicitada.
502 Bad Gateway	Falhou ao concluir a solicitação porque a solicitação é inválida.
503 Service Unavailable	Falhou ao concluir a solicitação porque o sistema não está disponível.
504 Gateway Timeout	Ocorreu um erro de tempo limite de gateway.