You need to enable JavaScript to run this app.
导航
专线连接
  • 文档首页
    • /专线连接/API参考/BGP邻居/CreateBgpPeer
CreateBgpPeer
最近更新时间：2024.09.06 08:07:50首次发布时间：2022.03.25 07:38:20
我的收藏

调用CreateBgpPeer为路由方式为“BGP路由”的虚拟接口创建一个BGP邻居。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必选示例值描述
ActionString是CreateBgpPeer要执行的操作，取值为CreateBgpPeer。
VersionString是2020-04-01API版本信息。

BgpPeerName

String

否

test

BGP邻居的名称。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短横线（-）。
  • 长度限制为1 ~ 128个字符。
  • 不传入该参数或该参数不传入数值时，默认为BGP连接实例的ID。

Description

String

否

This is a sample description

BGP邻居的描述信息。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ~ 255个字符。
  • 不传入该参数或该参数不传入数值时，默认为空字符串。
VirtualInterfaceIdString是dcv-3tehy13n2l4c6c0v****BGP邻居所在虚拟接口的ID。您可调用DescribeDirectConnectVirtualInterfaces查询虚拟接口的ID。

RemoteAsn

Integer

是

32500

BGP邻居的ASN。
ASN有效范围1～4294960000，不可与火山引擎的ASN（137718）重复。

AuthKeyString否testAuthBGP邻居的认证密钥。长度范围6～80个字符，可输入英文大小写字母、特殊符号～`!@#$%^*()-_=+[]{}|,./;:及数字。

IpVersion

String

否

IPv4

BGP邻居的IP类型。

  • IPv4（默认）
  • IPv6

返回数据

名称类型
示例值
描述
RequestIdString202111161611080102121461940900****请求ID。
BgpPeerIdStringbgp-2752hz4teko3k7fap8u4c****新创建BGP邻居的ID。

请求示例

GET /?Action=CreateBgpPeer&Version=2020-04-01&BgpPeerName=test&Description=test&VirtualInterfaceId=dcv-3tehy13n2l4c6c0v****&RemoteAsn=32500&AuthKey=testA**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202111161611080102121461940900****",
        "Action": "CreateBgpPeer",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202111161611080102121461940900****",
        "BgpPeerId": "bgp-2752hz4teko3k7fap8u4c****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode
错误码
错误信息
描述
400InvalidBgpPeer.RemoteAsnMalformedThe specified remote ASN is malformed. Ensure that you've specified the remote ASN is not 137718.指定的ASN不合法。ASN不能和火山引擎ASN一致。
400InvalidBgpPeer.VirtualInterfaceMalformedThe specified virtual interface does not support creating a BGP Peer.指定的虚拟接口不支持创建BGP邻居。
400InvalidBgpPeer.RemoteAsnMalformedThe specified BGP remote ASN is malformed.指定ASN不合法。
400InvalidBgpPeer.AuthKeyMalformedThe specified BGP AuthKey is malformed.指定的BGP认证密钥不合法。
400InvalidName.MalformedThe specified name is malformed. Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidDescription.MalformedThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidDirectConnectGateway.InvalidStatusThe specified direct connect gateway is not in the correct status for the request.指定的专线网关所处的状态无法响应该请求。
400InvalidDirectConnectConnection.InvalidBusinessStatusThe specified direct connect connection is not in the correct status for the request. The specified direct connect connection is in freeze.指定的物理专线所处的状态无法响应该请求。当前物理专线被冻结。
400InvalidDirectConnectGateway.InvalidBusinessStatusThe specified direct connect gateway is not in the correct status for the request. The specified direct connect gateway is in freeze.指定的专线网关所处的状态无法响应该请求。当前专线网关被冻结。
400InvalidBgpPeer.IpVersionMalformedThe specified IP version is malformed.指定的IP版本不合法。
400InvalidBgpPeer.IpVersionMismatchThe specified direct connect virtual interface has no IPv6 address.指定的虚拟接口上没有IPv6地址。
400InvalidDirectConnectVirtualInterface.InvalidStatusThe specified direct connect virtual interface is not in the correct status for the request.指定的虚拟接口所处的状态无法响应该请求。
400InvalidBgpPeer.RemoteAsnConflictBgpAsnThe specified ASN is invalid. The ASN cannot be the same as the ASN of direct connect gateway.指定的BGP邻居ASN不合法，不能和专线网关ASN一致。
403Forbidden.IPv6You are not authorized to operate IPv6 functions.无权限操作IPv6功能。
403InvalidOperation.NotSupportThe operation is not supported.当前操作不支持。
404InvalidDirectConnectVirtualInterface.NotFoundThe specified direct connect virtual interface does not exist.指定的虚拟接口不存在。
409InvalidBgpPeer.ConflictThe specified BGP peer conflicts with another BGP peer.指定的BGP邻居与另一条BGP邻居冲突。