云主机修改规格
接口功能介绍
支持对一台处于关机状态的云主机进行规格变更
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
成本估算:了解云主机的计费项
异步接口:该接口为异步接口,下单成功不代表业务成功。
接口约束
1. 确保当前请求资源池下,该云主机存在(即instanceID真实存在且与regionID相对应)
2. 云主机须处于关机(stopped)或节省关机(shelve)状态,您可以调用查询一台云主机详细信息或获取多台云主机的状态信息查询结果中的instanceStatus字段来确认当前云主机状态
3. 不同代系只支持规格向上变配
4. 同代系支持向下变配
URI
POST /v4/ecs/update-flavor-spec
路径参数
无
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 | 业务细分码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述。 | Param is null | |
description | String | 失败时的错误描述,一般为中文描述。 | 请求为空 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 主订单ID。调用方在拿到masterOrderID之后,可以使用materOrderID进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
masterOrderNO | String | 订单号 | 20221010142913884246 | |
regionID | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"instanceID":"285010af-16f1-137e-06c0-920d4bdd0026",
"flavorID":"7fde1913-a1ac-1b4a-6d14-12783656f814",
"clientToken": "resize3003",
"payVoucherPrice": 10.00
}
响应示例
{
"returnObj": {
"masterOrderNO": "20230316094954029559",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "d6d21b46c39c11edaf5d0242ac110002"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | 描述 |
---|---|
Ecs.OrderCheck.OnlySupportOndemand | 仅支持调整按需实例 |
Ecs.OrderCheck.CpuQuotaLimited | 实例规格vcpu配额不足 |
Ecs.OrderCheck.MemoryQuotaLimited | 实例规格内存配额不足 |
Ecs.Order.ProcFailed | 订单处理失败 |
Ecs.Flavor.NotFound | 未找到规格信息 |
Ecs.Instance.NotFound | 云主机不存在,请确认云主机ID是否有效 |
Ecs.Instance.FlavorSoldOut | 该规格云主机已售罄,请提交工单 |
Openapi.PatternCheck.NotValid | 请求参数无效。 |
Ecs.Instance.StatusNotValid | 只有关机状态才可以进行此操作 |
Ecs.Flavor.ZoneNotSame | 云主机规格与云主机不在同一个可用区,请重新输入有效的规格ID |
Ecs.Flavor.NotSupport | 仅允许变配到同代系规格,请重新输入有效的规格ID |
Ecs.Flavor.NoChange | 规格没有发生变化 |
Ecs.Eip.CheckFailed | 校验云主机弹性IP失败 |
Ecs.Order.UserFrozen | 用户受限,可能是被冻结的账户,或者余额不足 |