Attaches a pay-as-you-go data disk or a system disk to an Elastic Compute Service (ECS) instance. The instance and the disk must reside in the same zone.
Operation description
Usage notes
Take note of the following items:
-
The disk must be in the Unattached (
Available) state. -
When you attach the disk as a data disk to an ECS instance, take note of the following items:
- The ECS instance must be in the Running (
Running) or Stopped (Stopped) state. - If the disk was separately purchased, the billing method of the disk must be pay-as-you-go.
- If the disk is a system disk that was detached from an ECS instance, no limits apply to the billing method of the disk.
- If the disk is an elastic ephemeral disk that was detached from an ECS instance, the disk can be attached only to the instance.
- The ECS instance must be in the Running (
-
When you attach the disk as the system disk to an ECS instance, take note of the following items:
- The ECS instance must be the original instance from which the system disk was detached.
- The ECS instance must be in the Stopped (
Stopped) state. - Logon credentials must be configured.
- The disk cannot be an elastic ephemeral disk.
-
If the response contains
{"OperationLocks": {"LockReason" : "security"}}when you query information about an ECS instance, the instance is locked for security reasons and no operations are allowed on the instance.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the instance to which you want to attach the disk. | i-bp1dq5lozx5f4pmd**** |
| DiskId | string | Yes | The ID of the disk. The disk specified by Note
For more information about the limits on attaching a data disk and a system disk, see the "Usage notes" section of this topic.
| d-bp1j4l5axzdy6ftk**** |
| Device | string | No | The device name of the disk. Note
This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility.
| testDeviceName |
| DeleteWithInstance | boolean | No | Specifies whether to release the disk when the instance is released.
Default value: false. When you specify this parameter, take note of the following items:
| false |
| Bootable | boolean | No | Specifies whether to attach the disk as a system disk. Default value: false. Note
You can set Bootable to true only if the instance does not have a system disk.
| false |
| Password | string | No | The password that is set when you attach the system disk. The password is applicable only to the administrator and root users. 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, passwords cannot start with a forward slash (/). Note
If Password is configured, we recommend that you send requests over HTTPS to prevent password leaks.
| EcsV587! |
| KeyPairName | string | No | The name of the SSH key pair that you bind to the Linux instance when you attach the system disk.
| KeyPairTestName |
| Force | boolean | No | Specifies whether to forcefully attach the disk to the instance.
Default value: false. | false |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. | The specified disk device name does not exist. |
| 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. | The specified region does not exist. |
| 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 | InvalidOperation.InstanceTypeNotSupport | The specified disk which has kms key should only attach to ioOptimized instance. | The specified instance is invalid. You can set Key Management Service (KMS) keys only for I/O optimized instances. |
| 400 | InvalidDisk.DiskNotBootable | The specified disk is not a bootable disk, can not be attached as system disk. | - |
| 400 | InvalidInstance.NotOriginInstance | The specified disk can not attached to other instance as system disk. | - |
| 400 | InvalidParameter.AllEmpty | %s | The required parameters are not specified. |
| 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. |
| 403 | InstanceDiskLimitExceeded | The amount of the disk on instance in question reach its limits. | The specified instance has reached the maximum number of disks that can be attached to it. |
| 403 | InvalidDevice.InUse | The specified device has been occupied. | The specified device has been occupied. |
| 403 | IncorrectDiskStatus | %s | - |
| 403 | DiskNotPortable | The specified disk is not a portable disk. | The specified disk is not removable. |
| 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. | 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). | The subscription instance has expired. You must renew the instance before you can proceed. |
| 403 | DiskInArrears | The specified operation is denied as your disk owing fee. | Your account has overdue payments for the specified disk. |
| 403 | DiskError | IncorrectDiskStatus. | The disk state is invalid. |
| 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. | The customer master key (CMK) is not enabled when KMSKeyId is specified for an encrypted disk. You can call the DescribeKey operation of KMS to query information about the specified CMK. |
| 403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The CMK needs to be added ECS tag. | - |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS is not authorized to access your KMS resources. |
| 403 | DependencyViolation.WindowsInstance | The instance image is windows, cannot use ssh key pair to login. | - |
| 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's system tag to get the last associated instance. | The elastic ephemeral disk can only be attached to the instance it was last mounted on, please check the disk's 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 |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | The specified instance does not exist. |
| 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. | The specified disk is already in use. |
| 404 | InvalidKMSKeyId.NotFound | The KMS key used by the disk does not exist. | The KMS key used by the disk does not exist. |
| 500 | InternalError | The request processing has failed due to some unknown error. | An internal error has occurred. Try again later. |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error has occurred. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-08 | The Error code has changed | View Change Details |
| 2024-05-08 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-11-24 | The Error code has changed | View Change Details |