Consulta del BMS (API nativa de OpenStack)

Función

Esta API se utiliza para consultar el BMS.

Restricciones

• El resultado de la consulta devuelto por esta interfaz incluye tanto los ECS como los BMS. Es necesario filtrar los BMS utilizando la variante usada para crear los BMS o las etiquetas agregadas a los BMS durante la creación de BMS.
• Si la imagen se utiliza como criterio de búsqueda, no se admiten otros criterios de búsqueda ni criterios de paginación.If both the image and other search criteria are used, the BMSs are filtered out by image. Si la imagen no se utiliza como criterio de búsqueda, esta interfaz no tiene restricciones.

URI

GET /v2.1/{project_id}/servers{?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&tags={tags}&not-tags={not-tags}&reservation_id={reservation_id}&sort_key={sort_key}&sort_dir={sort_dir}}

Tabla 1 enumera los parámetros.

Solicitud

• Parámetros de solicitud

  Parámetro	Obligatorio	Tipo	Descripción
  changes-since	No	String	Especifica la marca de hora de la última actualización del estado de BMS. El parámetro está en formato de tiempo ISO 8601, por ejemplo 2013-06-09T06:42:18Z.
  image	No	String	Especifica el ID de imagen. Puede obtener el ID de imagen desde la consola de IMS o invocando a la API de Consulta de imágenes . NOTA: Si la imagen se utiliza como criterio de búsqueda, no se admiten otros criterios de búsqueda ni criterios de paginación. Si se utilizan tanto la imagen como otros criterios de búsqueda, los detalles del BMS se filtran por imagen. Si la imagen no se utiliza como criterio de búsqueda, esta interfaz no tiene restricciones.
  flavor	No	String	Especifica el ID de la variante. Puede obtener el ID de la variante desde la consola de BMS o usando la API de Consulta de variantes del BMS (API nativa de OpenStack).
  name	No	String	Especifica el nombre del BMS. Este parámetro admite la coincidencia difusa. Por ejemplo, la expresión regular ?name=bob devolverá bob y bobb. Para obtener solo bob, puede utilizar una expresión regular que coincida con la sintaxis básica de la base de datos, como MySQL o PostgreSQL (página oficial: https://www.postgresql.org/docs/9.2/static/functions-matching.html).
  status	No	String	Especifica el estado del BMS. Rango de valores: ACTIVE: Corriendo, deteniendo, eliminando BUILD: Creando ERROR: Defectuosa HARD_REBOOT: Reiniciando por la fuerza REBOOT: Reiniciando DELETED: Eliminado SHUTOFF: Detenido, iniciando, eliminando, reconstruyendo, reinstalando el SO, Error de reinstalación del SO, Congelado
  limit	No	Integer	Especifica el número del BMS que se muestran en cada página.
  marker	No	String	Especifica el identificador del BMS al que corresponde el marcador. La consulta comenzará a partir del siguiente ID.
  tags	No	String	Consulta los BMS con las etiquetas especificadas. Agregado en la versión micro 2.26.
  not-tags	No	String	Consulta los BMS con las etiquetas que no contienen el valor especificado. El valor es una lista de las claves de etiqueta. NOTA: Si las etiquetas agregadas antes de la actualización de la función tienen el formato de "Key.Value", las etiquetas de consulta con "Key". Por ejemplo, una etiqueta existente es a.b. Después de la actualización de la función de etiqueta, consulte la etiqueta usando "not-tags=a". Agregado en la versión micro 2.26.
  reservation_id	No	String	Especifica el ID reservado, que se puede utilizar para consultar los BMS creados en un lote. Agregado en la versión micro 2.26.
  sort_key	No	String	Especifica el atributo de ordenación de BMS, que puede ser el UUID del BMS (uuid), estado del BMS (vm_state), nombre del BMS (display_name), estado de la tarea del BMS (task_state), estado de energía (power_state), hora de creación (created_at), la última vez que la se actualiza el BMS (updated_at) y la AZ (availability_zone). Puede especificar varios pares de sort_key y sort_dir. El orden predeterminado es el orden inverso por created_at.
  sort_dir	No	String	Especifica la dirección de ordenación. asc: Los resultados de la consulta se muestran en orden ascendente. desc (valor predeterminado): los resultados de la consulta se muestran en orden descendente.

• Ejemplo de la solicitud
  • Sin parámetro opcional

    1	GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers

  • Con un parámetro opcional

    1	GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal

  • Con múltiples parámetros opcionales

    1	GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal&name=bms-test01

Respuesta

• Parámetros de respuesta

  Parámetro	Tipo	Descripción
  servers	Array of objects	Especifica la lista de BMS. Para obtener más información, véase Tabla 2.

  Tabla 2 Descripción de la estructura de datos de campo servers

  Parámetro	Tipo	Descripción
  name	String	Especifica el nombre del BMS.
  id	String	Especifica el identificador único del BMS.
  links	Array of objects	Especifica los enlaces de acceso directo del BMS. Para obtener más información, véase Tabla 3.

  Tabla 3 Descripción de la estructura de datos de campo links

  Parámetro	Tipo	Descripción
  rel	String	Especifica el nombre del marcador del enlace de acceso directo. El valor puede ser: self: el enlace de recurso que contiene el número de la versión. Se utiliza cuando se requiere un seguimiento inmediato. bookmark: el enlace de recurso que se puede almacenar durante mucho tiempo.
  href	String	Especifica el enlace de acceso directo correspondiente.

• Ejemplo de la respuesta

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

  { "servers": [ { "name": "bms", "links": [ { "rel": "self", "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8b-4bc5-ae46-69cacfd4fbaa" }, { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" } ], "id": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" } ] }

Valores devueltos

Para obtener más información sobre otros valores devueltos, consulte Códigos de estado.

Códigos de error

Véase Códigos de error.