ModifyInstanceBandwidth

1. 接口描述

调用本接口用于修改虚拟机实例的公网出口带宽。

注意事项

• 仅实例状态处于RUNNING状态，接口才能调用。

• 若实例的internetChargeType为ByBandwidth：

  • 实例的instanceChargeType为PREPAID：

    • 升配（target > cur）会生成待支付的订单，需要扣除本次升配的费用，立即生效。

    • 降配（target < cur）会生成下个周期的降配订单，下周期生效。

  • 实例的instanceChargeType为POSTPAID：

    • 立即生效。

• 实例的internetChargeType为其他类型，则变更带宽立刻生效。

• 本接口调用是异步操作，你可以调用DescribeInstanceInternetStatus来查看变更的结果。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
instanceId	是	String	待操作的实例ID。 可通过DescribeInstances接口返回值中的instanceId获取。
internetMaxBandwidthOut	是	Integer	出口带宽大小。 取值范围：>=1。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
orderNumber	String	订单编号。

4. 代码示例

示例

1. 升配实例的带宽

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyInstanceBandwidth
<Common Request Params>

Request：
{
  "instanceId": "instanceId",
  "internetMaxBandwidthOut": 100
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {  
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "orderNumber": "xxxx"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
404	INVALID_INSTANCE_NOT_FOUND	指定的实例不存在。
403	OPERATION_DENIED_INSTANCE_NOT_RUNNING	指定的实例状态不是运行中。
400	INVALID_PARAMETER_BANDWIDTH_EXCEED	带宽参数超出最大值。
403	OPERATION_DENIED_INSTANCE_EXIST_PLAN_BANDWIDTH	实例存在计划变更带宽。
403	OPERATION_DENIED_INSTANCE_BANDWIDTH_PROCESSING	实例带宽变更中。