调用ModifyBgpPeerAttribute接口修改BGP邻居的属性。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:ModifyBgpPeerAttribute | update | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 要修改属性的 BGP 邻居所在 BGP 组的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-shanghai |
| BgpPeerId | string | 是 | 要修改属性的 BGP 邻居的 ID。 | bgp-m5eoyp2mwegk8ce9v**** |
| BgpGroupId | string | 否 | 要修改属性的 BGP 邻居所在 BGP 组的 ID。 | bgpg-m5eo12jxuw2hc0uqq**** |
| PeerIpAddress | string | 否 | 要修改的 BGP 邻居的 IP 地址。 | 116.62.XX.XX |
| EnableBfd | boolean | 否 | 是否开启 BFD 功能，取值：
| false |
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。 由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
| BfdMultiHop | integer | 否 | BFD 跳数。取值范围：1~255。 选择开启 BFD 功能时，需要配置此参数。 输入 BFD 跳数，即数据从源端到目标端传输时经过的最大设备数量。您可以根据真实的物理链路因素配置不同的跳数。 说明
当您在多云环境或光纤直连组网中使用 BFD，中间无任何桥接设备时，则需要将 BFD 的默认跳数从 255 改成 1。
| 3 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "D4B7649A-61BB-4C64-A586-1DFF1EDA6A42"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.IpAddress | The specified IpAddress is illegal. | 指定的IpAddress不合法 |
| 400 | InvalidAccessDeviceId.NotFound | There is no Access_Device_Id in our records | - |
| 400 | QuotaExceeded.BfdSession | Your Bfd Session number reaches the upper limit. | - |
| 400 | QuotaExceeded.BfdSession | The Bfd Session on device reaches the upper limit. | - |
| 400 | MissingParam.BgpPeerId | The parameter BgpPeerId is mandatory. | - |
| 400 | InvalidBgpPeer.NotFound | The specified BgpPeerId does not exit in our records. | - |
| 400 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
| 400 | IncorrectStatus.BgpPeer | Invalid BgpPeer status cannot operate. | 无效的BgpPeer状态无法运行。 |
| 400 | MissingParam.EnableBfd | The parameter EnableBfd is missing. | - |
| 400 | IllegalParam.BfdMultiHop | BfdMultiHop is illegal. | - |
| 400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | 操作失败，因为出方向流量未开通。 |
| 400 | DuplicatedParam.PeerIpAddress | The param of PeerIpAddress is duplicated. | BGP邻居IP地址重复。 |
| 404 | InvalidBgpPeerId.NotFound | The specified BgpPeerId does not exit in our records. | - |
| 404 | IncorretStatus.BgpPeer | The specified BgpPeer status is not stable, can not operate. | - |
| 500 | Internal.Error | The request processing has failed due to some unknown error, exception or failure. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-04 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |