Updating BMS Metadata
Function
This API is used to update BMS metadata.
- If the metadata does not contain the target field, the field is automatically added to the field.
- If the metadata contains the target field, the field value is automatically updated.
- If the field in the metadata is not requested, the field value remains unchanged.
Constraints
The BMS must be in active, stopped, or paused state. The state is indicated by the OS-EXT-STS:vm_state parameter.
URI
POST /v1/{project_id}/baremetalservers/{server_id}/metadata
Parameter |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
server_id |
Yes |
Specifies the BMS ID. You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API). |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
metadata |
Yes |
Object |
Specifies the user-defined metadata key-value pair. If you do not specify any key-value pair, metadata will not be updated. key: It contains a maximum of 255 Unicode characters which can be letters, digits, hyphens (-), underscores (_), colons (:), and periods (.). key cannot be left blank. value: It contains a maximum of 255 Unicode characters. |
Example Request
1
|
POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/metadata |
1 2 3 4 5 |
{ "metadata": { "key": "value" } } |
Response Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
metadata |
Yes |
Object |
Specifies the user-defined metadata key-value pair. If you do not specify any key-value pair, metadata will not be updated. key: It contains a maximum of 255 Unicode characters which can be letters, digits, hyphens (-), underscores (_), colons (:), and periods (.). key cannot be left blank. value: It contains a maximum of 255 Unicode characters. |
Example Response
1 2 3 4 5 |
{ "metadata":{ "key": "value" } } |
Returned Values
Returned Values |
Description |
---|---|
200 |
The request has been successfully processed. |
For details about other returned values, see Status Codes.
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot