文档

DescribeSagWanList - 获取设备WAN有线配置信息

更新时间:

查询智能接入网关设备WAN口配置信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:DescribeSagWanListList
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

请求参数

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

智能接入网关实例地域 ID。 您可以调用 DescribeRegions 接口查询智能接入网关支持的地域以及对应的地域 ID。

cn-shanghai
SmartAGIdstring

智能接入网关实例 ID。

sag-whfn****
SmartAGSnstring

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

sag32a30****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

CE6642D4-21EB-4168-9BF9-F217953F9892
Wansobject []

WAN 口配置信息列表。

Weightinteger

WAN 口权重。

100
Maskstring

WAN 口 IP 地址掩码。

255.255.255.240
Gatewaystring

网关 IP 地址。

192.XX.XX.1
PortNamestring

WAN 口所属的端口号。

1
IPTypestring

WAN 口连接类型:

  • DHCP:通过 DHCP 协议动态获取 IP 地址,进而访问互联网。
  • STATIC:通过静态指定 IP 地址,进而访问互联网。
  • PPPOE:通过拨号方式接入互联网。
STATIC
Priorityinteger

WAN 口优先级。

数值范围:-11~50,数值越小优先级越高。

说明 优先级为**-1**时,表示端口不启用流量转发。
1
BandWidthinteger

WAN 口的限速带宽。单位:Mbps。

50
TrafficStatestring

WAN 口流量状态。

  • active:表示当前 WAN 端口为主端口,优先进行转发流量。
  • standby:表示当前 WAN 端口为备端口,在主端口故障后进行流量转发。
active
IPstring

WAN 口 IP 地址。

172.XX.XX.1
ISPstring

WAN 口连接的运营商链路。

  • CT:电信
  • CM:移动
  • CU:联通
  • Other:其他
CT
Usernamestring

PPPOE 账号。

Usernamexx
TaskStatesobject []

查询任务信息及状态。

ErrorMessagestring

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

Successful
Statestring

查询任务状态:

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

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

200
CreateTimestring

查询任务创建时间。

1586834861000

示例

正常返回示例

JSON格式

{
  "RequestId": "CE6642D4-21EB-4168-9BF9-F217953F9892",
  "Wans": [
    {
      "Weight": 100,
      "Mask": "255.255.255.240",
      "Gateway": "192.XX.XX.1",
      "PortName": "1",
      "IPType": "STATIC",
      "Priority": 1,
      "BandWidth": 50,
      "TrafficState": "active",
      "IP": "172.XX.XX.1",
      "ISP": "CT",
      "Username": "Usernamexx"
    }
  ],
  "TaskStates": [
    {
      "ErrorMessage": "Successful",
      "State": "Succeed",
      "ErrorCode": "200",
      "CreateTime": "1586834861000"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400SAG.InstanceNoFoundThe specified SAG instance does not exist.智能接入网关实例不存在。
400SAG.SoftwareNotSupportThe specified SAG software edition instance does not support ACL.智能接入网关软件版实例不支持ACL。
400InstanceNotExitThe specified instance does not exist.指定的实例不存在。
400ConfigUnsynchronizedThe network configuration is not synchronized.网络配置未同步。
400Sag.PortRoleInvalidThe port role is invalid.设备端口角色不正确。
400Sag.PortMgtErrorThe role of a management port cannot be changed.管理口角色不能修改。
403SmartAccessGatewayNotOnlineThe specified smart access gateway is not online.该智能接入网关当前不是在线状态,无法完成操作。
403FeatureNotSupportThe current edition of the smart access gateway does not support this feature.智能接入网关当前版本不支持该功能特性。
403FeatureNotSupportForActiveSmartAGThe current edition of the active smart access gateway does not support this feature.主智能接入网关的当前版本不支持该功能特性。
403FeatureNotSupportForStandBySmartAGThe current edition of the standby smart access gateway does not support this feature.备智能接入网关的当前版本不支持该功能特性。
500SmartAccessGatewayInArrearsThe specified Smart Access Gateway has expired.该智能接入网关已经到期停服,请续费。
500SmartAccessGatewayNotActivatedThe specified Smart Access Gateway has not been activated.该智能接入网关尚未激活,请先激活该实例。
500SmartAccessGatewayOfflineThe request cannot be completed. The Smart Access Gateway is offline.智能接入网关离线,请求无法完成。

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