Call the AttachDisk API to attach a disk to an ECS instance - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Attaches a data disk or system disk to an ECS instance.

Operation description

When you call this operation, take note of the following items:

The instance and the disk must be in the same zone.
The disk must be in the Available (Available) state.
When you attach a data disk:
- The destination ECS instance must be in the Running (Running) or Stopped (Stopped) state.
- If the disk is separately purchased, the billing method must be pay-as-you-go.
- A system disk that was uninstalled from an ECS instance can be attached as a data disk without billable methods restrictions.
- An elastic ephemeral disk that has been detached can only be re-attached to its original instance.
When you attach a system disk:
- The destination ECS instance must be the original instance from which the system disk was detached.
- The destination ECS instance must be in the Stopped (Stopped) state.
- You must specify the logon credential for the instance.
- Elastic ephemeral disks cannot be attached as system disks.
- For more information about attaching system disks, see Detach or attach a system disk.
When you query ECS instance information, if the response contains {"OperationLocks": {"LockReason" : "security"}}, all operations are prohibited.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:AttachDisk

update

*Disk

acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

ecs:LoginAsNonRoot
ecs:PasswordCustomized

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ECS instance to which you want to attach the disk.	i-bp1dq5lozx5f4pmd****
DiskId	string	Yes	The ID of the disk to be attached. The disk (`DiskId`) and the instance (`InstanceId`) must be in the same zone. Note Both data disks and system disks can be attached. For related constraints, see the operation description section above.	d-bp1j4l5axzdy6ftk****
Device	string	No	The device name of the disk. Note This parameter will be deprecated soon. To improve compatibility, use other parameters to identify the disk.	testDeviceName
DeleteWithInstance	boolean	No	Specifies whether to release the disk when the instance is released. Valid values: true: The disk is released together with the instance. false: The disk is not released together with the instance. The disk is retained as a pay-as-you-go data disk. Default value: false. When you set this parameter, take note of the following items: If you set `DeleteWithInstance` to `false` and the ECS instance is locked for security reasons, meaning that `OperationLocks` contains `"LockReason" : "security"`, this parameter is ignored when the instance is released, and the disk is released together with the instance. If the disk to be attached is an `elastic ephemeral disk`, you must set `DeleteWithInstance` to `true`. Disks with the multi-attach feature enabled do not support this parameter.	false
Bootable	boolean	No	Specifies whether to attach the disk as a system disk. Valid values: true: The disk is attached as a system disk. false: The disk is not attached as a system disk. Default value: false. Note If you set `Bootable=true`, the destination ECS instance must have no system disk attached.	false
Password	string	No	The password that is set for the instance when you attach a system disk. The password is effective only for the administrator and root usernames and is not effective for other usernames. The password must be 8 to 30 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported: ()`~!@#$%^&-_+=\|{}[]:;'<>,.?/ For Windows instances, the password cannot start with a forward slash (/). Note* If you specify the `Password` parameter, send the request over HTTPS to prevent password leaks.	EcsV587!
KeyPairName	string	No	The name of the SSH key pair that is bound to the Linux ECS instance when you attach a system disk. Windows Server instances: SSH key pairs are not supported. Even if this parameter is specified, only the `Password` configuration takes effect. Linux instances: The password-based logon method is disabled by default.	KeyPairTestName
Force	boolean	No	Specifies whether to forcefully attach the disk. Valid values: true: Forcefully attaches the disk. false: Does not forcefully attach the disk. Default value: false. Note Currently, only regional ESSDs (cloud_regional_disk_auto) support setting this parameter to true.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDevice.Malformed	The specified device is not valid.
400	IncorrectInstanceStatus	The current status of the resource does not support this operation.	The resource is in a state that does not support the current operation.
400	InvalidParameter	The input parameter is mandatory for processing this request is empty.	A required parameter is not specified.
400	InvalidRegionId.MalFormed	The specified RegionId is not valid.
400	InvalidOperation.InstanceTypeNotSupport	The instance type of the specified instance does not support hot attach disk.	The instance to which the disk is attached does not support the hot swapping of disks.
400	DiskCategory.OperationNotSupported	The operation is not supported to the specified disk due to its disk category.	The specified disk category does not support this operation.
400	InvalidDisk.DiskNotBootable	The specified disk is not a bootable disk. It cannot be attached as a system disk.
400	InvalidInstance.NotOriginInstance	The specified disk can not attached to other instance as system disk.
400	InvalidParameterForce.DiskCategoryNotSupported	The specified disk category does not support force attach operation.	The specified disk category does not support force attach operation.
400	InvalidParameterForce.PrepaidDiskNotSupported	The prepaid disk does not support force attach operation.	The prepaid disk does not support force attach operation.
400	InvalidParameterForce.MultiAttachDiskNotSupported	The multi attach disk does not support force attach operation.	The multi attach disk does not support force attach operation.
400	InvalidParameterForce.RegionNotSupported	The specified region does not support force attach operation.	The specified region does not support force attach operation.
400	OperationConflict.DisksAttachingParallellyExceed	The number of disks attaching parallelly exceeds the limit.	The number of disks attaching parallelly exceeds the limit.
400	InvalidInstanceType.NotSupported	The specified instanceType is not supported by the image architecture.	The specified image schema does not support this instance type.
500	InternalError	The request processing has failed due to an internal error and you may retry later or contact support with the request ID.
403	InstanceDiskLimitExceeded	The number of disks attached to the instance has exceeded the limit.
403	InvalidDevice.InUse	The specified device has been occupied.
403	DiskNotPortable	The specified disk is not a portable disk.
403	InstanceLockedForSecurity	The instance is locked due to security.	The operation is not supported while the instance is locked for security reasons.
403	ResourcesNotInSameZone	The specified instance and disk are not in the same zone.
403	InstanceExpiredOrInArrears	The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode).
403	DiskInArrears	The specified operation is denied because the disk has overdue payments. Please settle the outstanding balance.
403	DiskError	IncorrectDiskStatus.
403	DiskId.ValueNotSupported	The specified parameter diskid is not supported.	The specified EBS device category does not support the operation.
403	DiskId.StatusNotSupported	The specified disk status is not supported.	The disk is in a state that does not support the current operation.
403	IncorrectInstanceStatus.NotSupportESSD	The operation is not supported in this status. Please reboot the instance.
403	IncorrectDiskStatus	The operation is not supported in this status.	The disk is in a state that does not support the current operation. Make sure that the disk is available and that your account has no overdue payments.
403	UserNotInTheWhiteList	The user is not in disk white list.	You are not authorized to manage the disk. Try again when you are authorized.
403	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be enabled.
403	InvalidParameter.KMSKeyId.CMKUnauthorized	The CMK has not authorized the ECS service to perform the KMS TagResource and UntagResource operations. Please verify the authorization and try again.
403	InvalidParameter.KMSKeyId.KMSUnauthorized	ECS service does not have permission to access your KMS key. Please verify that the specified KMS key has authorized the ECS service.
403	DependencyViolation.WindowsInstance	The instance image is Windows. SSH key pair login is not supported.
403	InvalidInstanceType.NotSupportDiskCategory	The instanceType of the specified instance does not support this disk category.	The instance type does not support the current disk category. Try another instance type. For information about the disk categories supported by instance types, see the instance family documentation.
403	InvalidInstanceType.NotSupportPL0	The instanceType of the specified instance does not support PL0 of cloud_essd.
403	InvalidInstanceType.NvmeRequired	The instanceType of the specified instance requires nvme protocol.	The instance type of the specified instance requires the NVMe protocol.
403	InvalidInstanceType.NvmeUnsupported	The instanceType of the specified instance does not support nvme protocol.	The instance type of the specified instance does not support the NVMe protocol.
403	InvalidInstanceType.NotSupportMultiAttachDisk	The instanceType of the specified instance does not support multi attach disk.	Disks for which the multi-attach feature is enabled cannot be attached to instances of the specified instance type.
403	DiskAttachedNumberExceeded	The attaching times of the specified disk exceeded.	The specified disk has reached the maximum number of instances to which it can be attached.
403	InvalidOperation.CanNotAttachMultiAttachDiskAsSystemDisk	Multi attach disk can not be attached as system disk.	Disks for which the multi-attach feature is enabled cannot be attached as system disks.
403	DeleteWithInstance.Conflict	Multi attach disk cannot be set to DeleteWithInstance attribute.	Disks for which the multi-attach feature is enabled do not support the DeleteWithInstance attribute.
403	InvalidParameter.DeleteWithInstance	The DeleteWithInstance for the elastic ephemeral disk must be set to true.	The DeleteWithInstance for the elastic ephemeral disk must be set to true.
403	InvalidOperation.OtherInstanceUnsupported	The elastic ephemeral disk can only be attached to the instance it was last mounted on. Please check the disk system tag to get the last associated instance.
403	InvalidInstance.ZoneConflict	The force attach operation is not supported when both the current and target instances are in the same zone.	Forced mount requires that the current instance and the target instance are in different zones
403	InvalidParameter.AllEmpty	The current operation requires either a password or a keyPairName to must be provided. Please ensure that at least one of them is not empty.	The current operation requires either a password or a keyPairName to must be provided. Please ensure that at least one of them is not empty.
403	InvalidOperation.DiskQueueNumberNotEnough	The number of disk queues on the instance is not enough.	The number of disk queues on the instance is not enough.
403	InvalidOperation.DiskAttachModeUnsupported	The instance type does not support the disk attach mode.	The instance type does not support the disk mount mode.
403	OperationDenied.HpnZoneMismatch	Instance and disk must be in the same HPN zone for restricted HPN zones.	Instance and disk must be in the same HPN zone for restricted HPN zones.
403	OperationDenied.UnsupportedEncryptedDisk	The instance type does not support attaching encrypted disks.	The instance type does not support attaching encrypted disks.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instanceId is invalid.
404	InvalidDiskId.NotFound	The specified disk does not exist.	The specified disk does not exist. Check whether the disk ID is correct.
404	InvalidDisk.InUse	The specified disk has been occupied.
404	DiskAttachedNumberExceeded	The attaching times of the specified disk exceeded.
404	InvalidKMSKeyId.NotFound	The KMS key used by the disk does not exist.	The KMS key used by the disk does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.