為一臺ECS實(shí)例掛載一塊按數(shù)據(jù)盤或系統(tǒng)盤。
接口說明
調(diào)用該接口時，您需要注意：
-
實(shí)例和磁盤必須在同一個可用區(qū)。
-
磁盤的狀態(tài)必須為待掛載（
Available）。 -
掛載數(shù)據(jù)盤時：
- 目標(biāo) ECS 實(shí)例必須處于運(yùn)行中（
Running）或者已停止（Stopped）狀態(tài)。 - 如果是您單獨(dú)購買的磁盤，計(jì)費(fèi)方式必須是按量付費(fèi)。
- 從 ECS 實(shí)例上卸載的系統(tǒng)盤作為數(shù)據(jù)盤掛載時，不限制計(jì)費(fèi)方式。
- 彈性臨時盤一旦卸載，只能重新掛載至其原始實(shí)例。
- 目標(biāo) ECS 實(shí)例必須處于運(yùn)行中（
-
掛載系統(tǒng)盤時：
- 目標(biāo) ECS 實(shí)例必須是卸載該系統(tǒng)盤時的源實(shí)例。
- 目標(biāo) ECS 實(shí)例必須處于已停止（
Stopped）狀態(tài)。 - 您必須設(shè)置實(shí)例登錄憑證。
- 彈性臨時盤不支持掛載為系統(tǒng)盤。
- 更多關(guān)于掛載系統(tǒng)盤的信息，請參見卸載或掛載系統(tǒng)盤。
-
查詢 ECS 實(shí)例信息時，如果返回數(shù)據(jù)中包含
{"OperationLocks": {"LockReason" : "security"}}，則禁止一切操作。 -
開啟多重掛載特性的云盤，只能掛載到支持 NVMe 協(xié)議的實(shí)例上。 更多信息，請參見ESSD 云盤支持 NVMe以及使用多重掛載功能。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:AttachDisk | update | *Disk acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}*Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 待掛載 ECS 實(shí)例的 ID。 | i-bp1dq5lozx5f4pmd**** |
| DiskId | string | 是 | 待掛載的磁盤 ID。磁盤（ 說明
支持掛載數(shù)據(jù)盤和系統(tǒng)盤，相關(guān)約束條件請參見上文接口說明部分。
| d-bp1j4l5axzdy6ftk**** |
| Device | string | 否 | 磁盤設(shè)備名稱。 說明
該參數(shù)即將被棄用，為提高兼容性，建議您盡量使用其他參數(shù)標(biāo)識磁盤。
| testDeviceName |
| DeleteWithInstance | boolean | 否 | 釋放實(shí)例時，該磁盤是否隨實(shí)例一起釋放。取值范圍：
默認(rèn)值：false。 設(shè)置該參數(shù)時，您需要注意：
| false |
| Bootable | boolean | 否 | 是否作為系統(tǒng)盤掛載。取值范圍：
默認(rèn)值：false。 說明
設(shè)置為 Bootable=true時，目標(biāo) ECS 實(shí)例必須處于無系統(tǒng)盤狀態(tài)。
| false |
| Password | string | 否 | 掛載系統(tǒng)盤時，設(shè)置實(shí)例的用戶名密碼，僅對 administrator 和 root 用戶名生效，其他用戶名不生效。長度為 8 至 30 個字符，必須同時包含大小寫英文字母、數(shù)字和特殊符號中的三類字符。特殊符號可以是： 其中，Windows 實(shí)例不能以斜線號（/）為密碼首字符。 說明
如果傳入 Password參數(shù)，建議您使用 HTTPS 協(xié)議發(fā)送請求，避免密碼泄露。
| EcsV587! |
| KeyPairName | string | 否 | 掛載系統(tǒng)盤時，為 Linux 系統(tǒng) ECS 實(shí)例綁定的 SSH 密鑰對的名稱。
| KeyPairTestName |
| Force | boolean | 否 | 是否是強(qiáng)制掛載請求。取值范圍：
默認(rèn)值：false。 說明
當(dāng)前僅 ESSD 同城冗余類型（cloud_regional_disk_auto）支持設(shè)置該字段為 true。
| false |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidDevice.Malformed | The specified device is not valid. | 指定的磁盤設(shè)備名不存在。 |
| 400 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | 該資源目前的狀態(tài)不支持此操作。 |
| 400 | InvalidParameter | The input parameter is mandatory for processing this request is empty. | 參數(shù)不能為空。 |
| 400 | InvalidRegionId.MalFormed | The specified RegionId is not valid. | 指定的地域不存在，請檢查該參數(shù)是否正確。 |
| 400 | InvalidOperation.InstanceTypeNotSupport | The instance type of the specified instance does not support hot attach disk. | 磁盤掛載的實(shí)例不支持磁盤熱插拔操作。 |
| 400 | DiskCategory.OperationNotSupported | The operation is not supported to the specified disk due to its disk category. | 由于磁盤種類限制，指定的磁盤不支持該操作。 |
| 400 | InvalidOperation.InstanceTypeNotSupport | The specified disk which has kms key should only attach to ioOptimized instance. | 指定的實(shí)例無效，只有I/O優(yōu)化類型的實(shí)例支持設(shè)置KMS Key。 |
| 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 | 您沒有輸入任何參數(shù)，請輸入必要的參數(shù)。 |
| 400 | InvalidParameterForce.DiskCategoryNotSupported | The specified disk category does not support force attach operation. | 指定的磁盤類型不支持強(qiáng)制掛載操作 |
| 400 | InvalidParameterForce.PrepaidDiskNotSupported | The prepaid disk does not support force attach operation. | 預(yù)付費(fèi)磁盤不支持強(qiáng)制掛載操作 |
| 400 | InvalidParameterForce.MultiAttachDiskNotSupported | The multi attach disk does not support force attach operation. | 多重掛載磁盤不支持強(qiáng)制掛載操作 |
| 400 | InvalidParameterForce.RegionNotSupported | The specified region does not support force attach operation. | 該地域不支持強(qiáng)制掛載操作 |
| 400 | OperationConflict.DisksAttachingParallellyExceed | The number of disks attaching parallelly exceeds the limit. | 并行掛載的磁盤個數(shù)超過限制 |
| 403 | InstanceDiskLimitExceeded | The amount of the disk on instance in question reach its limits. | 指定實(shí)例已經(jīng)達(dá)到可掛載磁盤的最大值。 |
| 403 | InvalidDevice.InUse | The specified device has been occupied. | 指定的設(shè)備已經(jīng)掛載了磁盤。 |
| 403 | IncorrectDiskStatus | %s | - |
| 403 | DiskNotPortable | The specified disk is not a portable disk. | 指定的磁盤不是可卸載的磁盤，Portable 為 false 的磁盤無法卸載。 |
| 403 | InstanceLockedForSecurity | The instance is locked due to security. | 您的資源被安全鎖定，拒絕操作。 |
| 403 | ResourcesNotInSameZone | The specified instance and disk are not in the same zone. | 指定的實(shí)例和磁盤不在同一可用區(qū)。 |
| 403 | InstanceExpiredOrInArrears | The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). | 實(shí)例已過期或者欠費(fèi)，請您續(xù)費(fèi)或者結(jié)清后再進(jìn)行操作。 |
| 403 | DiskInArrears | The specified operation is denied as your disk owing fee. | 指定的磁盤已欠費(fèi)。 |
| 403 | DiskError | IncorrectDiskStatus. | 指定的磁盤狀態(tài)不合法。 |
| 403 | DiskId.ValueNotSupported | The specified parameter diskid is not supported. | 指定的塊存儲類型不支持此操作。 |
| 403 | DiskId.StatusNotSupported | The specified disk status is not supported. | 當(dāng)前磁盤的狀態(tài)不支持此操作。 |
| 403 | IncorrectInstanceStatus.NotSupportESSD | The operation is not supported in this status, please reboot the instance. | 當(dāng)前實(shí)例狀態(tài)不支持ESSD類型磁盤的掛載操作 |
| 403 | IncorrectDiskStatus | The operation is not supported in this status. | 當(dāng)前的磁盤不支持此操作，請您確認(rèn)磁盤處于正常使用狀態(tài)，是否欠費(fèi)。 |
| 403 | UserNotInTheWhiteList | The user is not in disk white list. | 您不在磁盤白名單中，請加入白名單后重試。 |
| 403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | 加密云盤設(shè)置了 KMSKeyId 后，CMK必須處于啟用狀態(tài)。您可以調(diào)用密鑰管理服務(wù)的 DescribeKey 接口查詢指定CMK的相關(guān)信息。 |
| 403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The CMK needs to be added ECS tag. | CMK 未授權(quán) |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS 服務(wù)無權(quán)訪問您的 KMS。 |
| 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. | 指定的實(shí)例規(guī)格（InstanceType）不支持當(dāng)前實(shí)例的云盤類別。請嘗試更換其它實(shí)例規(guī)格。關(guān)于實(shí)例規(guī)格支持的云盤類型，請參見實(shí)例規(guī)格族文檔。 |
| 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. | 指定實(shí)例的規(guī)格要求使用 NVMe 協(xié)議。 |
| 403 | InvalidInstanceType.NvmeUnsupported | The instanceType of the specified instance does not support nvme protocol. | 指定實(shí)例的規(guī)格不支持 NVMe 協(xié)議。 |
| 403 | InvalidInstanceType.NotSupportMultiAttachDisk | The instanceType of the specified instance does not support multi attach disk. | 指定的實(shí)例規(guī)格不支持掛載開啟多重掛載特性的云盤。 |
| 403 | DiskAttachedNumberExceeded | The attaching times of the specified disk exceeded. | 指定的云盤所掛載的實(shí)例數(shù)量已達(dá)上限。 |
| 403 | InvalidOperation.CanNotAttachMultiAttachDiskAsSystemDisk | Multi attach disk can not be attached as system disk. | 開啟多重掛載特性的云盤不支持作為系統(tǒng)盤使用。 |
| 403 | DeleteWithInstance.Conflict | Multi attach disk cannot be set to DeleteWithInstance attribute. | 開啟多重掛載特性的云盤不支持設(shè)置 DeleteWithInstance。 |
| 403 | InvalidParameter.DeleteWithInstance | The DeleteWithInstance for the elastic ephemeral disk must be set to true. | 彈性臨時盤的 DeleteWithInstance 屬性必須設(shè)置為 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. | 彈性臨時盤僅能被掛載到上一次掛載的實(shí)例，請檢查磁盤的系統(tǒng) Tag 來獲取上一次的實(shí)例。 |
| 403 | InvalidInstance.ZoneConflict | The force attach operation is not supported when both the current and target instances are in the same zone. | 強(qiáng)制掛載要求當(dāng)前實(shí)例與目標(biāo)實(shí)例處于不同可用區(qū) |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的InstanceId不存在。 |
| 404 | InvalidDiskId.NotFound | The specified disk does not exist. | 指定的磁盤不存在。請您檢查磁盤 ID 是否正確。 |
| 404 | InvalidDisk.InUse | The specified disk has been occupied. | 指定的磁盤已占用。 |
| 404 | InvalidKMSKeyId.NotFound | The KMS key used by the disk does not exist. | 磁盤使用的 KMS 密鑰不存在. |
| 500 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯誤，請重試。 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內(nèi)部錯誤，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-11-27 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-07-08 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-05-08 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-11-24 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |