• Elastic Cloud Server

ecs
  1. Help Center
  2. Elastic Cloud Server
  3. API Reference
  4. OpenStack Nova APIs
  5. Metadata Management
  6. Updating ECS Metadata

Updating ECS Metadata

Function Description

This interface is used to update ECS metadata.

  • 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.
  • If the field in the metadata is not requested, the field value remains unchanged.

Constraints

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

URI

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

POST /v2.1/{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.

Request

Request parameters

Table 2 describes the request parameters.
Table 2 Request parameters

Parameter

Mandatory

Type

Description

metadata

Yes

Dict

Specifies the user-defined metadata key-value pair.

Table 3 metadata field description

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag key.

It contains a maximum of 255 Unicode characters and cannot be blank. The value can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), hyphens (-), underscores (_), colons (:), and periods (.).

value

Yes

String

Specifies the tag value.

It contains a maximum of 255 Unicode characters.

Response

Response parameters

Table 4 describes the response parameters.
Table 4 Response parameters

Parameter

Type

Description

metadata

Dict

Specifies the user-defined metadata key-value pair.

Examples

  • Example request
    {
    "metadata": {
            "key": "value"
        }
    }
  • Example response
    {
        "metadata":{
            "key":"value"
        }
        }

Returned Values

See General Request Returned Values.