All Products
Search
Document Center

Smart Access Gateway:UpdateSmartAccessGatewayBgpRoute

Last Updated:Aug 28, 2026

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

Operation description

Only SCG5000 and SCG5000-5G devices running version 3.4.2 or later support BGP configuration modification.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:UpdateSmartAccessGatewayBgpRoute

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

SagInsId

string

Yes

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

sag-v9un1ccz22owd7****

SagSn

string

Yes

The serial number of the SAG device.

sagf4dk****

RegionId

string

Yes

The region ID of the SAG instance.

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

cn-shanghai

RouterId

string

Yes

The ID of the BGP router.

172.XX.XX.1

LocalAs

integer

Yes

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

Valid values: 1 to 4294967295.

65536

HoldTime

integer

Yes

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

KeepAlive

integer

Yes

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

Valid values: 0 to 65535.

3

CrossAccount

boolean

No

Whether to query only SAG instances that belong to another Alibaba Cloud account. Valid values:

  • false (default)

  • true

false

ResourceUid

string

No

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

147304382796****

Response elements

Element

Type

Description

Example

object

Code

string

The response code. 200 indicates success.

200

Success

boolean

Whether the call is successful. Valid values:

  • true

  • false

true

RequestId

string

The request ID.

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

Message

string

The response message. Successful indicates success.

Successful

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

400 GATEWAY.InvalidSN The specified gateway serial number does not exist.
400 InternalError Internal server error
400 DeviceNotExist The specified device does not exist
400 SAG.InstanceNoFound The specified SAG instance does not exist. The specified SAG instance does not exist.
400 SAG.SoftwareNotSupport The specified software instance does not support ACL.
400 SmartAccessGatewayNotActivated The specified Smart Access Gateway has not been activated. The specified SAG instance is inactive. You must activate the instance first.
400 MissParameter.GatewayId The input parameter GatewayId that is mandatory for processing this model is not supplied.
400 MissParameter.RouterId The input parameter RouterId that is mandatory for processing this model is not supplied.
400 MissParameter.LocalAs The input parameter LocalAs that is mandatory for processing this model is not supplied.
400 MissParameter.Hold The input parameter Hold that is mandatory for processing this model is not supplied.
400 MissParameter.Keepalive The input parameter Keepalive that is mandatory for processing this model is not supplied.
400 InvalidParameter.RouterId The input parameter RouterId is illegal, please check your input.
400 InvalidParameter.LocalAs The input parameter LocalAs is illegal, please check your input.
400 InvalidParameter.Hold The input parameter Hold is illegal, please check your input.
400 InvalidParameter.Keepalive The input parameter Keepalive is illegal, please check your input.
400 InvalidParameter.RedistributeProtocol The input parameter RedistributeProtocol is illegal, please check your input.
400 InvalidParameter.Networks The input parameter Networks is illegal, please check your input.
400 InvalidParameter.NeighborIp The input parameter NeighborIp is illegal, please check your input.
400 InvalidParameter.RemoteAs The input parameter RemoteAs is illegal, please check your input.
400 FeatureNotSupport The current edition of the smart access gateway does not support this feature.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.