CreateBgpGroup - API reference| Alibaba Cloud Documentation Center

Description

Create a BGP group.

A BGP group is used for simplifying BGP configurations. You can combine repetitive configurations into a BGP group to reduce the configuration complexity. Each BGP group is associated with an autonomous system number (ASN).

You can use BGP for the communication between the Virtual Border Router (VBR) and the local IDC. Each BGP group is associated with a VBR. To use BGP, add the BGP peer communicating with the VBR to the corresponding BGP group and advertise the BGP network in the VBR.

Note the following before creating a BGP group:

The supported BGP version is 4 (BGP4).
IPv4 BGP is supported, but IPv6 BGP is not supported.

Request parameters

Name	Type	Required	Description
Action	String	Yes	The action to perform. Valid value: `CreateBgpGroup`
RegionId	String	Yes	The region of the BGP group. You can obtain the region ID by calling the DescribeRegions API.
RouterId	String	Yes	The ID of the VBR.
PeerASN	Integer	Yes	The ASN of the BGP peer. It can 2 bytes or 4 bytes in length, but cannot be the same as the Alibaba Cloud-side ASN 45104.
AuthKey	String	No	The authentication key of the BGP group.
Name	String	No	The name of the BGP group. The name must start with an English letter, but cannot start with`http://` or `https://`. The name can contain from 2 to 128 characters including a-z, A-Z, 0-9, underlines, and hyphens.
Description	String	No	The description of the BGP group. The description must start with English letters, but cannot start with `http://` or `https://`. The description can contain from 2 to 256 characters.

Response parameters

Name	Type	Description
RequestId	String	The ID of the request.
BgpGroupId	String	The ID of the created BGP group.

Error codes

See VPC API Error Center.

Examples

Request example

https://vpc.aliyuncs.com/?Action=CreateBgpGroup
&RegionId=cn-beijing
&PeerAsn=2010
&RouterId=vbr-2zeff11o2sqhnp1u7ci93
&<CommonParameters>

Request example

XML format

<CreateBgpGroupResponse>
    <BgpGroupId>bgpg-2zendnzngq9lkjkhvlrsr</BgpGroupId>
    <RequestId>C1221A1F-2ACD-4592-8F27-474E02883159</RequestId>
</CreateBgpGroupResponse>

JSON format

{
  "BgpGroupId": "bgpg-2zendnzngq9lkjkhvlrsr",
  "RequestId": "C1221A1F-2ACD-4592-8F27-474E02883159"
}