调用ModifyBgpGroupAttribute接口修改BGP组的配置。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:ModifyBgpGroupAttribute | update | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | BGP 组所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-shanghai |
| BgpGroupId | string | 是 | 指定 BGP 组的 ID。 | bgpg-wz9f62v4fbg2g**** |
| Name | string | 否 | BGP 组的名称。 长度为 0～128 个字符，不能以 | test |
| Description | string | 否 | BGP 组的描述信息。 长度为 0～256 个字符，不能以 | BGP |
| LocalAsn | long | 否 | 自定义阿里云侧 BGP AS 号。取值：
说明
其中 65025 为阿里云保留值，阿里侧默认使用 45104 作为 LocalAsn，使用自定义 LocalAsn 功能在多线接入场景时可能存在 BGP 路由环路风险，请合理评估后使用。
| 45104 |
| PeerAsn | long | 否 | 本地侧设备的 AS 号。 | 1**** |
| AuthKey | string | 否 | BGP 组的认证密钥。 | !PWZ2**** |
| IsFakeAsn | boolean | 否 | 是否指定伪 AS 号。取值;
说明
运行 BGP 的路由器一般只能属于一个 AS。当需要用新的 AS 替代原有的 AS（例如 AS 需要迁移或者和其他 AS 合并），并且因为业务等客观因素无法立即修改 BGP 配置时，可以通过指定伪 AS 号与本端建立连接，保证业务不中断。
| false |
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
| RouteQuota | integer | 否 | BGP 邻居的路由条目上限。单位：条，默认值：110。 | 110 |
| ClearAuthKey | boolean | 否 | 是否需要清空密钥。取值：
| false |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "8C3C6D7C-A1CE-4FD8-BC57-DC493A55F76F"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | QuotaExceeded.Bgp | bgp peer count per vbr quota exceed. | 边界路由器的BGP邻居数量已达到配额。 |
| 400 | QuotaExceeded.Nqa | nqa count per vbr quota exceed. | NQA数超过VBR配额。 |
| 400 | QuotaExceeded.BgpNetwork | bgp network count per vbr quota exceed. | 边界路由器的BGP网络数量已达到配额。 |
| 400 | InvalidPeerIpAddress | multi pconn peer ip can not be null. | 多物理专线的IP地址不能为空。 |
| 400 | InvalidVbrNetwork | vbr netowrk not exists | 该边界路由器不存在，请您检查输入的边界路由器是否正确。 |
| 400 | InvalidBgpGroup | bgp group not exists | 该BGP组不存在。 |
| 400 | InvalidBgpName.Malformed | Specified Bgp Group name is not valid. | 该BGP组的名称不合法。 |
| 400 | InvalidBgpDiscription.Malformed | Specified Bgp Group description is not valid. | 该BGP组的描述不合法。 |
| 400 | InvalidBgpAuthkey.Malformed | Specified Bgp Group authkey is not valid. | 该BGP组的验证密钥不合法。 |
| 400 | InvalidIP.Malformed | Ip malformed. | IP格式不合法。 |
| 400 | InvalidPeerAsn.Malformed | invalid peer asn cannot equals aliyun asn:45104 | ASN号码不能和阿里云ASN号码一致。 |
| 400 | InvalidParams.NotNull | %s | - |
| 400 | InvalidBgpGroup.LocalAsnInvalid | The specified BgpGroup LocalAsn is invalid, only support 64512 to 65534 or 4200000000 to 4294967294, and cannot be 65025. | - |
| 400 | InvalidParams.NotFound | instance not found | 实例不存在。 |
| 400 | InvalidParams.NotFound | vpc instance not found | 该VPC不存在，请您检查输入的VPC是否正确。 |
| 400 | InvalidParams.AlreadyExists | bgp network already exists | BGP网络已经存在。 |
| 400 | InvalidStatus.CannotOperate | invalid status cannot operate | 状态不合法，无法执行该操作。 |
| 400 | InvalidParams.PeerIpAddressMustPointOut | vbr has 0 or more than 1 subif ,point out peerIpAddress. | 请指出PeerIpAddress |
| 400 | InvalidParams.PeerIpAddressInUse | peer ip address in use ,cannot create bgp peer. | 对等IP地址正在使用，无法创建BGP对等。 |
| 400 | InvalidStatus.CannotOperate | Instance is not in stable status,please wait and try again. | - |
| 400 | IllegalParam.PeerAsn | %s | - |
| 400 | IllegalParam.LocalAsn | %s | - |
| 400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | 操作失败，因为出方向流量未开通。 |
| 400 | OperationUnsupport | Operation is unsupport, not in vbr support custom local asn white list. | 操作不支持 |
| 400 | OperationFailed.ClearAuthKeyForbidden | The specific auth key is not empty. | 指定密钥不为空，无法清空密钥。 |
| 400 | IllegalParam.RouteLimit | The operation is failed because of bgp group max route entry num quota exceed. | BGP组中的每个BGP邻居可接收的路由条目数超过配额。 |
| 400 | OperationDenied.VbrAttachEcrInMiddleStatus | The operation is not allowed because of VBR attach or detach ECR in middle status. | 由于边界路由器正处于加载或者卸载专线网关过程中，当前操作无法执行，请您稍等后重试。 |
| 400 | OperationUnsupported.VBRAttachedECR | VBR already attached to ECR, please delete it from ECR. | 边界路由器已经绑定了专线网关, 先将边界路由器从专线网关中删除后重试。 |
| 404 | InvalidRegionId.NotFound | Specified value of "regionId" is not supported. | 指定的 RegionId 不存在，请您检查此产品在该地域是否可用。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-06-19 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-06-13 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |