本接口用于批量刪除或者釋放按量付費實例或者到期的包年包月實例,支持通過參數(shù)設置決定云盤是否釋放或轉(zhuǎn)換為按量付費保留。
接口說明
警告
釋放實例后,實例所使用的物理資源都被回收,相關數(shù)據(jù)全部丟失且不可恢復。
釋放實例時,云盤的手動快照會被保留,實例上掛載的云盤和自動快照是否釋放取決于創(chuàng)建時的參數(shù)設置。釋放實例之前,您可以通過 DescribeDisks 查詢實例上掛載的云盤和自動快照的相關參數(shù)設置:
DeleteWithInstance=false
,云盤會被轉(zhuǎn)換成按量付費云盤而保留下來,否則會隨實例被釋放。DeleteAutoSnapshot=false
,自動快照被保留,否則會隨實例被釋放。
注意 被安全鎖定的實例,即使云盤的DeleteWithInstance參數(shù)設置為false,釋放實例時也會忽略這個屬性而釋放云盤。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關鍵字:是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
ecs:DeleteInstances | delete | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DryRun | boolean | 否 | 是否只預檢此次請求。
默認值:false。 | false |
Force | boolean | 否 | 是否強制釋放運行中(
默認值:false。 警告 強制釋放相當于斷電,實例內(nèi)存以及存儲中的臨時數(shù)據(jù)都會被擦除,無法恢復。 | false |
TerminateSubscription | boolean | 否 | 是否釋放已到期的包年包月實例。
默認值:false。 | false |
ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數(shù)值,確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符,且不能超過 64 個字符。更多信息,請參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-426655440000 |
RegionId | string | 是 | 實例所屬的地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
InstanceId | array | 是 | 實例 ID 數(shù)組。數(shù)組長度:1~100。 | |
string | 是 | 實例 ID。 | i-bp1g6zv0ce8oghu7**** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "7B7813C6-57BF-41XX-B12B-F172F65A6046"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameter.CrossRegionNotSupport | Instances of multiple regions not support. | - |
400 | DRYRUN.SUCCESS | This request is a dryrun request with successful result. | 您設置了預檢此次請求,并且檢查通過。 |
400 | DependencyViolation.SLBConfiguring | Specified operation is denied as your instance is using by another product. | 實例被 SLB 引用,且 SLB 正在配置。 |
400 | DependencyViolation.RouteEntry | Specified instance is used by route entry. | 當前專有網(wǎng)絡 VPC 還存在未刪除的自定義路由規(guī)則,刪除失敗。 |
403 | InvalidParameter.TooManyInstanceIds | Instance ids cannot be more than 100. | - |
403 | InvalidInstanceIds.ValueNotSupported | The specified instanceIds is not valid. | - |
403 | InvalidOperation.DeletionProtection | The operation is not allowed due to deletion protection. | 實例開啟了釋放保護,因此不能進行此操作 |
403 | InvalidOperation.DeletionProtection | %s | 該操作無效,請先取消該實例的釋放保護。 |
403 | ChargeTypeViolation | %s | - |
403 | IncorrectInstanceStatus.Initializing | %s | - |
403 | InvalidOperation.EniLinked | %s | 實例的當前彈性網(wǎng)卡關聯(lián)了其他彈性網(wǎng)卡,導致操作無效。需要解除關聯(lián)后才能從實例分離。 |
403 | IncorrectInstanceStatus | %s | 當前實例的狀態(tài)不支持此操作。 |
403 | InstanceLockedForSecurity | The specified operation is denied as your instance is locked for security reasons. | 實例被安全鎖定。 |
404 | InvalidInstanceIds.NotFound | The specified InstanceIds does not exist. | 指定的 InstanceId 不存在。請檢查 InstanceId 參數(shù)值是否正確。您可以調(diào)用 DescribeInstances 查詢指定實例的狀態(tài)。 |
404 | InvalidInstanceId.NotFound | %s | 指定的實例不存在,請確認參數(shù) InstanceId 是否正確。 |
500 | InvalidParameter | Invalid parameters. | 參數(shù)無效,可能由于參數(shù)格式錯誤或缺少必填參數(shù)所導致 |
500 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯誤,請重試。 |
500 | InternalError | %s | 內(nèi)部錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-07-17 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |