变更云服务器规格(V1.1)
功能介绍
变更云服务器规格。
本接口为异步接口,当前变更弹性云服务器规格请求下发成功后会返回job_id,此时变更弹性云服务器规格并没有立即完成,需要通过调用查询任务的执行状态查询job状态,当Job状态为 SUCCESS 时代表云服务器规格变更成功。
接口约束
- 关机状态的弹性云服务器才能执行变更云服务器规格操作。
- 变更后的规格(内存、CPU)不能小于变更前的规格。
URI
POST /v1.1/{project_id}/cloudservers/{server_id}/resize
|
参数 |
是否必选 |
描述 |
|---|---|---|
|
project_id |
是 |
项目ID。 获取方法请参见获取项目ID。 |
|
server_id |
是 |
云服务器ID。 云服务器的ID可以从控制台或者参考《弹性云服务器接口参考》的“查询云服务器列表”的章节获取。 |
请求消息
|
名称 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resize |
是 |
Object |
标记为云服务器变更规格操作,详情参见 表3。 |
|
dry_run |
否 |
Boolean |
是否只预检此次请求。 true:发送检查请求,不会变更云服务器规格。检查项包括是否填写了必需参数、请求格式等。
false:发送正常请求,通过检查后并且执行变更云服务器规格请求。 |
|
名称 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
flavorRef |
是 |
String |
变更后的云服务器规格ID。 可以通过 查询云服务器规格变更支持列表 接口查询允许变更的规格列表。
说明:
|
|
dedicated_host_id |
否 |
String |
新专属主机ID。 仅对于部署在专属主机上的弹性云服务器,该参数必选。 |
|
extendparam |
否 |
Object |
变更云服务器扩展信息,详情参见 表4。 |
响应消息
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
job_id |
否 |
String |
任务ID。 查询job状态请参见查询任务的执行状态。 |
|
order_id |
否 |
String |
订单号。 |
请求示例
变更专属主机上的云服务器的规格为“s3.large.2”,自动支付且支持开机状态下变更规格。
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"
},
}
}
响应示例
{
"job_id": "ff80808288d41e1b018990260955686a"
}
或
{
"order_id": "CS1711152257C60TL",
"job_id": "ff80808288d41e1b018990260955686a"
}
或
{
"error": {
"message": "XXXX",
"code": "XXX"
}
}
返回值
请参考通用请求返回值。
错误码
请参考错误码。