Actualización de los metadatos del BMS
Función
Esta API se utiliza para actualizar los metadatos de BMS.
- Si los metadatos no contienen el campo de destino, el campo se agrega automáticamente al campo.
- Si los metadatos contienen el campo de destino, el valor del campo se actualiza automáticamente.
- Si no se solicita el campo de los metadatos, el valor del campo permanece sin cambios.
Restricciones
El BMS debe estar en el estado activo, detenido, pausado o suspendido, que se especifica mediante el atributo OS-EXT-STS:vm_state.
URI
POST /v1/{project_id}/baremetalservers/{server_id}/metadata
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 BMS o usando la API de Consulta del BMS (API nativa de OpenStack). |
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
metadata |
Sí |
Object |
Especifica el par de clave y valor de metadatos definido por el usuario. Si no especifica ningún par de clave y valor, los metadatos no se actualizarán. key: Contiene un máximo de 255 caracteres de Unicode que pueden ser letras, dígitos, guiones (-), guiones bajos (_), dos puntos (:) y puntos (.). key no se puede dejar en blanco. value: Contiene un máximo de 255 caracteres de Unicode. |
- Ejemplo de la solicitud
1POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/metadata
1 2 3 4 5
{ "metadata": { "key": "value" } }
Respuesta
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
metadata |
Sí |
Object |
Especifica el par de clave y valor de metadatos definido por el usuario. Si no especifica ningún par de clave y valor, los metadatos no se actualizarán. key: Contiene un máximo de 255 caracteres de Unicode que pueden ser letras, dígitos, guiones (-), guiones bajos (_), dos puntos (:) y puntos (.). key no se puede dejar en blanco. value: Contiene un máximo de 255 caracteres de Unicode. |
- Ejemplo de la respuesta
1 2 3 4 5
{ "metadata":{ "key": "value" } }
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.
