Cambio del nombre del BMS
Función
Esta API se utiliza para cambiar el nombre de un BMS.
Restricciones
El nuevo nombre debe cumplir los siguientes requisitos:
Contiene de 1 a 63 caracteres, que consisten en letras (sin distinción entre mayúsculas y minúsculas), dígitos, guiones bajos (_), guiones (-) y puntos (.).
Esta API solo se puede usar para cambiar el nombre del BMS. El nombre de host no se cambiará. El nuevo nombre entra en vigor después de reiniciar el BMS.
URI
PUT /v1/{project_id}/baremetalservers/{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 ID de BMS. Puede obtener el ID de BMS desde la consola de BMSBMS o invocando al Consulta de los BMS (API nativa de OpenStack). |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
server |
Sí |
Object |
Especifica la estructura de datos del BMS. Para obtener más información, consulte Tabla 2. |
Ejemplo de solicitud
1 |
PUT https://{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/95bf2490-5428-432c-ad9b-5e3406f869dd |
1 2 3 4 5 6 |
{ "server": { "name": "new-server-test" } } |
Parámetros de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
server |
Object |
Especifica la información del BMS. Para obtener más información, consulte Tabla 3. |
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.
|
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, consulte Tabla 6. |
image |
Object |
Especifica la imagen del BMS. Para obtener más información, consulte Tabla 7. |
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 |
Object |
Especifica los metadatos del BMS. Para obtener más información, consulte Tabla 9. |
hostId |
String |
Especifica el identificador de host del BMS. |
addresses |
Object |
Especifica las direcciones de red del BMS. Para obtener más información, consulte Tabla 10. |
security_groups |
Array of objects |
Especifica los grupos de seguridad a los que pertenece el BMS. Para obtener más información, consulte Tabla 12. |
links |
Array of objects |
Especifica los enlaces de acceso directo del BMS. Para obtener más información, consulte Tabla 8. |
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 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 host del hipervisor. |
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. Ejemplos:
|
OS-EXT-STS:task_state |
String |
Especifica el estado de la tarea del BMS. Este es un atributo extendido. Ejemplos:
|
OS-EXT-STS:vm_state |
String |
Especifica el estado del BMS. Este es un atributo extendido. Ejemplos:
|
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-25T03:40:25.000000. |
OS-SRV-USG:terminated_at |
String |
Especifica la hora en que se detuvo el BMS. Este es un atributo extendido. El formato de marca de tiempo es ISO 8601, por ejemplo, 2019-06-25T03:40:25.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 13. |
accessIPv4 |
String |
Este es un atributo reservado. |
accessIPv6 |
String |
Este es un atributo reservado. |
fault |
Object |
Especifica la causa de un error de BMS. Para obtener más información, consulte Tabla 14. |
config_drive |
String |
Este es un atributo reservado. |
progress |
Integer |
Este es un atributo reservado. |
description |
String |
Especifica la información del BMS. |
host_status |
String |
Especifica el estado del host que aloja el BMS.
|
OS-EXT-SRV-ATTR:hostname |
String |
Especifica el nombre de host del BMS. |
OS-EXT-SRV-ATTR:reservation_id |
String |
Especifica los ID de BMS reservados en una situación de creación por lotes. Cuando los BMSBMS se crean por un lote, tienen el mismo reservation_id. |
OS-EXT-SRV-ATTR:launch_index |
Integer |
Especifica la secuencia de inicio del BMS en una situación de creación por lotes. |
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. |
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. |
OS-EXT-SRV-ATTR:root_device_name |
String |
Especifica el nombre del dispositivo del disco del sistema BMS, por ejemplo, /dev/sdb. |
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.
|
tags |
Array of strings |
Especifica las etiquetas del BMS. |
sys_tags |
Array of objects |
Especifica las etiquetas de sistema del BMS. Para obtener más información, consulte Tabla 4. |
enterprise_project_id |
String |
Especifica el ID del proyecto de empresa. |
os:scheduler_hints |
Object |
Especifica la información de programación de BMS. Para obtener más información, consulte Tabla 5. |
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 la variante. |
links |
Array of objects |
Especifica los enlaces de acceso directo de la variante. Para obtener más información, véase Tabla 8. |
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 8. |
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 |
---|---|---|
key |
String |
Especifica el par de clave y valor de los metadatos. Cada clave o valor contiene un máximo de 255 caracteres. |
Parámetro |
Tipo |
Descripción |
---|---|---|
vpc_id |
Array of objects |
Especifica la VPC utilizada por el BMS.
|
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 modo de asignación de direcciones IP. Este es un atributo extendido. |
OS-EXT-IPS:port_id |
String |
Especifica el ID de puerto correspondiente a la dirección IP. |
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 BMS.
|
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 un error. El formato de marca de tiempo es AAAA-MM-DDTHH:MM:SSZ (ISO 8601), por ejemplo, 2019-05-22T03:30:52Z. |
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 |
{ "server": { "tenant_id": "c685484a8cc2416b97260938705deb65", "addresses": { "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ { "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c4:77", "OS-EXT-IPS:type": "fixed", "OS-EXT-IPS:port_id": "0c111191-9785-49e6-8b42-66ef2802bd8f", "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://bms.az0.dc1.domainname.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" }, { "rel": "bookmark", "href": "https://bms.az0.dc1.domainname.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.az-dc-1", "image": { "links": [ { "rel": "bookmark", "href": "https://bms.az0.dc1.domainname.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://bms.az0.dc1.domainname.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.