續訂一臺包周期的輕量型云主機
更新時間 2024-12-13 18:34:31
最近更新時間: 2024-12-13 18:34:31
分享文章
續訂一臺包周期的輕量型云主機
接口功能介紹
該接口提供用戶續訂一臺包年或者包月的輕量型云主機功能。
URI
POST /v4/ecs/lite/resubscribe
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客戶端存根,用于保證訂單冪等性。要求單個云平臺賬戶內唯一,使用同一個ClientToken值,其他請求參數相同時,則代表為同一個請求。保留時間為24小時 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| regionID | 是 | String | 資源池ID,您可以調用查看最新的天翼云資源池列表 | 88f8888888dd88ec888888888d888d8b | |
| instanceID | 是 | String | 云主機ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| cycleCount | 是 | Integer | 訂購時長 | 6 | |
| cycleType | 是 | String | 訂購周期類型 ,取值范圍:[MONTH=按月,YEAR=按年],最長續訂周期為3年 | MONTH |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為失敗) | 800 | |
| errorCode | String | 業務細分碼,為product.module.code三段式碼,詳見錯誤碼說明 | Openapi.PatternCheck.NotValid | |
| message | String | 失敗時的錯誤描述,一般為英文描述 | SUCCESS | |
| description | String | 失敗時的錯誤描述,一般為中文描述 | 成功 | |
| returnObj | Object | 成功時返回的數據 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| masterOrderID | String | 訂單ID。調用方在拿到masterOrderID之后,在若干錯誤情況下,可以使用materOrderID進一步確認訂單狀態及資源狀態。 | 20230712101502980592 | |
| masterOrderNO | String | 訂單號 | e87ff7ea205911ee983e0242ac110012 | |
| regionID | String | 資源所屬資源池ID | 41f64827f25f468595ffa3a5deb5d15d |
請求示例
請求頭header
無
請求體body
{
"clientToken": "8f924f6970fc09c1b469d7b96d1cjkl",
"regionID": "81f7728662dd11ec810800155d307d5b",
"instanceID": "a13693b6-e531-4c25-4642-63dcb41941ff",
"cycleType": "MONTH",
"cycleCount": 10
}
響應示例
{
"returnObj": {
"masterOrderNO": "20230712101502980592",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"masterOrderID": "e87ff7ea205911ee983e0242ac110012"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
| 錯誤碼 | 描述 |
|---|---|
| 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.CustomerAdmin.AccessFailed | 查詢用戶信息錯誤,請重試。如果多次嘗試失敗,請提交工單 |
| Openapi.CustomerAdmin.FormatError | 查詢用戶信息格式錯誤,請重試。如果多次嘗試失敗,請提交工單 |
| Openapi.CustomerCheck.UnknownError | 查詢用戶信息失敗,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.UserDetail.AccessFailed | 查詢用戶詳情信息失敗,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.UserDetail.Empty | 查詢用戶詳情信息為空,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.UserDetail.DataDamaged | 查詢用戶詳情信息不符預期,請重試。如果多次嘗試失敗,請提交工單 |
| Openapi.EcsWorkorder.AccessFailed | 查詢云主機失敗,請重試。如果多次嘗試失敗,請提交工單 |
| Openapi.EcsFormat.FormatError | 查詢云主機信息格式錯誤,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.Instance.NotFound | 云主機不存在,請確認云主機ID是否有效 |
| Openapi.EcsCheck.UnknownError | 云主機檢查失敗,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.Instance.OrderInfoNotExists | 查不到實例的訂單信息,請確認 |
| Openapi.Workorder.AccessFailed | 資源訂單信息數據異常,請重試。如果多次嘗試失敗,請提交工單 |