Consulta de balanceadores de carga por etiqueta
Función
Esta API se utiliza para consultar balanceadores de carga mediante etiquetas.
Restricciones
No hay
URI
POST /v2.0/{project_id}/loadbalancers/resource_instances/action
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto en el que se utiliza la etiqueta. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
tags |
No |
Array |
Especifica las etiquetas incluidas. Se permite un máximo de 10 claves para cada operación de consulta, y cada clave puede tener un máximo de 10 valores. La clave de etiqueta no se puede dejar en blanco ni establecer una string vacía. Cada clave de etiqueta y cada valor de etiqueta de la misma clave de etiqueta deben ser únicos. |
limit |
No |
Integer |
Establece el tamaño de página. Este parámetro está disponible cuando action se establece como filter. Tanto el valor predeterminado como el valor máximo son 1000, y el valor mínimo es 1. El valor no puede ser un entero negativo. |
offset |
No |
Integer |
Especifica la posición del índice. La consulta comienza desde el siguiente balanceador de carga indexado por este parámetro. Este parámetro no es necesario cuando consulta balanceadores de carga en la primera página. El valor de la respuesta devuelta para consultar los balanceadores de carga en la página anterior se incluirá en este parámetro para consultar los balanceadores de carga en páginas posteriores. Este parámetro no está disponible cuando action está establecida en count. Si action se establece en filter, el valor debe ser un entero positivo y el valor predeterminado es 0. |
action |
Sí |
String |
Identifica la operación. El valor puede ser filter o count. filter: indica consulta de paginación. count: indica que se devolverán todos los balanceadores de carga que cumplan con los criterios de búsqueda. |
matches |
No |
Array |
Especifica los criterios de búsqueda. La clave de etiqueta es el parámetro que debe coincidir, por ejemplo, resource_name. value indica el valor del contenido de coincidencia. La clave es un valor de diccionario fijo. Para más detalles, consulte Tabla 5. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
key |
Sí |
String |
Especifica la clave de etiqueta. Contiene un máximo de 127 caracteres Unicode y no se puede dejar en blanco. (Este parámetro no se verifica en el proceso de búsqueda.) |
values |
Sí |
Array |
Muestra los valores de etiqueta. Cada valor de etiqueta puede contener un máximo de 255 caracteres Unicode. Los valores están en la relación OR. Si no hay valores de etiqueta en la lista, la clave de etiqueta se utiliza para la búsqueda completa. Si cada valor de la lista comienza con un asterisco (*), se realiza una coincidencia difusa basada en la parte posterior al asterisco. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
key |
Sí |
String |
Especifica la clave de etiqueta para la coincidencia. El valor puede ser uno de los siguientes:
|
value |
Sí |
String |
Especifica el valor de etiqueta para la coincidencia. Cada valor de etiqueta puede contener un máximo de 255 caracteres Unicode. |
Parámetros de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
resources |
Array |
Enumera los balanceadores de carga. Para más detalles, consulte Tabla 7. |
total_count |
Integer |
Especifica el número total de registros consultados. |
Parámetro |
Tipo |
Descripción |
---|---|---|
resource_id |
String |
Especifica el ID del recurso. |
resource_detail |
Object |
Especifica los detalles del recurso. El valor es un objeto de recurso, utilizado para la extensión. El valor se deja en blanco de forma predeterminada. |
tags |
Array |
Muestra las etiquetas. Si no hay una etiqueta, se usa un array vacío por defecto. Para más detalles, consulte Tabla 8. |
resource_name |
String |
Especifica el nombre del recurso. Este parámetro es una string vacía de forma predeterminada si no hay un nombre de recurso. |
super_resource_id |
String |
Especifica el ID del recurso primario. |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Especifica la clave de etiqueta. Contiene un máximo de 127 caracteres Unicode y no se puede dejar en blanco. (Este parámetro no se verifica en el proceso de búsqueda.) |
value |
String |
Especifica el valor de etiqueta. Cada valor de etiqueta puede contener un máximo de 255 caracteres Unicode. |
Ejemplo de la solicitud
- Ejemplo de solicitud 1 (cuando action está configurada como filter)
POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/loadbalancers/resource_instances/action { "offset": "100", "limit": "100", "action": "filter", "matches": [ { "key": "resource_name", "value": "resource1" } ], "tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ] }
- Ejemplo de solicitud 2 (cuando action está configurada para count)
POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/loadbalancers/resource_instances/action { "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "resource_name", "value": "resource1" } ] }
Ejemplo de la respuesta
- Ejemplo de respuesta 1
{ "resources": [ { "resource_detail": "", "resource_id": "154d135b-3a89-4e89-8023-06efb9acdc05", "resource_name": "resouece1", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ], "total_count": 1000 }
- Ejemplo de respuesta 2
{ "total_count": 1000 }
Código de estado
Para más detalles, consulte Códigos de estado.