Consulta de imágenes por etiqueta

Función

Esta API se utiliza para filtrar o contar imágenes usando etiquetas u otras condiciones.

Restricciones

Para ser compatible con las etiquetas restantes, el sistema no verificará el conjunto de caracteres de las claves de etiqueta y los valores en la condición de consulta cuando se utilicen los parámetros tags not_tags, tags_any, y not_tags_any.

URI

POST /v2/{project_id}/images/resource_instances/action

Solicitud

• Parámetros de solicitud

  Parámetro	Obligatorio	Tipo	Descripción
  action	Sí	String	Identifica la operación. Este parámetro distingue entre mayúsculas y minúsculas y su valor puede ser filter o count. El valor filter indica la consulta de paginación. El valor count indica que se devolverá el número total de resultados de consulta que cumplan los criterios de búsqueda.
  tags	No	Array of objects	Incluye todas las etiquetas especificadas. Se permite un máximo de 10 claves de etiqueta para cada operación de consulta. Cada clave de etiqueta puede contener un máximo de 10 valores de etiqueta. Tanto las claves de etiqueta como los valores deben ser únicos. Las claves de etiqueta no se pueden dejar en blanco. Para obtener más información, véase Tabla 2.
  tags_any	No	Array of objects	Incluye cualquiera de las etiquetas especificadas. Se permite un máximo de 10 claves de etiqueta para cada operación de consulta. Cada clave de etiqueta puede contener un máximo de 10 valores de etiqueta. Tanto las claves de etiqueta como los valores deben ser únicos. Las claves de etiqueta no se pueden dejar en blanco y establecer una cadena vacía. Para obtener más información, véase Tabla 3.
  not_tags	No	Array of objects	Excluye todas las etiquetas especificadas. Se permite un máximo de 10 claves de etiqueta para cada operación de consulta. Cada clave de etiqueta puede contener un máximo de 10 valores de etiqueta. Tanto las claves de etiqueta como los valores deben ser únicos. Las claves de etiqueta no se pueden dejar en blanco. Para obtener más información, véase Tabla 4.
  not_tags_any	No	Array of objects	Excluye cualquiera de las etiquetas especificadas. Se permite un máximo de 10 claves de etiqueta para cada operación de consulta. Cada clave de etiqueta puede contener un máximo de 10 valores de etiqueta. Tanto las claves de etiqueta como los valores deben ser únicos. Las claves de etiqueta no se pueden dejar en blanco. Para obtener más información, véase Tabla 5.
  without_any_tag	No	Boolean	Si este parámetro se establece en true, se consultan todos los recursos sin etiquetas. En este caso, los campos tag, not_tags, tags_any, y not_tags_any son ignorados.
  limit	No	String	Especifica el número máximo de registros de consulta. Este parámetro no es válido cuando action está establecida para count. Si action se establece como filter, el parámetro limit tiene efecto y su valor predeterminado es 10. El valor de limit varía de 1 a 1000.
  offset	No	String	Especifica la posición del índice. La consulta comienza desde la siguiente imagen indexada por este parámetro. Este parámetro no es necesario cuando se consultan los datos de la primera página y no es válido cuando action está establecida en count. Si action se establece en filter, el valor predeterminado de offset es 0. El valor de offset no puede ser un número negativo.
  matches	No	Array of objects	Especifica el criterio de búsqueda. La clave de etiqueta es el campo que debe coincidir, por ejemplo, resource_name o resource_id. value indica el valor coincidente. Las claves de esta lista deben ser únicas. El parámetro no se puede dejar en blanco y no se puede transferir. Para obtener más información, véase Tabla 6.

  Tabla 2 Descripción de la estructura de datos del campo de etiquetas

  Parámetro	Obligatorio	Tipo	Descripción
  key	Sí	String	Especifica la clave de etiqueta. La clave de etiqueta contiene un máximo de 127 caracteres Unicode y no se puede dejar en blanco.
  values	Sí	Array of strings	Muestra los valores de etiqueta. Cada valor puede contener un máximo de 255 caracteres Unicode. Si este parámetro se deja en blanco, se hace coincidir cualquier valor. Si se muestran varios valores, se devolverán las imágenes que tengan alguno de los valores.

  Tabla 3 Descripción de la estructura de datos del campo tags_any

  Parámetro	Obligatorio	Tipo	Descripción
  key	Sí	String	Especifica la clave de etiqueta. La clave de etiqueta contiene un máximo de 127 caracteres Unicode y no se puede dejar en blanco.
  values	Sí	Array of strings	Muestra los valores de etiqueta. Cada valor puede contener un máximo de 255 caracteres Unicode. Si este parámetro se deja en blanco, se hace coincidir cualquier valor. Si se muestran varios valores, se devolverán las imágenes que tengan alguno de los valores.

  Tabla 4 Descripción de la estructura de datos del campo not_tags

  Parámetro	Obligatorio	Tipo	Descripción
  key	Sí	String	Especifica la clave de etiqueta. La clave de etiqueta contiene un máximo de 127 caracteres Unicode y no se puede dejar en blanco.
  values	Sí	Array of strings	Muestra los valores de etiqueta. Cada valor puede contener un máximo de 255 caracteres Unicode. Si este parámetro se deja en blanco, se hace coincidir cualquier valor. Si se muestran varios valores, se devolverán las imágenes que tengan alguno de los valores.

  Tabla 5 Descripción de la estructura de datos del campo not_tags_any

  Parámetro	Obligatorio	Tipo	Descripción
  key	Sí	String	Especifica la clave de etiqueta. La clave de etiqueta contiene un máximo de 127 caracteres Unicode y no se puede dejar en blanco.
  values	Sí	Array of strings	Muestra los valores de etiqueta. Cada valor puede contener un máximo de 255 caracteres Unicode. Si este parámetro se deja en blanco, se hace coincidir cualquier valor. Cuando se especifican varios valores y se cumplen los requisitos clave, se consultan las imágenes que tienen cualquiera de los valores especificados.

  Tabla 6 Descripción de la estructura de datos del campo de coincidencias

  Parámetro	Obligatorio	Tipo	Descripción
  key	Sí	String	Especifica la clave de etiqueta, es decir, el nombre del campo de la operación de consulta. Los valores válidos incluyen resource_name y resource_id. Si el nombre del campo es resource_name y el valor es una cadena vacía, se realiza una consulta exacta. De lo contrario, se realiza una consulta difusa basada en el nombre de la imagen. Si el nombre del campo es resource_id, se realiza una consulta exacta basada en el ID de imagen.
  value	Sí	String	Especifica el valor de etiqueta. No se puede dejar en blanco. Cada valor puede contener un máximo de 255 caracteres Unicode.

