文档

ViewSmartAccessGatewayOspfRoute - 获取SAG设备动态路由协议OSPF的配置

更新时间:

获取SAG设备动态路由协议OSPF的配置,适用于设备类型为SCG5000或SCG5000-5G的智能接入网关实例,且设备版本为3.4.2及以上。

接口说明

目前仅设备版本为 3.4.2 及以上的 SCG5000 和 SCG5000-5G 设备支持获取智能接入网关设备动态路由协议 OSPF 的配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
SagInsIdstring

智能接入网关实例 ID。

sag-3manef62evrfr6****
SagSnstring

智能接入网关设备序列号。

sagf4dk****
RegionIdstring

智能接入网关实例所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai
CrossAccountboolean

是否只查询跨账号所属的智能接入网关实例。取值:

  • false(默认值):否。

  • true:是。

false
ResourceUidstring

智能接入网关实例所属的阿里云账号(主账号)ID。

109790620697****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

AA1AE941-84A9-5F83-A955-C8DAF31C2CB8
AreaIdinteger

OSPF 区域 ID。

10
AuthenticationTypestring

认证类型。取值:

  • NONE:不开启认证。

  • CLEARTEXT:采用明文认证。

  • MD5:采用 MD5 认证。

NONE
DeadTimeinteger

超时时间间隔。单位:秒。

10
HelloTimeinteger

发送 Hello 报文的时间间隔。单位:秒。

1
Md5Keystring

MD5 Key 值。

123****
Md5KeyIdinteger

MD5 Key 的编号。

1
RouterIdstring

OSPF 路由器 ID。

1.XX.XX.1
TaskStatesobject []

查询任务信息状态。

ErrorMessagestring

错误信息。Successful 标识查询任务成功。

Successful
Statestring

异步任务状态。取值:

  • Initialized:查询任务初始化。
  • Offline:智能接入网关设备离线未下发查询任务,智能接入网关设备上线后会继续下发。
  • Succeed:查询任务下发成功。
  • Processing:查询任务下发中。
  • VersionNotSupport:智能接入网关设备当前版本不支持。
  • BuildRequestError:管控不支持。
  • HardwareError:由于设备原因查询任务下发失败。
  • TaskNotExist:查询任务不存在。
  • OfflineNotConfiged:智能接入网关设备离线未下发查询任务,智能接入网关设备上线后也不会下发。
Succeed
ErrorCodestring

错误码。200 标识查询任务成功。

200
CreateTimestring

查询任务创建时间戳。单位:毫秒。

时间戳的格式采用 Unix 时间戳,表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至创建查询任务时的总时长。

1586843621000

示例

正常返回示例

JSON格式

{
  "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"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400GATEWAY.InvalidSNThe specified gateway serial number does not exist.-
400SAG.InstanceNoFoundThe specified SAG instance does not exist.智能接入网关实例不存在。
400SAG.SoftwareNotSupportThe specified software instance does not support ACL.-
400SmartAccessGatewayNotActivatedThe specified Smart Access Gateway has not been activated.该智能接入网关尚未激活,请先激活该实例。
400DeviceNotExistThe specified device does not exist-
400MissParameter.GatewayIdThe input parameter GatewayId that is mandatory for processing this model is not supplied.-

访问错误中心查看更多错误码。