All Products
Search

This Product

    Smart Access Gateway:ViewSmartAccessGatewayGlobalRouteProtocol

    Document Center

    Smart Access Gateway:ViewSmartAccessGatewayGlobalRouteProtocol

    Last Updated:Mar 29, 2024

    Queries the global routing protocol of an SCG5000 or SCG5000-5G device whose version is 3.4.2 or later.

    Operation description

    You can query the global protocol 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

    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
    smartag:ViewSmartAccessGatewayGlobalRouteProtocolRead
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    SagInsIdstringYes

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

    		sag-iv408aov6k7xxm****
    SagSnstringYes

    The serial number of the SAG device.

    		sagf4ea****
    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
    RouteProtocolstring

    The routing protocol. Valid values:

    • STATIC
    • OSPF
    • BGP
    		STATIC
    RequestIdstring

    The request ID.

    		D10FFDB2-AF7D-530A-A2AC-EBDC16500399
    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.

    		1586843621000

    Examples

    Sample success responses

    JSONformat

    {
  "RouteProtocol": "STATIC",
  "RequestId": "D10FFDB2-AF7D-530A-A2AC-EBDC16500399",
  "TaskStates": [
    {
      "ErrorMessage": "Successful",
      "State": "Succeed",
      "ErrorCode": "200",
      "CreateTime": "1586843621000"
    }
  ]
}

    Error codes

    HTTP status codeError codeError message
    400GATEWAY.InvalidSNThe specified gateway serial number does not exist.
    400MissParameter.GatewayIdThe input parameter GatewayId that is mandatory for processing this model is not supplied.
    400DeviceNotExistThe specified device does not exist

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