Help Center/ Elastic Cloud Server/ API Reference/ APIs/ Disk Management/ Detaching an EVS Disk from an ECS
Updated on 2025-12-10 GMT+08:00
View PDF
Share

Detaching an EVS Disk from an ECS

Function

This API is used to detach an EVS disk from an ECS.

This API is an asynchronous API. After the detachment request is successfully delivered, a job ID is returned. This does not mean the detachment is complete. You need to call the API by referring to Querying Job Execution Status to query the job status. The SUCCESS status indicates that the detachment is successful.

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:detachVolume

write

instance *

-

-

-

URI

DELETE /v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}

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.

volume_id

Yes

Specifies the disk ID.

delete_flag

No

Indicates whether to forcibly detach a data disk.

  • If yes, set it to 1.
  • If no, set it to 0.

It is set to 0 by default.

Request

None

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

job_id

String

Definition

Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.

Range

N/A

For details about abnormal responses, see Responses (Jobs).

Example Request

Detach a specified disk from an ECS.

DELETE https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}

Example Response

{
    "job_id": "ff80808288d41e1b018990260955686a"
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Disk Management