> 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/ipt/ip-transit/modifyiptransitbandwidth.md).

# ModifyIPTransitBandwidth

## 1. 接口描述

本接口(ModifyIPTransitBandwidth)用于修改IP Transit带宽。

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

* 仅当IP Transit线状态为**AVAILABLE**时，才能进行带宽限速的变更操作。
* 本接口为异步接口，此时带宽修改操作并未立即完成。在此期间IP Transit的状态将会处于**UPDATING**，结果可以通过调用[DescribeIPTransits](https://github.com/zenlayer/zenlayercloud-api-doc-cn/tree/main/ipt/ip-transit/describe-iptransits.md) 接口查询，如果状态(`iptStatus`)由 **UPDATING**(修改中)变为**AVAILABLE**(可用)，则代表带宽更新成功。
* 在变更带宽期间，不得对该IP Transit进行其他任何操作。
  {% endhint %}

## 2. 请求参数

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

| 参数名称            | 必选 | 类型      | 描述                                                                 |
| --------------- | -- | ------- | ------------------------------------------------------------------ |
| iptId           | 是  | String  | IP Transit ID。                                                     |
| bandwidth       | 是  | Integer | <p>目标带宽（Mbps）。</p><p>可选值范围：\[5, 1000]</p>                          |
| commitBandwidth | 否  | Integer | <p>保底带宽（Mbps）。</p><p>不填则与 bandwidth 相同。</p><p>可选值范围：\[5, 1000]</p> |

## 3. 响应结果

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

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 修改IP Transit带宽为100Mbps**

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

Request：
{
    "iptId": "your-ipt-id",
    "bandwidth": 100,
    "commitBandwidth": 50
}

Response：
{   
  "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E"
  }
}
```

{% 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状态码 | 错误码                                     | 说明                              |
| ------- | --------------------------------------- | ------------------------------- |
| 404     | INVALID\_RIPT\_NOT\_FOUND               | 远程 IP 隧道实例不存在。                  |
| 409     | INVALID\_RIPT\_HA\_ROLE                 | RIPT 的 HA 角色不适用于该操作。            |
| 409     | INVALID\_RIPT\_HA\_STATUS\_NOT\_RUNNING | RIPT 业务状态需为 RUNNING 才能进行 HA 操作。 |