Ejemplo de solicitud

• Recuento del número total de imágenes que cumplen las condiciones especificadas por tags

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

  POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/resource_instances/action { "action": "count", "matches": [{ "key": "resource_name", "value": "test100" }], "tags": [ { "key": "key3", "values": ["valueXX"] }], "tags_any": [ { "key": "key0", "values": ["valueXX"] }], "not_tags": [ { "key": "key9", "values": ["value9"] }], "not_tags_any": [{ "key": "key7", "values": ["value7"] }] }

• Filtrado de imágenes que cumplan las condiciones especificadas por tags

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

  POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/resource_instances/action { "action": "filter", "limit": "1", "offset": "0", "matches": [{ "key": "resource_name", "value": "test100" }], "tags": [ { "key": "key3", "values": ["valueXX"] }], "tags_any": [ { "key": "key0", "values": ["valueXX"] }], "not_tags": [ { "key": "key9", "values": ["value9"] }], "not_tags_any": [{ "key": "key7", "values": ["value7"] }] }

Respuesta

• Parámetros de respuesta

  Parámetro	Tipo	Descripción
  resources	Array of resource objects	Muestra las imágenes.
  total_count	Integer	Especifica el número total de registros de consulta.

  Tabla 7 Descripción de la estructura de datos del campo de recursos

  Parámetro	Tipo	Descripción
  resource_id	String	Especifica el ID de imagen.
  resource_detail	ResourceDetail object	Proporciona detalles de la imagen.
  tags	Array of Tags objects	Muestra las etiquetas de imagen.
  resource_name	String	Especifica el nombre de la imagen.

  Tabla 8 Objeto de ResourceDetail

  Parámetro	Tipo	Obligatorio	Descripción
  status	string	Sí	Especifica el estado de la imagen.

  Tabla 9 Descripción de la estructura de datos del campo resource_tag

  Parámetro	Tipo	Descripción
  key	String	Especifica la clave de la etiqueta.
  value	String	Especifica el valor de la etiqueta.

• Ejemplo de respuesta.
  • Ejemplo de respuesta cuando action está establecida en count

    STATUS CODE 200

    1 2 3

    { "total_count": 36 }

  • Ejemplo de respuesta cuando action se establece en filter

    STATUS CODE 200

    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

    { "total_count": 36, "resources": [{ "resource_name": "test10002", "resource_detail": {"status": "active"}, "tags": [{ "value": "value4", "key": "key4" }, { "value": "valueXX", "key": "key3" }, { "value": "value2", "key": "key2" }, { "value": "value5", "key": "key5" }, { "value": "value8", "key": "key8" }, { "value": "valueXX", "key": "key6" }, { "value": "valueXX", "key": "key0" }, { "value": "value1", "key": "key1" }, { "value": "value7", "key": "key7" }, { "value": "valueXX", "key": "key9" }], "resource_id": "8693187d-1590-4f9f-ae34-eb9e3037cf68" }] }

Valores devueltos

• Normal

  200

• Anormal

  Valor devuelto	Descripción
  400 Bad Request	Error de solicitud.
  401 Unauthorized	Error de autenticación.
  403 Forbidden	Usted no tiene los derechos para realizar la operación.
  404 Not Found	No se encontró el recurso solicitado.
  500 Internal Server Error	Error interno del servicio.
  503 Service Unavailable	El servicio no está disponible.