All Products
Search

This Product

    Virtual Private Cloud:AddBgpNetwork

    Document Center

    Virtual Private Cloud:AddBgpNetwork

    Last Updated:Nov 13, 2024

    Advertises a Border Gateway Protocol (BGP) network.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:AddBgpNetworkget
    • VirtualBorderRouter
      acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the virtual border router (VBR) group.

    You can call the DescribeRegions operation to query the most recent region list.

    		cn-shanghai
    DstCidrBlockstringYes

    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.

    		10.10.XX.XX/32
    VpcIdstringNo

    The ID of the VPC.

    		vpc-bp1qpo0kug3a2*****
    RouterIdstringYes

    The ID of the router that is associated with the router interface.

    		vrt-2zeo3xzyf38r4u******
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		123e4567-e89b-12d3-a456-426655440000

    Response parameters

    ParameterTypeDescriptionExample
    object

    The request ID.

    RequestIdstring

    The request ID.

    		9C7FA9D6-72E0-48A9-A9C3-2DA8569CD5EB

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "9C7FA9D6-72E0-48A9-A9C3-2DA8569CD5EB"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400QuotaExceeded.Bgpbgp peer count per vbr quota exceed.The number of BGP peers in the VBR has reached the upper limit.
    400QuotaExceeded.Nqanqa count per vbr quota exceed.The number of Network Quality Analyzers (NQAs) has reached the upper limit that is supported by the VBR.
    400QuotaExceeded.BgpNetworkbgp network count per vbr quota exceed.The number of BGP networks in the VBR has reached the upper limit.
    400InvalidPeerIpAddressmulti pconn peer ip can not be null.The IP addresses of multiple Express Connect circuits cannot be empty.
    400InvalidVbrNetworkvbr netowrk not existsThe VBR does not exist. Check the VBR ID.
    400InvalidBgpGroupbgp group not existsThe BGP group does not exist.
    400InvalidBgpName.MalformedSpecified Bgp Group name is not valid.The name of the BGP group is invalid.
    400InvalidBgpDiscription.MalformedSpecified Bgp Group description is not valid.The description of the BGP group is invalid.
    400InvalidBgpAuthkey.MalformedSpecified Bgp Group authkey is not valid.The authentication key of the BGP group is invalid.
    400InvalidIP.MalformedIp malformed.The format of the IP address is invalid.
    400InvalidPeerAsn.Malformedinvalid peer asn cannot equals aliyun asn:45104The AS number cannot be the same as the AS number on the Alibaba Cloud side.
    400InvalidParams.NotNullparameter must not null.A required parameter is not specified.
    400InvalidParams.NotFoundinstance not foundThe specified instance does not exist.
    400InvalidParams.NotFoundvpc instance not foundThe VPC does not exist. Check whether the specified VPC is valid.
    400InvalidParams.AlreadyExistsbgp network already existsThe BGP network already exists.
    400InvalidStatus.CannotOperateinvalid status cannot operateYou cannot perform the operation when the specified resource is in the current state.
    400InvalidParams.PeerIpAddressMustPointOutvbr has 0 or more than 1 subif ,point out peerIpAddress.You must set the PeerIpAddress parameter.
    400InvalidParams.PeerIpAddressInUsepeer ip address in use ,cannot create bgp peer.The peer IP address is being used. Therefore, you cannot use it to create a BGP peer.
    400QuotaExceeded.Bgpbgp group count per vbr quota exceed.The number of BGP groups in the VBR has reached the upper limit.
    400Duplicated.CidrBlockbgp network cidr already exists.-
    400InvalidIP.IpInSnatPoolMulti ip in snat pool cannot remove ip from bandwidth package.-
    400InvalidDestCidrBlock.MalformedSpecified dstCidrBlock is not valid.-
    400IllegalParam.ConflictWithDClassDClass IP can not support.-
    400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.Billing for outbound data transfer is disabled.
    400OperationFailed.NoActiveRouterInterfacethere's not active routerInterface,cannot add bgp network.-
    400IllegalParamFormat.DstCidrBlockThe format of the specified destination CIDR block is invalid.The error message returned because the format of the destination CIDR block is invalid.
    404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-07-29API Description Update. The Error code has changedView Change Details