云主机修改带宽或规格
接口功能介绍
支持对一台已经关机中的云主机进行带宽或规格的变更
接口约束
- 目标云主机处于关机或节省关机状态,仅支持具有弹性公网IP的云主机进行带宽变更
- 云主机变更规格时要满足冷变配规则
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/flavor-network-update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表。 | 88f8888888dd88ec888888888d888d8b | |
azName | 否 | String | 可用区名称。您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default)。 | az1 | |
ID | 是 | String | 云主机ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
bandWidth | 否 | Integer | 带宽大小单位为Mbit/s,取值范围:[1~2000]。不支持同时传入带宽与规格。 | 100 | |
flavorID | 否 | String | 云主机规格名称。不支持同时传入带宽与规格。 | s7.medium.4 | |
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,其他请求参数相同时,则代表为同一个请求。保留时间为24小时 | bdfse888-8ed8-88b8-88cb-888f8b8cf8fa |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误信息 | ||
description | String | 失败时的错误描述 | ||
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 主订单ID。调用方在拿到masterOrderID之后,可以使用materOrderID进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
masterOrderNO | String | 订单号 | 20221010142913884246 | |
regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
请求示例
请求头header
无
请求体body
变更带宽示例
{
"regionID": "a6449feab4db11e9a6b40242ac110007",
"ID": "93366056-b08f-4b9b-8e47-c50d92f2d4fd",
"bandWidth": 100,
"clientToken": "ea1b9004-f450-11ec-8d4f-00155de3fd73"
}
变更规格示例
{
"regionID": "a6449feab4db11e9a6b40242ac110007",
"ID": "93366056-b08f-4b9b-8e47-c50d92f2d4fd",
"flavorID":"s7.medium.2",
"clientToken": "ea1b9004-f450-11ec-8d4f-00155de3fd73"
}
响应示例
{
"returnObj": {
"masterOrderNO": "20221021135259672088",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "819a1df4491211edaf0c0242ac110002"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.Parameter.InvalidAzName | 资源池中不存在该azName,请确认azName是否有效 |
Openapi.PermissionAdmin.AccessFailed | 查询用户许可信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.PermissionAdmin.FormatError | 查询用户资源池许可信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.PermissionCheck.UnknowError | 查询用户许可信息失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.StatusNotValid | 当前云主机状态不可进行操作,请确认云主机状态 |
Ecs.OrderCheck.InvalidBandwidth | 带宽范围1Mbit/s--2000Mbit/s,请输入有效的带宽大小 |
Ecs.Flavor.NoChange | 规格没有发生变化,请输入有效的规格ID |
Openapi.FlavorAdmin.AccessFailed | 查询云主机规格失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.FlavorAdmin.FormatError | 查询云主机规格信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Ecs.Flavor.NotFound | 未找到规格信息,请确定规格ID是否正确 |
Ecs.Flavor.QueryFail | 查询支持的变配规格失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Flavor.ZoneNotSame | 云主机规格与云主机不在同一个可用区,请重新输入有效的规格ID |
Ecs.Flavor.NotSupport | 不支持变配到此规格,请重新输入有效的规格ID |
Ecs.UserQuota.AccessFailed | 查询用户配额信息失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserQuota.Empty | 查询用户配额信息为空,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserQuota.DataDamaged | 查询用户配额信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserConsumption.AccessFailed | 查询用户已用资源量失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserConsumption.Empty | 用户已用资源量信息为空,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserConsumption.DataDamaged | 用户已用资源信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.OrderCheck.CpuQuotaLimited | 实例规格vcpu配额不足,请提工单 |
Ecs.OrderCheck.MemoryQuotaLimited | 实例规格内存配额不足,请提工单 |
Ecs.OrderCheck.ResourceUpgradeLimited | 一次只能升级一个资源,不能批量升级 |
Ecs.Instance.FlavorSoldOut | 该规格云主机已售罄,请提交工单 |
Ecs.Order.ProcFailed | 订单处理失败 |