Help Center/ Elastic Cloud Server/ API Reference/ APIs/ Batch Operations/ Detaching Volumes in a Batch
Updated on 2025-12-10 GMT+08:00
View PDF
Share

Detaching Volumes in a Batch

Function

This API is used to detach volumes in a batch.

This API is an asynchronous API. After the batch detachment request is successfully submitted, a job ID is returned. This does not mean the batch 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 *
  • g:ResourceTag/<tag-key>
  • g:EnterpriseProjectId

-

-

URI

POST /v1/{project_id}/batchaction/detachvolumes/{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.

volume_id

Yes

Specifies the volume ID.

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

serverinfo

Yes

Array of string

Specifies the list of ECSs from which the shared EVS disk is to be detached.

Response

Table 3 describes the response parameters.

Table 3 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 shared disk from ECSs in a batch.

POST https://{endpoint}/v1/{project_id}/batchaction/detachvolumes/{volume_id}

{
    "serverinfo": [   
        "a26887c6-c47b-4654-abb5-dfadf7d3f803","a26887c6-c47b-4654-abb5-dfadf7d3fa05"
    ]
}

Example Response

{
    "job_id": "ff80808288d41e1b018990260955686a"
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Batch Operations