接口功能介绍
该接口提供云主机热变配功能,即开机状态实现变更规格
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
确认当前云主机是否可进行热变配,您可以通过接口查询云主机支持的热变配规格信息获取当前云主机是否可以进行热变配,以及可以热变配规格信息
代金券:只支持预付费用户抵扣包周期资源的金额,且不可超过包周期资源的金额
热变配当前支持规格和镜像信息为(不同资源池下的镜像和规格支持情况不同,以查询云主机支持热变配规格信息接口的返回值为准):
支持的云主机镜像:
CentOS:CentOS 7.6 64位、CentOS 7.8 64位、CentOS 7.9 64位、CentOS 8.0 64位、CentOS 8.1 64位、CentOS 8.2 64位、CentOS 8.4 64位
CTyunOS:CTyunOS 2.0.1-21.06.4 64位、CTyunOS 3-23.01 64位
KylinOS:KylinOS V10 SP1 64位、KylinOS V10 SP2 64位
其他:openEuler 22.03 SP2 64位、UnionTechOS V20 1050u1e 64位
支持的云主机规格:
除二代机以外的规格且vcpu≥32
接口约束
1. 只支持升级规格,且不支持跨代升配(例如,原本云主机规格为m6.large.8,不可以变配为m7.xlarge.8)
2. 对于存量的云主机(2023年12月31日以前创建的云主机),无法使用当前功能
3. 同代升配能否支持取决于numa拓扑,以及CPU和内存均不能变小且至少有一个变大。
4. 当前云主机处于开机状态
5. 当前接口只支持华东1资源池
6. 云主机已挂载的云硬盘状态必须处于“已挂载”
URI
POST /v4/ecs/live-resize
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
41f64827f25f468595ffa3a5deb5d15d | |
instanceID | 是 | String | 云主机ID,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
285010af-16f1-137e-06c0-920d4bdd0026 | |
flavorID | 是 | String | 云主机规格ID,您可以查看规格说明了解弹性云主机的选型基本信息 获取: 查 查询云主机支持的热变配规格信息 |
s2.small.1或00ebe3aa-aac0-1d99-0b9e-4d391c5e06d5 | |
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,则代表为同一个请求。保留时间为24小时 | resize3003 | |
payVoucherPrice | 否 | Float | 代金券,满足以下规则: 两位小数,不足两位自动补0,超过两位小数无效; 不可为负数; 注:字段为0时表示不使用代金券,默认不使用 |
20.55 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 具体错误码标志 | ||
message | String | 失败时的错误信息 | ||
description | String | 失败时的错误描述 | ||
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 主订单ID。调用方在拿到masterOrderID之后,可以使用materOrderID进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
masterOrderNO | String | 订单号 | 20221010142913884246 | |
regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"instanceID": "285010af-16f1-137e-06c0-920d4bdd0026",
"flavorID": "7fde1913-a1ac-1b4a-6d14-12783656f814",
"clientToken": "resize3003",
"payVoucherPrice": 10.00
}
响应示例
{
"returnObj": {
"masterOrderNO": "20231017113043376539",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "8cc708186c9d11eeb6a30242ac110017"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码