輕量型云主機退訂數據盤
更新時間 2024-12-13 18:57:28
最近更新時間: 2024-12-13 18:57:28
分享文章
輕量型云主機退訂數據盤
接口功能介紹
該接口提供用戶退訂一臺輕量型云主機數據盤功能
準備工作：
??構造請求：在調用前需要了解如何構造請求，詳情查看構造請求
??認證鑒權：openapi請求需要進行加密調用，詳細查看認證鑒權
注意事項：
??釋放前請確保文件已進行備份，釋放后不可恢復。
接口約束
??1. 使用限制，本接口只支持在部分資源池進行公測
??2. 確保當前請求資源池下，該云主機存在（即instanceID真實存在且與regionID相對應）
??2. 確保云硬盤掛載在本云主機，并且云硬盤沒有快照
??3. 云主機需要處于關機狀態（stopped）或者運行狀態（running），您可以調用查詢結果中的instanceStatus字段來確認當前云主機狀態
??4. 只有數據盤支持卸載操作，系統盤不支持卸載
URI
POST /v4/ecs/lite/unsubscribe-volume
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客戶端存根，用于保證訂單冪等性。要求單個云平臺賬戶內唯一，使用同一個ClientToken值，其他請求參數相同時，則代表為同一個請求。保留時間為24小時 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| regionID | 是 | String | 資源池ID，您可以查看地域和可用區來了解資源池 獲取： 查 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceID | 是 | String | 云主機ID，您可以查看彈性云主機了解云主機的相關信息 獲取： 查 創 |
adc614e0-e838-d73f-0618-a6d51d09070a | |
| diskID | 是 | String | 云硬盤ID | 26eea80d-a232-470c-9b39-df512825eb3d |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗） | 800 | |
| errorCode | String | 錯誤碼，為product.module.code三段式碼 | Openapi.PatternCheck.NotValid | |
| error | String | 錯誤碼，為product.module.code三段式碼 | Openapi.PatternCheck.NotValid | |
| message | String | 失敗時的錯誤描述，一般為英文描述 | SUCCESS | |
| description | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 成功時返回的數據 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| masterOrderID | String | 訂單ID。調用方在拿到masterOrderID之后，在若干錯誤情況下，可以使用materOrderID進一步確認訂單狀態及資源狀態 | 235145e4489811eda8330242ac110002 | |
| masterOrderNO | String | 訂單號 | 20221010142913884246 | |
| regionID | String | 資源所屬資源池ID | aaf589124d5d11eaa04d0242ac110002 |
請求示例
請求頭header
無
請求體body
{
"regionID": "aaf589124d5d11eaa04d0242ac110002",
"instanceID": "755a72c6-ea40-ce04-7ad8-c9f54d38ccfd",
"diskID":"26eea80d-a232-470c-9b39-df512825eb3d",
"clientToken": "502447b1-f894-44ae-ad0d-401bbfb4a134"
}
響應示例
{
"returnObj": {
"masterOrderNO": "20230712111010262171",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"masterOrderID": "022c6b9ea56a42af8fa7eb36957ff600"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
| LiteEcs.RegionInfo.Empty | 查詢資源池信息為空或資源池不存在，請確認資源池ID是否有效 |
| LiteEcs.RegionInfo.AccessFailed | 查詢資源池失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.RegionInfo.DataDamaged | 查詢資源池信息不符預期，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.RegionVersion.NotSupport | 當前API不支持該資源池，請切換資源池重試 |
| LiteEcs.UserVisibleRegions.DataDamaged | 查詢用戶可見資源池信息格式錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.UserVisibleRegions.AccessFailed | 查詢用戶可見資源池失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.Parameter.InvalidRegionID | 可見資源池信息為空，請確認regionID是否正確 |
| Openapi.EcsWorkorder.AccessFailed | 查詢云主機失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.Instance.NotFound | 云主機不存在，請確認云主機ID是否有效 |
| LiteEcs.Instance.StatusNotValid | 云主機%s沒有處于%s狀態之一，請再次確認云主機狀態 |
| Openapi.EcsCheck.UnknownError | 云主機%s檢查資源失敗 |
| Ecs.Volume.SnapshotExisted | 跟隨云主機創建的云硬盤存在快照，不允許該操作 |
| LiteEcs.EcsWorkorder.AccessFailed | 查詢云主機資源失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.VolumeCheck.NotFound | 查詢云硬盤結果為空 |
| LiteEcs.EbsCheck.NotSupported | 系統盤不支持 |
