Modifying Specified BMS Metadata (Native OpenStack API)¶
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.
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 Querying BMSs (Native OpenStack API). |
key | Yes | Specifies the BMS metadata key value to be modified. |
Request¶
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 field data structure description¶ 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
PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata/{key}
{ "meta": { "key": "value" } }
Response¶
Response parameters
Parameter
Type
Description
meta
Object
Specifies the user-defined metadata key and value pair. For details, see Table 3.
Table 3 meta field data structure description¶ 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
{ "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.