Zaoxu, Li 4edaa4a4cc ECS API 20231016 version

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

2024-04-29 11:04:13 +00:00

9.7 KiB

Raw Blame History

Modifying ECS Metadata with a Specified Key

Function

This API is used to modify the ECS metadata with a specified key.

If the metadata does not contain the target field, the field is automatically added.
If the metadata contains the target field, the field value is automatically updated.

Constraints

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

URI

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

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

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.
key	Yes	Specifies the ECS metadata key.

Request

Table 2 describes the request parameters.

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

Response

Table 3 describes the response parameters.

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

Example Request

Set the metadata with a specified key of an ECS.

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

{
    "meta":{
        "key":"value"
    }
}

Example Response

{
    "meta":{
        "key":"value"
    }
}

Returned Values

See Returned Values for General Requests.

Parent topic: Metadata Management

9.7 KiB Raw Blame History