Consulta de detalles sobre un BMS (API nativa de OpenStack)
Función
Esta API se utiliza para consultar detalles sobre un BMS basado en el ID del BMS.
URI
GET /v2.1/{project_id}/servers/{server_id}
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. |
server_id |
Sí |
Especifica el identificador de BMS. Puede obtener el ID de BMS desde la consola de BMS o usando la API de Consulta del BMS (API nativa de OpenStack). |
Solicitud
Respuesta
- Parámetros de respuesta
Parámetro
Tipo
Descripción
server
Object
Especifica la información del BMS. Para obtener más información, véase Tabla 2.
Tabla 2 Descripción de la estructura de datos de campo server Parámetro
Tipo
Descripción
name
String
Especifica el nombre del BMS.
id
String
Especifica el identificador único del BMS.
status
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
- SHUTOFF: Detenido, iniciando, eliminando, reconstruyendo, reinstalando el SO, Error de reinstalación del SO, Congelado
created
String
Especifica la hora en que 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 hora a la que se actualizó por última vez 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 3.
image
Object
Especifica la imagen del BMS. Para obtener más información, véase Tabla 4.
tenant_id
String
Especifica el ID del tenant que posee el BMS. El valor está en formato UUID.
Este parámetro especifica el mismo significado que project_id.
key_name
String
Especifica el nombre de clave de SSH.
user_id
String
Especifica el ID del usuario al que pertenece el 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 identificador de host del BMS.
addresses
Map<String,Array of address objects>
Especifica las direcciones de red del BMS. Especifica la VPC utilizada por el BMS.
- key: indica el ID de la VPC utilizada por el BMS.
- value indica los detalles de la VPC.
security_groups
Array of objects
Especifica los grupos de seguridad a los que pertenece el BMS. Para obtener más información, véase Tabla 7.
links
Array of objects
Especifica los enlaces de acceso directo del BMS. Para obtener más información, véase Tabla 5.
OS-DCF:diskConfig
String
Especifica el método de configuración del disco. Este es un atributo extendido. El valor puede ser:
- MANUAL: La API utiliza el esquema de particionamiento en la imagen y el sistema de archivos para crear un BMS. Si la variante de destino tiene un disco grande, la API no particiona el espacio restante en disco.
- AUTO: La API utiliza una sola partición con el mismo tamaño que el disco de la variante de destino para crear un BMS. La API ajusta automáticamente el sistema de archivos para que se adapte a toda la partición.
OS-EXT-AZ:availability_zone
String
Especifica la AZ donde se encuentra el BMS.
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 un host en el 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.
Opciones: 0, 1, 2, 3 y 4
- 0: pendiente
- 1: en ejecución
- 2: en pausa
- 3: apagado
- 4: se bloqueó
OS-EXT-STS:task_state
String
Especifica el estado de la tarea del BMS. Este es un atributo extendido.
Rango de valores:
- rebooting: Se está reiniciando el BMS.
- reboot_started: El BMS normalmente se reinicia.
- reboot_started_hard: El BMS se reinicia a la fuerza.
- powering-off: El BMS está siendo apagado.
- powering-on: El BMS está siendo encendido.
- rebuilding: El BMS está siendo reconstruido.
- scheduling: El BMS se está programando.
- deleting: El BMS se está eliminando.
OS-EXT-STS:vm_state
String
Especifica el estado del BMS estable. Este es un atributo extendido.
Rango de valores:
- active: El BMS se está ejecutando.
- shutoff: El BMS se detiene.
- suspended: El BMS está suspendido.
- reboot: Se reinicia el BMS.
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 es 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 es ISO 8601, por ejemplo, 2019-05-22T04:23:59.000000.
os-extended-volumes:volumes_attached
Array of objects
Especifica los discos de EVS conectados al BMS. Para obtener más información, véase Tabla 8.
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 devuelve este campo. Para obtener más información, véase Tabla 9.
config_drive
String
Este es un atributo reservado.
progress
Integer
Este es un atributo reservado.
description
String
Proporciona la información adicional sobre el pool.
Este parámetro se agrega en la versión micro 2.19.
host_status
String
Especifica el estado del host que aloja el BMS.
- UP: El nova-compute es normal.
- UNKNOWN: El estado de nova-compute es desconocido.
- DOWN: el estado de nova-compute es anormal.
- MAINTENANCE: El nova-compute se encuentra en estado de mantenimiento.
- Cadena vacía: el BMS no tiene la información de host.
Agregado en la versión micro 2.16.
OS-EXT-SRV-ATTR:hostname
String
Especifica el nombre de host del BMS.
Agregado en la versión micro 2.3.
OS-EXT-SRV-ATTR:reservation_id
String
Especifica los identificadores del BMS reservados en el escenario de creación de BMS por lotes.
Agregado en la versión micro 2.3.
OS-EXT-SRV-ATTR:launch_index
Integer
Especifica la secuencia de inicio del BMS en el escenario de creación de BMS por lotes.
Agregado 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 la imagen AMI. En otros escenarios, deje este parámetro en blanco.
Agregado en la versión micro 2.3.
OS-EXT-SRV-ATTR:ramdisk_id
String
Especifica el UUID de la imagen Ramdisk cuando se utiliza la imagen AMI. En otros escenarios, deje este parámetro en blanco.
Agregado 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.
Agregado en la versión micro 2.3.
OS-EXT-SRV-ATTR:user_data
String
Especifica el user_data especificado durante la creación de BMS. El valor se codifica usando Base64 o una string vacía.
locked
Boolean
Especifica si el BMS está bloqueado.
- true: El BMS está bloqueado.
- false: El BMS no está bloqueado.
Agregado en la versión micro 2.9.
tags
Array of strings
Especifica las etiquetas del BMS.
Este parámetro se agrega en la microversión 2.26. Si la microversión no se utiliza para la consulta, la respuesta no contiene el campo tags.
El valor de este campo cumple con los requisitos siguientes:
- La clave y el valor de una etiqueta se conectan usando un (=), de igual signo, por ejemplo, key=value.
- Si el valor está vacío, solo se devuelve la clave.
Tabla 3 Descripción de la estructura de datos de campo flavor 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 5.
Tabla 4 Descripción de la estructura de datos de campo image 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 5.
Tabla 5 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.
Tabla 6 Descripción de la estructura de datos de campo address 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.
- 4: el tipo de la dirección IP es IPv4.
- 6: el tipo de la dirección IP es IPv6.
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.
- fixed: indica la dirección IP privada.
- floating: indica la EIP.
Tabla 7 Descripción de la estructura de datos de campo security_groups Parámetro
Tipo
Descripción
name
String
- Si no se especifica ningún grupo de seguridad durante la creación del BMS, se utiliza el valor default.
- Si se especifica un grupo de seguridad al crear el BMS, el valor de este parámetro es el nombre del grupo de seguridad.
Tabla 8 Descripción de la estructura de datos de campo os-extended-volumes:volumes_attached Parámetro
Tipo
Descripción
id
String
Especifica el ID de disco de EVS.
delete_on_termination
Boolean
Especifica si se eliminará el disco al eliminar el BMS.
- true: Sí
- false: No
Agregado en la versión micro 2.3.
Tabla 9 Descripción de la estructura de datos de campo fault 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 la 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
{ "server": { "tenant_id": "c685484a8cc2416b97260938705deb65", "addresses": { "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ { "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c3: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-83", "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.