变更云服务器规格(按需)
功能介绍
当您创建的弹性云服务器规格无法满足业务需要时,可以变更云服务器规格,升级vCPU、内存。具体接口的使用,请参见本节内容。
本接口为异步接口,当前变更弹性云服务器规格请求下发成功后会返回job_id,此时变更弹性云服务器规格并没有立即完成,需要通过调用查询任务的执行状态查询job状态,当Job状态为 SUCCESS 时代表云服务器规格变更成功。
变更规格时,部分规格的之间不能互相变更。您可以参见查询云服务器规格变更支持列表查询支持列表。
接口约束
- “XEN实例”变更为“KVM实例”时,需先手动配置弹性云服务器,安装对应的驱动,然后再变更规格,否则会变更失败。安装驱动的具体操作,请参见《弹性云服务器用户指南》的“变更规格 > XEN实例变更为KVM实例(Windows)、XEN实例变更为KVM实例(Linux-自动配置)、XEN实例变更为KVM实例(Linux-手动配置)”章节。
- 该接口不支持对包年/包月云服务器的规格进行变更操作,包年/包月云服务器规格变更请参考 变更云服务器规格 。
- 竞价实例不支持变更规格。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/cloudservers/{server_id}/resize
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
resize |
是 |
Object |
标记为云服务器变更规格操作,详情请参见表3。 |
dry_run |
否 |
Boolean |
是否只预检此次请求。 true:发送检查请求,不会变更云服务器规格。检查项包括是否填写了必需参数、请求格式等。
false:发送正常请求,通过检查后并且执行变更云服务器规格请求。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
flavorRef |
是 |
String |
变更后的云服务器规格ID。 可能通过 查询云服务器规格变更支持列表 接口查询允许变更的规格列表。 |
mode |
否 |
String |
取值为withStopServer ,支持开机状态下变更规格。 mode取值为withStopServer时,对开机状态的云服务器执行变更规格操作,系统自动对云服务器先执行关机,再变更规格,变更成功后再执行开机。 |
cpu_options |
否 |
Object |
自定义CPU选项。 详情请参见表4。 |
响应消息
请参考响应(任务类)。
请求示例
变更云服务器的规格为“c3.15xlarge.2”。
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/resize { "resize": { "flavorRef": "c3.15xlarge.2" } }
响应示例
{ "job_id": "ff80808288d41e1b018990260955686a" }
返回值
请参考通用请求返回值。
错误码
请参考错误码。