Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Auto Scaling/ Referencia de la API/ Las API/ Etiquetas/ Consulta de recursos por etiqueta

Actualización más reciente 2022-11-08 GMT+08:00

Ver PDF

Consulta de recursos por etiqueta

Función

Esta API se utiliza para consultar recursos en un proyecto por etiqueta.

De forma predeterminada, los recursos y las etiquetas de recursos están en orden descendente de su tiempo de creación.

URI

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

**Tabla 1** Descripción del parámetro
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	Especifica el ID del proyecto.
resource_type	Sí	String	Especifica el tipo de recurso. Un valor de ejemplo es Scale_group_tag.

Mensaje de solicitud

Parámetros de solicitud

**Tabla 2** Parámetros de solicitud
Parámetro	Obligatorio	Tipo	Descripción
tags	No	Array of Tag objects	Especifica los criterios de filtro con las etiquetas incluidas. Se puede contener un máximo de 10 teclas. El cuerpo de la estructura debe estar completo. Para más detalles, consulte Tabla 3.
tags_any	No	Array of Tag objects	Especifica los criterios de filtro con cualquier etiqueta incluida. Se puede contener un máximo de 10 teclas. Para más detalles, consulte Tabla 3.
not_tags	No	Array of Tag objects	Especifica los criterios de filtro sin etiquetas incluidas. Se puede contener un máximo de 10 teclas. Para más detalles, consulte Tabla 3.
not_tags_any	No	Array of Tag objects	Especifica los criterios de filtro sin ninguna etiqueta incluida. Se puede contener un máximo de 10 teclas. Para más detalles, consulte Tabla 3.
limit	No	String	Especifica el número máximo de registros de consulta. El valor máximo es de 1,000 y el valor mínimo es 1. Si action está establecida en count, este parámetro no es válido. Si action se establece en filter, el valor predeterminado es 1000.
marker	No	String	Marca la ubicación de paginación (posición de índice). Se recomienda utilizar el parámetro offset para establecer la posición del índice. Marca la ubicación de paginación (ID de recurso o ubicación de índice).
action	Sí	String	Especifica la operación, que puede ser filter o count. filter: indica que los recursos se filtran por etiqueta y que los recursos que cumplen los criterios de búsqueda se devuelven en las páginas. count: indica que los recursos se buscan por etiqueta y se devuelve el número de recursos que cumplen los criterios de búsqueda.
offset	No	String	Especifica la posición del índice. La consulta comienza desde la siguiente imagen indexada por este parámetro. El valor debe ser un número no negativo. No es necesario especificar este parámetro al consultar recursos en la primera página. Cuando consulte recursos en páginas posteriores, establezca el offset en la ubicación devuelta en el cuerpo de la respuesta de la consulta anterior. Si el valor action es count, este parámetro no es válido. Si el valor action es filter, el valor predeterminado es 0.
matches	No	Array of match objects	Especifica la búsqueda difusa. Para más detalles, consulte Tabla 4.

**Tabla 3** Descripción del campo **tag**
Parámetro	Obligatorio	Tipo	Descripción
key	Sí	String	Especifica la clave de etiqueta. Contiene un máximo de 127 caracteres Unicode. No se puede dejar en blanco (Este parámetro no se verifica en el proceso de búsqueda). Se permite un máximo de 10 claves y la clave no se puede dejar en blanco o una string vacía. Cada clave debe ser única.
values	Sí	Array of strings	Especifica los valores de etiqueta. Un valor contiene un máximo de 255 caracteres Unicode. Una clave contiene un máximo de 10 valores. Cada valor de la misma clave debe ser único. El asterisco () está reservado para el sistema. Si el valor comienza con , indica que se realiza una coincidencia difusa para los dígitos siguientes a . El valor no puede contener solo asteriscos (). Si los valores son nulos (no predeterminados), indica any_value (consultando cualquier valor). Los recursos contienen uno o varios valores enumerados en values que se encontrarán y se mostrarán.

**Tabla 4** Descripción del campo **match**
Parámetro	Obligatorio	Tipo	Descripción
key	Sí	String	Especifica la clave en función de la cual se consultarán los recursos. El valor del parámetro solo puede ser resource_name.
value	Sí	String	Especifica el valor. El valor es un valor de diccionario fijo. Un valor contiene un máximo de 255 caracteres Unicode. Si el valor es una string vacía o resource_id, se utiliza la coincidencia exacta.

Ejemplo de la solicitud

Ejemplo de solicitud cuando action está configurada como filter

Este ejemplo muestra cómo consultar grupos AS de un tenant utilizando los siguientes criterios de búsqueda: incluyendo etiqueta (clave = clave1 y valor = valor), excluyendo etiqueta (clave = clave2 y valor = valor2), posición de índice 100 y 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"]
	}]
}

Ejemplo de solicitud cuando action está configurada para count

Este ejemplo muestra cómo consultar el número de grupos AS para un tenant utilizando los siguientes criterios de búsqueda: incluyendo la etiqueta (clave = key1 y valor = value) y excluyendo la etiqueta (clave = key2 y 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"
	}]
}

Mensaje de la respuesta

Parámetros de respuesta

**Tabla 5** Parámetros de respuesta
Parámetro	Tipo	Descripción
resources	Array of Resource objects	Especifica los recursos de etiquetas. Para más detalles, consulte Tabla 6.
total_count	Integer	Especifica el número total de registros. Cuando action se establece en count, solo se devuelve este parámetro. Los valores de resources y marker no se devuelven.
marker	String	Especifica el identificador de ubicación de paginación.

**Tabla 6** Descripción del campo **Resource**
Parámetro	Tipo	Descripción
resource_id	String	Especifica el ID del recurso.
resource_detail	String	Especifica los detalles del recurso.
tags	Array of ResourceTag objects	Especifica las etiquetas. Si no hay ninguna etiqueta, tags se toman como una matriz vacía por defecto. Para más detalles, consulte Tabla 7.
resource_name	String	Especifica el nombre del recurso. Si no hay ningún recurso, este parámetro es una string vacía de forma predeterminada.

**Tabla 7** Descripción del campo **ResourceTag**
Parámetro	Tipo	Descripción
key	String	Especifica la clave de etiqueta. Contiene un máximo de 36 caracteres Unicode.
value	String	Especifica el valor de etiqueta. Contiene un máximo de 36 caracteres Unicode.

Ejemplo de la respuesta

Ejemplo de respuesta cuando action se establece en 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
}

Ejemplo de respuesta cuando action está establecida en count
```
{
       "total_count": 1000
}
```

Valores devueltos

Normal.
200

Anormal

Valores devueltos	Descripción
400 Bad Request	Se produjo un error en el servidor al procesar la solicitud.
401 Unauthorized	Debe introducir el nombre de usuario y la contraseña para acceder a la página solicitada.
403 Forbidden	Está prohibido el acceso a la página solicitada.
404 Not Found	No se pudo encontrar la página solicitada.
405 Method Not Allowed	No se le permite utilizar el método especificado en la solicitud.
406 Not Acceptable	El cliente no pudo aceptar la respuesta generada por el servidor.
407 Proxy Authentication Required	Debe utilizar el servidor proxy para la autenticación para que la solicitud pueda procesarse.
408 Request Timeout	Se agotó el tiempo de espera de la solicitud.
409 Conflict	La solicitud no se pudo procesar debido a un conflicto.
500 Internal Server Error	Se produjo un error al completar la solicitud debido a un problema de servicio interno.
501 Not Implemented	Error al completar la solicitud porque el servidor no admite la función solicitada.
502 Bad Gateway	Error al completar la solicitud porque la solicitud no es válida.
503 Service Unavailable	Error al completar la solicitud porque el sistema no está disponible.
504 Gateway Timeout	Se ha producido un error de tiempo de espera de la puerta de enlace.