Updated on 2024-10-22 GMT+08:00

Modifying Specified BMS Metadata (Discarded)

Function

This API is used to modify specified BMS metadata.

This API has been discarded. Use the API in Updating 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 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 (Discarded).

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

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

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.