Help Center/ Elastic Cloud Server/ API Reference/ APIs/ Disk Management/ Modifying a Single Disk Attached to an ECS
Updated on 2024-12-19 GMT+08:00
View PDF
Share

Modifying a Single Disk Attached to an ECS

Function

This API is used to modify the information about a single disk attached to an ECS.

Currently, only the delete_on_termination parameter can be modified.

Constraints

  • Yearly/monthly-billed disks cannot be modified.
  • Shared disks cannot be modified.
  • System disks cannot be modified.

URI

PUT /v1/{project_id}/cloudservers/{server_id}/block_device/{volume_id}

Table 1 lists the parameters.

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.

Request

Table 2 Request parameter

Parameter

Mandatory

Type

Description

block_device

Yes

Object

Updates the information about a disk attached to the ECS. For details, see Table 3.
Table 3 block_device parameter

Parameter

Mandatory

Type

Description

delete_on_termination

Yes

Boolean

Specifies whether the disk attached to the ECS is deleted when the ECS is deleted.

  • true: The disk is deleted when the ECS is deleted.
  • false: The disk is not deleted when the ECS is deleted.
NOTE:
  • Yearly/monthly-billed disks cannot be modified.
  • Shared disks cannot be modified.
  • System disks cannot be modified.

Response

None

Example Request

Set a disk to be deleted together with the ECS when the attached ECS is deleted.

PUT https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/block_device/{volume_id}
{
	"block_device": {
		"delete_on_termination": true
	}
}

Example Response

None

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Disk Management