变更云服务器规格
功能介绍
变更云服务器规格。
本接口为异步接口,当前变更弹性云服务器规格请求下发成功后会返回job_id,此时变更弹性云服务器规格并没有立即完成,需要通过调用查询任务的执行状态查询job状态,当Job状态为 SUCCESS 时代表云服务器规格变更成功。
V1.1版本变更云服务器规格的接口兼容了V1版本变更云服务器规格(按需)的功能,同时合入新功能,支持包年/包月的弹性云服务器。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1.1/{project_id}/cloudservers/{server_id}/resize
请求消息
名称 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
resize |
是 |
Object |
参数解释: 标记为云服务器变更规格操作,详情参见 表3。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
dry_run |
否 |
Boolean |
参数解释: 是否预检此次请求。配置为预检时,此次请求不会创建实例。 约束限制: 不涉及 取值范围:
默认取值: false |
名称 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
flavorRef |
是 |
String |
参数解释: 变更后的云服务器规格ID。 可以通过 查询云服务器规格变更支持列表 接口查询允许变更的规格列表。 约束限制:
取值范围: 不涉及 默认取值: 不涉及 |
dedicated_host_id |
否 |
String |
参数解释: 新专属主机ID。 约束限制: 仅对于部署在专属主机上的弹性云服务器,该参数必选。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
extendparam |
否 |
Object |
参数解释: 变更云服务器扩展信息,详情参见 表4。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
mode |
否 |
String |
参数解释: 支持开机状态下变更规格。 约束限制: 不涉及 取值范围: mode取值为withStopServer时,对开机状态的云服务器执行变更规格操作,系统自动对云服务器先执行关机,再变更规格,变更成功后再执行开机。 默认取值: 不涉及 |
cpu_options |
否 |
Object |
参数解释: 自定义CPU选项。 详情请参见表5。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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" }, "mode": "withStopServer" } }
响应示例
{ "job_id": "ff80808288d41e1b018990260955686a" }
或
{ "order_id": "CS1711152257C60TL", "job_id": "ff80808288d41e1b018990260955686a" }
或
{ "error": { "message": "XXXX", "code": "XXX" } }
返回值
请参考通用请求返回值。
错误码
请参考错误码。