Consulta de ECS
Función
Esta API se utiliza para consultar ECS.
URI
GET /v2.1/{project_id}/servers?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip}
Parámetro |
Obligatorio |
Descripción |
---|---|---|
project_id |
Sí |
Especifica el ID del proyecto. Para obtener más información sobre cómo obtener el ID, consulte Obtención de un ID de proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
changes-since |
No |
String |
Especifica la marca de tiempo de la última actualización de estado de ECS, que se utiliza para filtrar los ECS con estados actualizados más tarde que la marca de tiempo. El formato debe cumplir con la norma ISO 8601 in the format of CCYY-MM-DDThh:mm:ss+/-hh:mm, por ejemplo, 2018-01-17T03:03:32Z. |
image |
No |
String |
Specifies the image ID. Cuando la imagen se utiliza como criterio de filtro, no se admiten otros criterios de filtro ni criterios de paginación. Si se especifican tanto la imagen como otros criterios de filtro, se utiliza el criterio de filtro de imagen. Si los criterios de consulta no contienen el criterio de filtro de imagen, las funciones de la API no están restringidas. |
flavor |
No |
String |
Especifica el identificador de tipo de ECS, que coincide con una coincidencia difusa. |
name |
No |
String |
Especifica el nombre de ECS, que coincide con una coincidencia difusa. |
status |
No |
String |
Especifica el estado de ECS. Opciones: ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, y VERIFY_RESIZE En la microversión 2.37, el sistema devolverá una lista vacía para el campo status de las opciones anteriores. En la microversión 2.38 y posteriores, el sistema devolverá el error 400. Para más detalles, consulte Estados de ECS. |
limit |
No |
Integer |
Especifica el límite superior del número de resultados devueltos. El valor predeterminado en cada página es 25, y la información de un máximo de 1000 ECS se muestra en cada página. |
marker |
No |
String |
Especifica el identificador de ECS al que apunta el marcador. La consulta comenzará a partir de su siguiente ID. |
tags |
No |
String |
Consulta ECS con etiquetas que contienen el valor especificado. |
not-tags |
No |
String |
Consulta ECS con etiquetas que no contienen el valor especificado. El valor es la clave de etiqueta.
NOTA:
Las funciones de etiqueta se han actualizado en la nube pública. 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". |
reservation_id |
No |
String |
Especifica el ID devuelto cuando se crean ECS por lotes. Este parámetro se utiliza para consultar los ECS creados por lotes. |
sort_key |
No |
String |
Ordena los resultados de la consulta por atributo de ECS. El orden de clasificación predeterminado es el orden inverso created_at. Opciones: created_at, availability_zone, display_name, host, instance_type_id, key_name, project_id, user_id, updated_at, uuid, y vm_state |
ip |
No |
String |
Indica el resultado del filtrado para las direcciones IPv4, que coinciden difusamente. |
Solicitud
No hay
Respuesta
Tabla 3 describe los parámetros de respuesta.
Parámetro |
Tipo |
Descripción |
---|---|---|
servers |
Array of objects |
Especifica los ECS que se van a consultar. Para más detalles, consulte Tabla 4. |
servers_links |
Array of objects |
Especifica el enlace de la página siguiente en la consulta de paginación. Para más detalles, consulte Tabla 5. |
Parámetro |
Tipo |
Descripción |
---|---|---|
name |
String |
Especifica el nombre de ECS. |
id |
String |
Especifica el ECS único. |
links |
Array of objects |
Especifica los enlaces de acceso directo de ECS. Para más detalles, consulte Tabla 5. |
Ejemplo de la solicitud
GET https://{endpoint}/v2.1/{project_id}/servers
Ejemplo de la respuesta
{ "servers": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19", "links": [ { "href": "http://openstack.example.com/v2/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19", "rel": "self" }, { "href": "http://openstack.example.com/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19", "rel": "bookmark" } ], "name": "new-server-test" } ] }