This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Delete Volume

1 - 1.3

delete /v1/volumes/{volume_id}

Description

Delete Volume.

  • The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.

If a volume cannot be deleted.

  • Connected to server

  • OS Default volume

  • Connection with custom Image of Virtual Server

  • If volume is in state other than available, error, error extending, error restoring, or error managing

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required
Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
stringNone
querycascade
optional
Whether to delete snapshots together
Example : True
any of [boolean, null]True

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 202

2 - 1.2

delete /v1/volumes/{volume_id}

Description

Delete Volume.

  • The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.

If a volume cannot be deleted.

  • Connected to server

  • OS Default volume

  • Connection with custom Image of Virtual Server

  • If volume is in state other than available, error, error extending, error restoring, or error managing

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required
Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
stringNone
querycascade
optional
Whether to delete snapshots together
Example : True
any of [boolean, null]True

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"

Example HTTP response

Response 202

3 - 1.1

delete /v1/volumes/{volume_id}

Description

Delete Volume.

  • The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.

If a volume cannot be deleted.

  • Connected to server

  • OS Default volume

  • Connection with custom Image of Virtual Server

  • If volume is in state other than available, error, error extending, error restoring, or error managing

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required
Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
stringNone
querycascade
optional
Whether to delete snapshots together
Example : True
any of [boolean, null]True

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"

Example HTTP response

Response 202

4 - 1.0

delete /v1/volumes/{volume_id}

Description

Delete Volume.

  • The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.

If a volume cannot be deleted.

  • Connected to server

  • OS Default volume

  • Connection with custom Image of Virtual Server

  • If volume is in state other than available, error, error extending, error restoring, or error managing

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required
Volume ID
Example : 3f500f00-ed80-4566-a057-e31760226f9a
stringNone
querycascade
optional
Whether to delete snapshots together
Example : True
any of [boolean, null]True

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"

Example HTTP response

Response 202