調用ModifyRouterInterfaceAttribute接口修改路由器接口的配置。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:ModifyRouterInterfaceAttribute | update |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 路由器接口所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-shanghai |
| RouterInterfaceId | string | 是 | 路由器接口 ID。 | ri-2zeo3xzyf38r4urz**** |
| Name | string | 否 | 路由器接口的名稱。 長度為 2～128 個字符，必須以字母或中文開頭，可包含數字、下劃線（_）和短劃線（-）。 | TEST |
| Description | string | 否 | 路由器接口的描述信息。 長度為 2～256 個字符，必須以字母或中文開頭，但不能以 | 路由器接口 |
| OppositeInterfaceId | string | 否 | 對端路由器接口 ID。 | ri-2zeo3xzyf38r4urz**** |
| OppositeRouterId | string | 否 | 對端路由器 ID。 | vrt-bp1jcg5cmxjbl9xgc**** |
| OppositeRouterType | string | 否 | 要連接的對端路由器接口所屬的路由器類型。取值：
| VBR |
| OppositeInterfaceOwnerId | long | 否 | 對端路由器接口的賬號 ID。 | 28768383240243**** |
| HealthCheckSourceIp | string | 否 | 健康檢查源 IP 地址，必須是本端 VPC 內的一個未被使用的 IP 地址。 說明
物理專線接入場景下可指定該參數。
| 116.62.XX.XX |
| HealthCheckTargetIp | string | 否 | 健康檢查目的 IP 地址。 說明
指定 HealthCheckSourceIp 后，該參數為必選。
| 116.62.XX.XX |
| HcThreshold | integer | 否 | 健康檢查閾值。單位：個。推薦值為 8。表示指定健康檢查時發送探測報文的個數。 | 8 |
| HcRate | integer | 否 | 健康檢查速率。單位：毫秒。推薦值為 2000。表示指定健康檢查時發送連續探測報文的時間間隔。 本示例 HcThreshold 設置為 8、HcRate 設置為 2000，即在健康檢查時每 2000 毫秒從 HealthCheckSourceIp（健康檢查源 IP 地址）向 HealthCheckTargetIp（健康檢查目的 IP 地址）發送一次探測報文，如果連續 8 次探測報文都無響應，則健康檢查失敗。 | 2000 |
| DeleteHealthCheckIp | boolean | 否 | 是否刪除該路由器接口上配置的健康檢查 IP。取值：
| false |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Forbidden.FinancialLocked | This RouterInterface is financiel locked because of bills outstanding. | - |
| 400 | InvalidName.Malformed | The attribute name is illegal. | 該名稱格式不合法。 |
| 400 | InvalidOppositeRouterType.ValueNotSupported | The specified OppositeRouterType is not valid. | 參數OppositeRouterType的值不合法。 |
| 400 | InvalidDescription.Malformed | The Description is illegal. | 指定的資源描述格式不合法。長度為2-256個字符，不能以http://和https://開頭。 |
| 400 | Forbbiden | The Router instance owner error | - |
| 400 | LinkRole.NotSupport | This linkrole is not supported | 這個鏈接不支持。 |
| 400 | Forbbiden.ModifyIdAndType | Opposite is VBR, cannot modify the ID and type | - |
| 400 | InvalidParam.ModifyRouterInterface | Modify routerinterface param invalid | 編輯路由器接口參數不合法。 |
| 400 | InvalidParam.ModifyRouterInterface | Modify routerinterface health check source ip invalid | - |
| 400 | InvalidParam.ModifyRouterInterface | healthCheck Ip is conflicted with DeleteHealthCheckIp option | - |
| 400 | INSTANCE_IN_PROCESSIONG | Instance is in processing,please wait and try again | - |
| 400 | IllegalParam.HcThreshold | %s | - |
| 400 | IllegalParam.HcRate | %s | - |
| 400 | InvalidHealthCheckIP.Malformd | Healthcheck sourceip or targetip is not valid. | - |
| 400 | IllegalParam.HcSourceIp | The specified healthCheck Ip is not valid. | 健康檢查IP不合法。 |
| 400 | OperationFailed.OperationLocked | Operation failed because OperationLocked. | 操作失敗因為實例已經被運維鎖定。 |
| 400 | IncorrectStatus.RouterInterface | This openeration would not be allowed because status of this RouterInterface is not correct. | 當前實例的狀態無法進行刪除，請等待狀態變更后再次進行操作。 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
| 404 | InvalidRouterInterfaceId.NotFound | The specified RouterInterfaceId does not exist in our records. | 指定的路由器接口不存在，請您檢查填寫的路由器接口是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-06-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-12-21 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標記、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2021-11-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2021-11-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |