调用DescribeSagPortRouteProtocolList获取路由协议开启的端口列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSagPortRouteProtocolList

系统规定参数。取值:DescribeSagPortRouteProtocolList

RegionId String cn-shanghai

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

SmartAGId String sag-whfn****

智能接入网关实例ID。

SmartAGSn String sag32a30****

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

返回数据

名称 类型 示例值 描述
RequestId String CE6642D4-21EB-4168-9BF9-F217953F9892

请求ID。

Ports Array of Port

端口信息列表。

Status String UP

端口状态:

  • UP:端口开启。
  • DOWN:端口关闭。
RemoteIp String 192.XX.XX.1

对端IP地址。

PortName String 3

端口名称。

NeighborIp String 192.XX.XX.1

邻居IP地址。

RouteProtocol String BGP

端口路由协议:

  • STATIC:静态路由协议。
  • OSPF:OSPF动态路由协议。
  • BGP:BGP动态路由协议。
RemoteAs String 12345

对端BGP自治系统编号。

Vlan String 2

VLAN编号。

TaskStates Array of TaskState

查询任务状态。

ErrorMessage String Successful

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

State String Succeed

异步任务状态:

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

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

CreateTime String 1586843621000

查询任务创建时间。

示例

请求示例

http(s)://smartag.cn-shanghai.aliyuncs.com/?Action=DescribeSagPortRouteProtocolList
&RegionId=cn-shanghai
&SmartAGId=sag-whfn****
&SmartAGSn=sag32a30****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSagPortRouteProtocolListResponse>
<RequestId>CAA9089E-9C8E-422A-BB87-72A784A8A906</RequestId>
<Ports>
    <Status>DOWN</Status>
    <RouteProtocol>STATIC</RouteProtocol>
    <PortName>0</PortName>
</Ports>
<Ports>
    <Status>UP</Status>
    <RouteProtocol>OSPF</RouteProtocol>
    <PortName>4</PortName>
</Ports>
<Ports>
    <Status>DOWN</Status>
    <RouteProtocol>STATIC</RouteProtocol>
    <PortName>5</PortName>
</Ports>
<Ports>
    <RemoteAs/>
    <Status>DOWN</Status>
    <RouteProtocol>STATIC</RouteProtocol>
    <RemoteIp/>
    <Vlan>0</Vlan>
    <PortName>3</PortName>
</Ports>
<TaskStates>
    <State>Succeed</State>
    <CreateTime>1586843621000</CreateTime>
    <ErrorCode>200</ErrorCode>
    <ErrorMessage>Successful</ErrorMessage>
</TaskStates>
</DescribeSagPortRouteProtocolListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CAA9089E-9C8E-422A-BB87-72A784A8A906",
  "Ports" : [ {
    "Status" : "DOWN",
    "RouteProtocol" : "STATIC",
    "PortName" : "0"
  }, {
    "Status" : "UP",
    "RouteProtocol" : "OSPF",
    "PortName" : "4"
  }, {
    "Status" : "DOWN",
    "RouteProtocol" : "STATIC",
    "PortName" : "5"
  }, {
    "RemoteAs" : "",
    "Status" : "DOWN",
    "RouteProtocol" : "STATIC",
    "RemoteIp" : "",
    "Vlan" : "0",
    "PortName" : "3"
  } ],
  "TaskStates" : [ {
    "State" : "Succeed",
    "CreateTime" : 1586843621000,
    "ErrorCode" : "200",
    "ErrorMessage" : "Successful"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 SAG.InstanceNoFound The specified SAG instance does not exist. 智能接入网关实例不存在。
400 SAG.SoftwareNotSupport The specified SAG software edition instance does not support ACL. 智能接入网关软件版实例不支持ACL。
400 InstanceNotExit The specified instance does not exist. 指定的实例不存在。
400 ConfigUnsynchronized The network configuration is not synchronized. 网络配置未同步。
403 SmartAccessGatewayNotOnline The specified smart access gateway is not online. 该智能接入网关当前不是在线状态,无法完成操作。
403 FeatureNotSupport The current edition of the smart access gateway does not support this feature. 智能接入网关当前版本不支持该功能特性。
403 FeatureNotSupportForActiveSmartAG The current edition of the active smart access gateway does not support this feature. 主智能接入网关的当前版本不支持该功能特性。
403 FeatureNotSupportForStandBySmartAG The current edition of the standby smart access gateway does not support this feature. 备智能接入网关的当前版本不支持该功能特性。
500 SmartAccessGatewayInArrears The specified Smart Access Gateway has expired. 该智能接入网关已经到期停服,请续费。
500 SmartAccessGatewayNotActivated The specified Smart Access Gateway has not been activated. 该智能接入网关尚未激活,请先激活该实例。
500 SmartAccessGatewayOffline The request cannot be completed. The Smart Access Gateway is offline. 智能接入网关离线,请求无法完成。

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