Help Center/ Elastic Volume Service/ API Reference/ Cinder API/ Disk Management/ Detaching an EVS Disk (Deprecated)
Updated on 2024-02-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Detaching an EVS Disk (Deprecated)

Function

This API is only used to change the EVS disk status from in-use to available. Note: This API call exists for compatibility reasons only and is not meant to be used.

Constraints

Do not call this API to detach an EVS disk. If you need to detach a disk, call the ECS Detach Volume API.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/volumes/{volume_id}/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

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

volume_id

Yes

String

The disk ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

os-detach

Yes

CinderDetachVolumeOption object

The disk detachment marker.
Table 4 CinderDetachVolumeOption

Parameter

Mandatory

Type

Description

attachment_id

No

String

The attachment ID. If the disk has only one attachment, this parameter is optional. If it has multiple attachments, the parameter is mandatory.

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.
Table 6 Error

Parameter

Type

Description

code

String

The error code returned if an error occurs.

For details about error codes and their meanings, see Error Codes.

message

String

The error message returned if an error occurs.

Example Requests

{
  "os-detach" : {
    "attachment_id" : "d8777f54-84cf-4809-a679-468ffed56cf1"
  }
}

Example Responses

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

Status Codes

Status Code

Description

202

Accepted

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: Disk Management