華為云計算 云知識 變更云服務器規(guī)格ResizeServer
變更云服務器規(guī)格ResizeServer

 

功能介紹

變更 云服務器 規(guī)格。

V1.1版本變更云服務器規(guī)格的接口兼容了V1版本變更云服務器規(guī)格(按需)的功能,同時合入新功能,支持包年/包月的彈性云服務器。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

POST /v1.1/{project_id}/cloudservers/{server_id}/resize

表1 參數(shù)說明

參數(shù)

是否必選

描述

project_id

項目ID。

獲取方法請參見獲取項目ID

server_id

云服務器ID。

云服務器的ID可以從控制臺或者參考“查詢云服務器列表”的章節(jié)獲取。

請求消息

表2 參數(shù)說明

名稱

是否必選

參數(shù)類型

描述

resize

Object

標記為云服務器變更規(guī)格操作,詳情參見 表3。

dry_run

Boolean

是否只預檢此次請求。

true:發(fā)送檢查請求,不會變更云服務器規(guī)格。檢查項包括是否填寫了必需參數(shù)、請求格式等。

  • 如果檢查不通過,則返回對應錯誤。
  • 如果檢查通過,則返回202狀態(tài)碼。

false:發(fā)送正常請求,通過檢查后并且執(zhí)行變更云服務器規(guī)格請求。

表3 resize數(shù)據(jù)結(jié)構(gòu)說明

名稱

是否必選

參數(shù)類型

描述

flavorRef

String

變更后的云服務器規(guī)格ID。

可以通過 查詢云服務器規(guī)格變更支持列表 接口查詢允許變更的規(guī)格列表。

說明:
  • 不支持變更至同一規(guī)格。

dedicated_host_id

String

專屬主機 ID。

僅對于部署在專屬主機上的彈性云服務器,該參數(shù)必選。

extendparam

Object

變更云服務器擴展信息,詳情參見 表4。

mode

String

取值為withStopServer ,支持開機狀態(tài)下變更規(guī)格。

mode取值為withStopServer時,對開機狀態(tài)的云服務器執(zhí)行變更規(guī)格操作,系統(tǒng)自動對云服務器先執(zhí)行關(guān)機,再變更規(guī)格,變更成功后再執(zhí)行開機。

表4 extendparam數(shù)據(jù)結(jié)構(gòu)說明

名稱

是否必選

參數(shù)類型

描述

isAutoPay

String

下單訂購后,是否自動從客戶的賬戶中支付,而不需要客戶手動去進行支付。

  • “true”:是(自動支付)
  • “false”:否(需要客戶手動支付)
說明:

當彈性云服務器是按包年包月計費時生效,該值為空時默認為客戶手動支付。

響應消息

表5 參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

描述

job_id

String

任務ID,變更按需的彈性云服務器規(guī)格時返回該參數(shù)。

查詢job狀態(tài)請參見查詢?nèi)蝿盏膱?zhí)行狀態(tài)

order_id

String

訂單號,變更包年包月的彈性云服務器規(guī)格時返回該參數(shù)。

請求示例

變更專屬主機上的云服務器的規(guī)格為“s3.large.2”,自動支付且支持開機狀態(tài)下變更規(guī)格。

POST https://{endpoint}/v1.1/{project_id}/cloudservers/{server_id}/resize

{
    "resize": {
        "flavorRef": "s3.large.2",
        "dedicated_host_id": "459a2b9d-804a-4745-ab19-a113bb1b4ddc",
        "extendparam":{
             "isAutoPay": "true"
        },
        "mode": "withStopServer"
    }
}

響應示例

{
    "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}

{
    "order_id": "CS1711152257C60TL",
    "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}

{
    "error": {
        "message": "XXXX", 
        "code": "XXX"
    }
}

返回值

請參考通用請求返回值。

錯誤碼

請參考錯誤碼。