九游平台/ 弹性云服务器 ecs/ api参考/ api/ 状态管理/ 变更云服务器规格(按需)
更新时间:2024-11-14 gmt 08:00

变更云服务器规格(按需)-九游平台

功能介绍

当您创建的弹性云服务器规格无法满足业务需要时,可以变更云服务器规格,升级vcpu、内存。具体接口的使用,请参见本节内容。

本接口为异步接口,当前变更弹性云服务器规格请求下发成功后会返回job_id,此时变更弹性云服务器规格并没有立即完成,需要通过调用查询任务的执行状态查询job状态,当job状态为 success 时代表云服务器规格变更成功。

变更规格时,部分规格的之间不能互相变更。您可以参见查询云服务器规格变更支持列表查询支持列表。

接口约束

调试

您可以在中调试该接口。

uri

post /v1/{project_id}/cloudservers/{server_id}/resize

参数说明请参见表1
表1 参数说明

参数

是否必选

描述

project_id

项目id。

获取方法请参见获取项目id

server_id

云服务器id。

请求消息

请求参数如表2所示。
表2 请求参数

参数

是否必选

参数类型

描述

resize

object

标记为云服务器变更规格操作,详情请参见表3

dry_run

boolean

是否只预检此次请求。

true:发送检查请求,不会变更云服务器规格。检查项包括是否填写了必需参数、请求格式等。

  • 如果检查不通过,则返回对应错误。
  • 如果检查通过,则返回202状态码。

false:发送正常请求,通过检查后并且执行变更云服务器规格请求。

表3 resize数据结构说明

参数

是否必选

参数类型

描述

flavorref

string

变更后的云服务器规格id。

可能通过 查询云服务器规格变更支持列表 接口查询允许变更的规格列表。

mode

string

取值为withstopserver ,支持开机状态下变更规格。

mode取值为withstopserver时,对开机状态的云服务器执行变更规格操作,系统自动对云服务器先执行关机,再变更规格,变更成功后再执行开机。

cpu_options

object

自定义cpu选项。

详情请参见表4

表4 cpu_options数据结构说明

参数

是否必选

参数类型

描述

hw:cpu_threads

integer

用于控制cpu是否开启超线程。

取值范围:1,2。

  • 1: 关闭超线程。
  • 2: 打开超线程。

需要同时满足如下条件,才能设置为“关闭超线程”:

  • 只能在实例创建或者resize时指定。
  • 只有目标flavor的extra_specs参数:
    • 存在“hw:cpu_policy”并取值为“dedicated”。
    • 存在“hw:cpu_threads”并取值为“2”。

响应消息

请参考响应(任务类)

请求示例

变更云服务器的规格为“c3.15xlarge.2”。

post https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/resize
{
    "resize": {
        "flavorref": "c3.15xlarge.2"
    }
}

响应示例

{      
    "job_id": "ff80808288d41e1b018990260955686a" 
} 

返回值

请参考通用请求返回值

错误码

请参考错误码

相关文档

网站地图