Consulta de detalles sobre los BMS (API nativa de OpenStack)
Función
Esta API se utiliza para consultar detalles sobre BMS.
Restricciones
- El resultado de la consulta devuelto por esta interfaz contiene los detalles tanto de ECS como de BMS. Es necesario filtrar los detalles del BMS utilizando la variante usada para crear los BMS o las etiquetas agregadas a los BMS durante la creación del BMS.
- 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.
URI
GET /v2.1/{project_id}/servers/detail{?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&tags={tags}¬-tags={not-tags}&reservation_id={reservation_id}&sort_key={sort_key}&sort_dir={sort_dir}}
Tabla 1 enumera los parámetros.
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 del proyecto, consulte Obtención de un ID de proyecto. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
changes-since |
No |
String |
Especifica la marca de hora de la última actualización de estado de BMSBMSBMS. 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 . 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 variante desde la consola de BMSBMSBMS o con la API de Consulta de variantes de BMS (API nativa de OpenStack). |
name |
No |
String |
Especifica el nombre del BMSBMSBMS. 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 BMSBMSBMS. Rango de valores:
|
limit |
No |
Integer |
Especifica el número de BMSBMSBMS que se muestran en cada página. |
marker |
No |
String |
Especifica el ID de BMSBMSBMS al que corresponde el marcador. La consulta comenzará a partir del siguiente ID. |
tags |
No |
String |
Consulta los BMSBMSBMS con las etiquetas especificadas. Agregado en la versión micro 2.26. |
not-tags |
No |
String |
Consulta los BMSBMSBMS con etiquetas que no contengan el valor especificado. El valor es una lista de claves de etiqueta. 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 BMSBMSBMS creados por 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 BMSBMSBMS (uuid), estado del BMSBMSBMS (vm_state), nombre del BMSBMSBMS (display_name), estado de la tarea del BMSBMSBMS (task_state), estado de energía (power_state), hora de creación (created_at), la última vez que la se actualiza el BMSBMS (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.
|
Ejemplo de solicitud
- Consultar detalles sobre los BMS
1
https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail
- Consultar detalles sobre BMS con la etiqueta __type_baremetal
1
https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal
- Consultar detalles sobre BMS con la etiqueta __type_baremetal y con bms-test01 contenido en el nombre
1
https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal&name=bms-test01
Parámetros de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
servers |
Array of objects |
Especifica los detalles sobre el BMS. Para obtener más información, véase Tabla 2. |
Parámetro |
Tipo |
Descripción |
---|---|---|
name |
String |
Especifica el nombre del BMS. |
id |
String |
Especifica el ID único del BMS. |
status |
String |
Especifica el estado del BMS. Rango de valores:
|
created |
String |
Especifica cuándo se creó el BMS. El formato de marca de tiempo es AAAA-MM-DDTHH:MM:SSZ (ISO 8601), por ejemplo, 2019-05-22T03:30:52Z. |
updated |
String |
Especifica la última vez que se actualizó el BMS. El formato de marca de tiempo es AAAA-MM-DDTHH:MM:SSZ (ISO 8601), por ejemplo, 2019-05-22T04:30:52Z. |
flavor |
Object |
Especifica la variante del BMS. Para obtener más información, véase Tabla 5. |
image |
Object |
Especifica la imagen del BMS. Para obtener más información, véase Tabla 6. |
tenant_id |
String |
Especifica el ID del tenant que posee el BMS. El valor está en formato UUID. Este parámetro es igual a project_id. |
key_name |
String |
Especifica el nombre de clave de SSH. |
user_id |
String |
Especifica el ID de usuario del BMS. |
metadata |
Map<String,String> |
Especifica los metadatos del BMS. Es un par de clave y valor del metadato definido por el usuario. Cada clave o valor contiene un máximo de 255 caracteres. |
hostId |
String |
Especifica el ID de host del BMS. |
addresses |
Map<String,Array of address objects> |
Especifica la dirección de red del BMS. Especifica la VPC utilizada por el BMS.
|
security_groups |
Array of objects |
Especifica los grupos de seguridad del BMS. Para obtener más información, consulte Tabla 9. |
links |
Array of objects |
Especifica los enlaces de acceso directo del BMS. Para obtener más información, véase Tabla 7. |
OS-DCF:diskConfig |
String |
Especifica el método de configuración del disco. Este es un atributo extendido. El valor puede ser:
|
OS-EXT-AZ:availability_zone |
String |
Especifica el nombre de la AZ donde se despliega el BMS. Este es un atributo extendido. |
OS-EXT-SRV-ATTR:host |
String |
Especifica el nombre de host del BMS. Este es un atributo extendido. |
OS-EXT-SRV-ATTR:hypervisor_hostname |
String |
Especifica el nombre de host del hipervisor. Este es un atributo extendido proporcionado por el controlador Nova virt. |
OS-EXT-SRV-ATTR:instance_name |
String |
Especifica el alias del BMS. Este es un atributo extendido. |
OS-EXT-STS:power_state |
Integer |
Especifica el estado de energía del BMS. Este es un atributo extendido. Rango de valores:
|
OS-EXT-STS:task_state |
String |
Especifica el estado de la tarea del BMS. Este es un atributo extendido. Rango de valores:
|
OS-EXT-STS:vm_state |
String |
Especifica el estado del BMS. Este es un atributo extendido. Rango de valores:
|
OS-SRV-USG:launched_at |
String |
Especifica la hora en que se inició el BMS. Este es un atributo extendido. El formato de marca de tiempo cumple con la norma ISO 8601, por ejemplo 2019-05-22T03:23:59.000000. |
OS-SRV-USG:terminated_at |
String |
Especifica la hora a la que se eliminó el BMS. Este es un atributo extendido. El formato de marca de tiempo cumple con la norma ISO 8601, por ejemplo, 2019-05-22T04:23:59.000000. |
os-extended-volumes:volumes_attached |
Array of objects |
Especifica los discos de EVS adjuntos del BMS. Para obtener más información, consulte Tabla 10. |
accessIPv4 |
String |
Este es un atributo reservado. |
accessIPv6 |
String |
Este es un atributo reservado. |
fault |
Object |
Especifica la causa del error. Si el BMS es defectuoso, se devolverá este campo. Para obtener más información, véase Tabla 11. |
config_drive |
String |
Este es un atributo reservado. |
progress |
Integer |
Este es un atributo reservado. |
description |
String |
Especifica la descripción sobre el BMS. Este es un parámetro nuevo en la versión micro 2.19. |
host_status |
String |
Especifica el estado del host del BMS.
Este es un parámetro nuevo en la versión micro 2.16. |
OS-EXT-SRV-ATTR:hostname |
String |
Especifica el nombre de host del BMS. Este es un parámetro nuevo en la versión micro 2.3. |
OS-EXT-SRV-ATTR:reservation_id |
String |
Especifica los ID de BMS reservados cuando se crean los BMS por lotes. Este es un parámetro nuevo en la versión micro 2.3. |
OS-EXT-SRV-ATTR:launch_index |
Integer |
Especifica la secuencia de inicio de los BMS creados por lotes. Este es un parámetro nuevo en la versión micro 2.3. |
OS-EXT-SRV-ATTR:kernel_id |
String |
Especifica el UUID de la imagen del núcleo cuando se utiliza una imagen AMI. En otros casos, deje este parámetro en blanco. Este es un parámetro nuevo en la versión micro 2.3. |
OS-EXT-SRV-ATTR:ramdisk_id |
String |
Especifica el UUID de una imagen de disco de RAM cuando se utiliza la imagen AMI. En otros casos, deje este parámetro en blanco. Este es un parámetro nuevo en la versión micro 2.3. |
OS-EXT-SRV-ATTR:root_device_name |
String |
Especifica el nombre del dispositivo del disco del sistema del BMS, por ejemplo, /dev/sda. Este es un parámetro nuevo en la versión micro 2.3. |
OS-EXT-SRV-ATTR:user_data |
String |
Especifica el user_data especificado durante la creación del BMS. El valor se codifica usando Base64 o una string vacía. |
locked |
Boolean |
Especifica si el BMS está bloqueado.
Este es un parámetro nuevo en la versión micro 2.9. |
tags |
Array of strings |
Especifica las etiquetas del BMS. Este es un parámetro nuevo en la versión micro 2.26. Si no está utilizando esta versión micro, la respuesta no contendrá el parámetro tags. Una etiqueta debe cumplir los siguientes requisitos:
|
sys_tags |
Array of objects |
Especifica las etiquetas de sistema del BMS. Para obtener más información, consulte Tabla 3. |
enterprise_project_id |
String |
Especifica el ID del proyecto de empresa. |
os:scheduler_hints |
Object |
Especifica la información de programación del BMS. Para obtener más información, véase Tabla 4. |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Especifica la clave de etiqueta del sistema. |
value |
String |
Especifica el valor de la etiqueta del sistema. |
Parámetro |
Tipo |
Descripción |
---|---|---|
group |
Array of strings |
Especifica el ID de grupo de BMS en formato UUID. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de tipo del BMS. |
links |
Array of objects |
Especifica los enlaces de acceso directo del tipo del BMS. Para obtener más información, véase Tabla 7. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de imagen del BMS. |
links |
Array of objects |
Especifica los enlaces de acceso directo de la imagen del BMS. Para obtener más información, véase Tabla 7. |
Parámetro |
Tipo |
Descripción |
---|---|---|
rel |
String |
Especifica el nombre del marcador del enlace de acceso directo. El valor puede ser:
|
href |
String |
Especifica el enlace de acceso directo correspondiente. |
Parámetro |
Tipo |
Descripción |
---|---|---|
addr |
String |
Especifica la dirección IP. |
version |
Integer |
Especifica el tipo de la dirección IP. El valor puede ser 4 o 6.
|
OS-EXT-IPS-MAC:mac_addr |
String |
Especifica la dirección de MAC. Este es un atributo extendido. |
OS-EXT-IPS:type |
String |
Especifica el tipo de dirección IP. Este es un atributo extendido.
|
Parámetro |
Tipo |
Descripción |
---|---|---|
name |
String |
|
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de disco de EVS. |
delete_on_termination |
Boolean |
Especifica si se eliminará el disco cuando se eliminará el BMSBMSBMS.
Agregado en la versión micro 2.3. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Especifica la información de error. |
code |
Integer |
Especifica el código de error. |
details |
String |
Especifica los detalles del error. |
created |
String |
Especifica la hora en que se produjo el error. La hora está en formato ISO 8601. |
Ejemplo de respuesta
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
{ "servers": [ { "tenant_id": "c685484a8cc2416b97260938705deb64", "addresses": { "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ { "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c4:77", "OS-EXT-IPS:type": "fixed", "addr": "192.168.0.107", "version": 4 } ] }, "metadata": { "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" }, "OS-EXT-STS:task_state": null, "OS-DCF:diskConfig": "MANUAL", "OS-EXT-AZ:availability_zone": "az-dc-1", "links": [ { "rel": "self", "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" }, { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" } ], "OS-EXT-STS:power_state": 1, "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", "os-extended-volumes:volumes_attached": [ { "id": "dfa375b5-9856-44ad-a937-a4802b6434c3" }, { "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417" }, { "id": "86e801c3-acc6-465d-890c-d43ba493f553" }, { "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6" } ], "OS-EXT-SRV-ATTR:host": "bms.az1", "image": { "links": [ { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" } ], "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" }, "OS-SRV-USG:terminated_at": null, "accessIPv4": "", "accessIPv6": "", "created": "2017-05-24T06:14:05Z", "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2", "key_name": "KeyPair-JX", "flavor": { "links": [ { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" } ], "id": "physical.83.medium" }, "security_groups": [ { "name": "0011b620-4982-42e4-ad12-47c95ca495c4" } ], "config_drive": "", "OS-EXT-STS:vm_state": "active", "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3", "user_id": "1311c433dd9b408886f57d695c229cbe", "name": "bms", "progress": 0, "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078", "updated": "2017-05-25T03:40:25Z", "status": "ACTIVE" } ] } |
Valores devueltos
Valores devueltos |
Descripción |
---|---|
200 |
La solicitud se ha procesado correctamente. |
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.