All Products
Search

This Product

    Smart Access Gateway:UpdateSmartAccessGatewayBgpRoute

    Document Center

    Smart Access Gateway:UpdateSmartAccessGatewayBgpRoute

    Last Updated:Mar 29, 2024

    Modifies the BGP configurations of an SCG5000 or SCG5000-5G device whose version is 3.4.2 or later.

    Operation description

    You can modify the BGP configuration only of SCG5000 and SCG5000-5G devices whose version is 3.4.2 or later.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    SagInsIdstringYes

    The ID of the Smart Access Gateway (SAG) instance.

    		sag-v9un1ccz22owd7****
    SagSnstringYes

    The serial number of the SAG device.

    		sagf4dk****
    RegionIdstringYes

    The region ID of the SAG instance.

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

    		cn-shanghai
    RouterIdstringYes

    The ID of the BGP router.

    		172.XX.XX.1
    LocalAslongYes

    The autonomous system number (ASN) of the SAG device.

    Valid values: 1 to 4294967295.

    		65536
    HoldTimeintegerYes

    The hold time. Unit: seconds.

    Valid values: 3 to 65535.

    Note When the SAG device establishes a peering connection with a peer device, the hold time of both devices must be the same. If the SAG device does not receive a keepalive or update message from the peer device within the hold time, the connection between the BGP peers is closed.
    		9
    KeepAliveintegerYes

    The time interval at which keep-alive packets are sent. Unit: seconds.

    Valid values: 0 to 65535.

    		3
    CrossAccountbooleanNo

    Specifies whether to query only the SAG instances that belong to another Alibaba Cloud account. Valid values:

    • false (default)
    • true
    		false
    ResourceUidstringNo

    The ID of the Alibaba Cloud account to which the SAG instance belongs.

    		147304382796****

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codestring

    The response code. A value of 200 indicates that the task is successful.

    		200
    Successboolean

    Indicates whether the call is successful. Valid values:

    • true
    • false
    		true
    RequestIdstring

    The request ID.

    		7F0B079C-2D0E-4ABF-A970-C079F785A09C
    Messagestring

    The response message. A value of Successful indicates that the task is successful.

    		Successful

    Examples

    Sample success responses

    JSONformat

    {
  "Code": "200",
  "Success": true,
  "RequestId": "7F0B079C-2D0E-4ABF-A970-C079F785A09C",
  "Message": "Successful"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400GATEWAY.InvalidSNThe specified gateway serial number does not exist.-
    400InternalErrorInternal server error-
    400DeviceNotExistThe specified device does not exist-
    400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
    400SAG.SoftwareNotSupportThe specified software instance does not support ACL.-
    400SmartAccessGatewayNotActivatedThe specified Smart Access Gateway has not been activated.The specified SAG instance is inactive. You must activate the instance first.
    400MissParameter.GatewayIdThe input parameter GatewayId that is mandatory for processing this model is not supplied.-
    400MissParameter.RouterIdThe input parameter RouterId that is mandatory for processing this model is not supplied.-
    400MissParameter.LocalAsThe input parameter LocalAs that is mandatory for processing this model is not supplied.-
    400MissParameter.HoldThe input parameter Hold that is mandatory for processing this model is not supplied.-
    400MissParameter.KeepaliveThe input parameter Keepalive that is mandatory for processing this model is not supplied.-
    400InvalidParameter.RouterIdThe input parameter RouterId is illegal, please check your input.-
    400InvalidParameter.LocalAsThe input parameter LocalAs is illegal, please check your input.-
    400InvalidParameter.HoldThe input parameter Hold is illegal, please check your input.-
    400InvalidParameter.KeepaliveThe input parameter Keepalive is illegal, please check your input.-
    400InvalidParameter.RedistributeProtocolThe input parameter RedistributeProtocol is illegal, please check your input.-
    400InvalidParameter.NetworksThe input parameter Networks is illegal, please check your input.-
    400InvalidParameter.NeighborIpThe input parameter NeighborIp is illegal, please check your input.-
    400InvalidParameter.RemoteAsThe input parameter RemoteAs is illegal, please check your input.-
    400FeatureNotSupportThe current edition of the smart access gateway does not support this feature.The current version of Smart Access Gateway does not support this feature.

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