Files

wanghuijuan738 69783f9e3e bms api 20241225 version

Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: wanghuijuan738 <wanghuijuan738@huawei.com>
Co-committed-by: wanghuijuan738 <wanghuijuan738@huawei.com>

2025-07-16 09:58:55 +00:00

22 KiB

Raw Blame History

Modifying Specified BMS Metadata

Function

This API is used to modify specified BMS metadata.

Constraints

The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, or paused.

URI

PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key}

Table 1 lists the parameters.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID. For how to obtain the project ID, see Obtaining Required Information.
server_id	Yes	Specifies the BMS ID. You can obtain the BMS ID from the BMS console or by calling the API Querying BMSs.
key	Yes	Specifies the BMS metadata key value to be modified.

Request Parameters

Parameter	Mandatory	Type	Description
meta	Yes	Object	Specifies the user-defined metadata key and value pair. For details, see Table 2.

**Table 2** **meta** data structure
Parameter	Mandatory	Type	Description
User-defined field key and value pair	Yes	String	Specifies the user-defined metadata key and value pair. Each key or value contains a maximum of 255 characters. The key does not support the following special characters: :`~!@#$%^&*()=+<,>?/'";{[]}\|\ The value does not support the following special characters: \"

Example Request

Modifying the metadata of a BMS (ID: 95bf2490-5428-432c-ad9b-5e3406f869dd) to customize a key-value pair

1
PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata/{key}

1
2
3
4
5
{
    "meta": {
        "key": "value"
    }
}

Response Parameters

Parameter	Type	Description
meta	Object	Specifies the user-defined metadata key and value pair. For details, see Table 3.

**Table 3** **meta** data structure
Parameter	Type	Description
User-defined field key and value pair	String	Specifies the user-defined metadata key and value pair. Each key or value contains a maximum of 255 characters.

Example Response

1
2
3
4
5
{
    "meta": {
        "key": "value"
    }
} 

Returned Values

Normal 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.

Parent topic: BMS Metadata Management (OpenStack Nova APIs)

22 KiB Raw Blame History