Updated on 2025-12-10 GMT+08:00

Deleting Specified ECS Metadata

Function

This API is used to delete specified ECS metadata.

Constraints

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

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permissions listed below are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ecs:cloudServers:deleteMetadata

write

instance *

-

-

-

URI

DELETE /v1/{project_id}/cloudservers/{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.

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

server_id

Yes

Specifies the ECS ID.

key

Yes

Specifies the ECS metadata key value to be deleted.

Request

None

Response

None

Example Request

Delete a specified metadata from an ECS.

DELETE https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/metadata/{key}

Example Response

None