ViewSmartAccessGatewayOspfRoute - Smart Access Gateway - Alibaba Cloud Documentation Center

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

Operation description

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

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SagInsId	string	Yes	The ID of the Smart Access Gateway (SAG) instance.	sag-3manef62evrfr6****
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
CrossAccount	boolean	No	Specifies whether to query only the 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.	109790620697****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	AA1AE941-84A9-5F83-A955-C8DAF31C2CB8
AreaId	integer	The ID of the OSPF area.	10
AuthenticationType	string	The authentication type. Valid values: NONE: Authentication is disabled. CLEARTEXT: Plaintext authentication is used. MD5: MD5 authentication is used.	NONE
DeadTime	integer	The timeout period of connections between OSPF peers. Unit: seconds.	10
HelloTime	integer	The time interval at which Hello packets are sent. Unit: seconds.	1
Md5Key	string	The MD5 key value.	123****
Md5KeyId	integer	The ID of the MD5 key.	1
RouterId	string	The ID of the router that has OSPF enabled.	1.XX.XX.1
TaskStates	object []	The status of the task.
ErrorMessage	string	The error message. A value of Successful indicates that the task is successful.	Successful
State	string	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
ErrorCode	string	The error code. A value of 200 indicates that the task is successful.	200
CreateTime	string	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

{
  "RequestId": "AA1AE941-84A9-5F83-A955-C8DAF31C2CB8",
  "AreaId": 10,
  "AuthenticationType": "NONE",
  "DeadTime": 10,
  "HelloTime": 1,
  "Md5Key": "123****",
  "Md5KeyId": 1,
  "RouterId": "1.XX.XX.1",
  "TaskStates": [
    {
      "ErrorMessage": "Successful",
      "State": "Succeed",
      "ErrorCode": "200",
      "CreateTime": "1586843621000"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	GATEWAY.InvalidSN	The specified gateway serial number 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	DeviceNotExist	The specified device does not exist	-
400	MissParameter.GatewayId	The input parameter GatewayId that is mandatory for processing this model is not supplied.	-

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