move doc sources to other location

Reviewed-by: OpenTelekomCloud Bot <None>

2022-04-27 16:24:25 +00:00

Configuring ECS Metadata

This API is used to configure ECS metadata.

When you call this API, all the metadata of this ECS will be deleted, and the ECS uses the value configured in the request.

An ECS must be in active, stopped, paused, or suspended state, which is specified by OS-EXT-STS:vm_state.

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

PUT /v2/{project_id}/servers/{server_id}/metadata

Table 1 describes the parameters in the URI.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID.
server_id	Yes	Specifies the ECS ID.

Table 2 describes the request parameters.

**Table 2** Request
Parameter	Type	Mandatory	Description
metadata	Object	Yes	Specifies the user-defined metadata key-value pair. For a metadata key: A key contains a maximum of 255 Unicode characters and cannot be empty. A key can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), hyphens (-), underscores (_), colons (:), and periods (.). For a metadata value: A value contains a maximum of 255 Unicode characters.

Table 3 describes the response parameters.

**Table 3** Response parameters
Parameter	Type	Description
metadata	Object	Specifies the user-defined metadata key-value pair.

PUT https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata
PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata

{
    "metadata": {
            "key1": "value1",
            "key2": "value2"
    }
}

{
    "metadata": {
            "key1": "value1",
            "key2": "value2"
    }
}

Parent topic: Metadata Management