Updated on 2025-08-20 GMT+08:00

Updating ECS Metadata Configuration

Function

This API is used to update metadata configuration of an ECS.

Constraints

The ECS status (which is specified by OS-EXT-STS:vm_state) must be active, stopped, paused, or suspended.

URI

PUT /v1/{project_id}/cloudservers/{server_id}/metadata-options

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

server_id

Yes

Specifies the ECS ID.

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

http_endpoint

No

String

Specifies whether the IMDS service is enabled. The default value is enabled.

  • enabled: IMDS is enabled.
  • disabled: IMDS is disabled.

http_tokens

No

String

Specifies whether the token is optional. The default value is optional.

  • optional: The token is optional.
  • required: The token is required, which means IMDS v1 is disabled and IMDS v2 is enabled.

Response

None.

Example Request

Update the metadata configuration of the ECS and enable IMDS v2 with the token required.

PUT https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/metadata-options
{
    "http_endpoint": "enabled",
    "http_tokens": "required"
}

Example Response

None.