Consulta de oyentes por etiqueta
Función
Esta API se utiliza para consultar oyentes por etiqueta.
Restricciones
No hay
URI
POST /v2.0/{project_id}/listeners/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 de etiqueta para cada operación de consulta. Cada clave de etiqueta puede tener hasta 10 valores de etiqueta. Se debe incluir el cuerpo de la estructura. 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. Para más detalles, consulte Tabla 4. |
|
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 oyente indexado por este parámetro. Este parámetro no es necesario cuando se consulta oyentes en la primera página. El valor en la respuesta devuelta para la consulta de oyentes en la página anterior se incluirá en este parámetro para la consulta de oyentes 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.
|
|
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. Determinar si se requiere una coincidencia difusa en función de diferentes parámetros. Por ejemplo, si key es resource_name, se utiliza la búsqueda difusa de forma predeterminada. Si value es una string vacía, se utiliza la coincidencia exacta. Si la clave es resource_id, se utiliza la coincidencia exacta.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. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
key |
Sí |
String |
Especifica la clave de etiqueta. El valor puede ser uno de los siguientes:
|
|
value |
Sí |
String |
Especifica el valor de etiqueta. 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 oyentes. 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/listeners/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/listeners/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.
