> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/bmc/bare-metal-instance/modifyinstancebandwidth.md).

# ModifyInstanceBandwidth

## 1. 接口描述

本接口(ModifyInstanceBandwidth)用于修改实例带宽。

{% hint style="info" %}
**注意事项**

* 不同机型带宽上限范围不一致（可通过`DescribeInstanceTypes`接口获取）。
* 仅实例状态处于`RUNNING`状态，接口才能调用。
* 若当前实例的带宽在赠送带宽内，要修改的带宽在赠送带宽内，不涉及价格，立即生效。
* 若实例的[internetChargeType](/api-reference/cn/bmc/datastructure.md#internetchargetype)为ByBandwidth：
  * 实例的`instanceChargeType`为PREPAID：
    * 升配（target > cur）会预先扣除本次实例购买所需金额，如果余额不足，请求将会失败，立即生效。
    * 降配（target < cur）会生成下个周期的降配订单，下周期生效。
  * 实例的`instanceChargeType`为POSTPAID：
    * 立即生效。
  * 询带宽变更价格接口 InquiryPriceInstanceBandwidth。
* 若要查询实例带宽状态，可调用 DescribeInstanceInternetStatus。
  {% endhint %}

## 2. 请求参数

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

| 参数名称             | 必选 | 类型      | 描述                                                              |
| ---------------- | -- | ------- | --------------------------------------------------------------- |
| instanceId       | 是  | String  | <p>待操作的实例ID。</p><p>可通过DescribeInstances接口返回值中的instanceId获取。</p> |
| bandwidthOutMbps | 是  | Integer | <p>带宽。</p><p>范围：1\~机型最大。</p><p>可选值范围：\[1, +)</p>                |

## 3. 响应结果

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

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 升配实例的带宽**

```javascript
POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyInstanceBandwidth
Request：
{
  "instanceId": "instanceId",
  "bandwidthOutMbps": 100
}
Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": { 
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "orderNumber": "xxxx"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](/api-reference/cn/api-introduction/instruction/commonerrorcode.md)

| HTTP状态码 | 错误码                                                         | 说明             |
| ------- | ----------------------------------------------------------- | -------------- |
| 403     | OPERATION\_FAILED\_INSTANCE\_BANDWIDTH\_PROCESSING          | 指定的实例带宽正在修改中。  |
| 404     | INVALID\_INSTANCE\_NOT\_FOUND                               | 实例不存在。         |
| 403     | OPERATION\_DENIED\_HA\_MODEL\_TYPE\_NOT\_SUPPORT\_BANDWIDTH | 高可用机型无法设置带宽。   |
| 403     | OPERATION\_DENIED\_INSTANCE\_NOT\_RUNNING                   | 实例状态不是Running。 |
| 400     | INVALID\_PARAMETER\_BANDWIDTH\_EXCEED                       | 带宽参数超出最大值。     |