Inicio de BMS
Función
Esta API se utiliza para iniciar BMS de los ID especificados. Puede iniciar un máximo de 1000 BMS a la vez.
Esta API es una API asíncrona. Invocar a la API correctamente indica que la tarea se ha entregado correctamente. Para comprobar si la tarea es correcta, usa la API de Consulta de estados de tareas.
URI
POST /v1/{project_id}/baremetalservers/action
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. |
Solicitud
- Parámetros de solicitud
En la solicitud, los parámetros para iniciar los BMS deben enviarse con el campo os-start. Para obtener más información, consulte la solicitud de ejemplo.
Parámetro
Obligatorio
Tipo
Descripción
os-start
Sí
Object
Especifica la operación para iniciar los BMS. Para obtener más información, véase Tabla 2.
Tabla 2 Descripción de la estructura de datos de campo os-start Parámetro
Obligatorio
Tipo
Descripción
servers
Sí
Array of objects
Especifica los identificadores de BMS. Para obtener más información, véase Tabla 3.
Tabla 3 Descripción de la estructura de datos de campo servers Parámetro
Obligatorio
Tipo
Descripción
id
Sí
String
Especifica el ID 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).
- Ejemplo de la solicitud
1
POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action
1 2 3 4 5 6 7 8 9 10 11 12
{ "os-start": { "servers": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" }, { "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" } ] } }
Respuesta
- Respuesta normal
Parámetro |
Tipo |
Descripción |
---|---|---|
job_id |
String |
Especifica el ID de tarea devuelto después de ejecutar un comando de tarea. El ID de tarea se puede utilizar para consultar el estado de ejecución de la tarea. Para obtener más información acerca de cómo consultar el estado de ejecución de la tarea basado en job_id, consulte Consulta de estados de tareas. |
- Respuesta anormal
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Dictionary data structure |
Especifica el error devuelto cuando un envío de tareas encuentra una excepción. Para obtener más información, véase Tabla 6. |
Ejemplo de la respuesta
- Respuesta normal
1 2 3
{ "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" }
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.