All Products
Search

This Product

    Smart Access Gateway:ViewSmartAccessGatewayBgpRoute

    Document Center

    Smart Access Gateway:ViewSmartAccessGatewayBgpRoute

    Last Updated:Mar 29, 2024

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

    Operation description

    You can query 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-3manef62evrfr6****
    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
    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.

    		109790620697****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		F1FEABC0-F7B7-53EA-83EE-AA470ABACE60
    HoldTimeinteger

    The hold time. Unit: seconds.

    		9
    KeepAliveinteger

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

    		3
    LocalAsinteger

    The autonomous system number (ASN) to which the SAG device belongs.

    		12****
    RouterIdstring

    The ID of the BGP router.

    		192.XX.XX.1
    TaskStatesobject []

    The status of the task.

    ErrorMessagestring

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

    		Successful
    Statestring

    The status of the asynchronous task. Valid values:

    • Initialized: The query task is initialized.
    • Offline: The SAG device is disconnected from Alibaba Cloud and Alibaba Cloud has not assigned the query task to the SAG device. After the SAG device is connected to Alibaba Cloud, Alibaba Cloud assigns the query task to the SAG device.
    • Succeed: Alibaba Cloud has assigned the query task to the SAG device.
    • Processing: Alibaba Cloud is assigning the query task to the SAG device.
    • VersionNotSupport: The query task is not supported by the current version of the SAG device.
    • BuildRequestError: The query task is not supported by the controller of the SAG device.
    • HardwareError: Alibaba Cloud failed to assign the query task to the SAG device because the SAG device is faulty.
    • TaskNotExist: The query task does not exist.
    • OfflineNotConfiged: The SAG device is disconnected from Alibaba Cloud and Alibaba Cloud has not assigned the query task to the SAG device. Alibaba Cloud does not assign the query task to the SAG device even after the SAG device is connected to Alibaba Cloud.
    		Succeed
    ErrorCodestring

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

    		200
    CreateTimestring

    The timestamp when the task was created. Unit: milliseconds.

    The value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

    		1586855592000

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "F1FEABC0-F7B7-53EA-83EE-AA470ABACE60",
  "HoldTime": 9,
  "KeepAlive": 3,
  "LocalAs": 0,
  "RouterId": "192.XX.XX.1",
  "TaskStates": [
    {
      "ErrorMessage": "Successful",
      "State": "Succeed",
      "ErrorCode": "200",
      "CreateTime": "1586855592000"
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400GATEWAY.InvalidSNThe specified gateway serial number 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.
    400DeviceNotExistThe specified device does not exist-
    400MissParameter.GatewayIdThe input parameter GatewayId that is mandatory for processing this model is not supplied.-

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