接口功能介绍
支持对一台处于关机状态的云主机进行带宽或规格的变更。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
成本估算：了解云主机的计费项
异步接口：该接口为异步接口，下单成功不代表业务成功。
接口约束
1. 确保当前请求资源池下，该云主机存在（即instanceID真实存在且与regionID相对应）
2. 云主机须处于关机（stopped）或节省关机（shelve）状态，您可以调用查询一台云主机详细信息或获取多台云主机的状态信息查询结果中的instanceStatus字段来确认当前云主机状态
3. 只可以选择变配带宽或者变配规格，不可同时修改带宽和云主机规格
4. 云主机变更规格时要满足冷变配规则
5. 变配云主机带宽需确保当前云主机绑定了弹性公网IP
6. 云主机已挂载的云硬盘状态必须处于“已挂载”
URI
POST /v4/ecs/update-instance-spec
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
88f8888888dd88ec888888888d888d8b | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| bandwidth | 否 | Integer | 带宽大小单位为Mbit/s，取值范围:[1~2000]。带宽与规格参数必须2选1，不支持同时传入带宽与规格 | 100 | |
| flavorID | 否 | String | 云主机规格ID，您可以查看规格说明了解弹性云主机的选型基本信息 获取： 查 查询一个或多个云主机规格资源 查 查询一个或多个云主机规格资源（旧版） 带宽与规格参数必须2选1，不支持同时传入带宽与规格 |
00ebe3aa-aac0-1d99-0b9e-4d391c5e06d5 | |
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时 | bdfse888-8ed8-88b8-88cb-888f8b8cf8fa |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1：变更带宽
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"instanceID": "39a90107-9144-a316-31ae-4a9aaed7e45d",
"bandwidth": 8,
"clientToken": "netresize3005"
}
示例2：变更规格
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName":"az1",
"instanceID": "3d697fce-dcf0-6fda-8131-4b5aa920c065",
"flavorID": "7fde1913-a1ac-1b4a-6d14-12783656f814",
"clientToken": "resize3005"
}
响应示例
{
"returnObj": {
"masterOrderNO": "20230316094954029559",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "d6d21b46c39c11edaf5d0242ac110002"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
