调用DescribeSagLanList查询智能接入网关设备LAN配置

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSagLanList	系统规定参数。取值：DescribeSagLanList。
RegionId	String	是	cn-shanghai	智能接入网关实例地域ID。
SmartAGId	String	是	sag-whfn****	智能接入网关实例ID。
SmartAGSn	String	是	sag32a30****	绑定的智能接入网关设备的序列号。

返回数据


名称	类型	示例值	描述
RequestId	String	1120228A-E5E1-4E9C-B56D-96887E1A2B2F	请求ID。
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	1586852928000	查询任务创建时间。
Lans	Array of Lan		LAN端口信息列表。
Lease	String	7	DHCP租期。单位分钟。
Mask	String	255.255.255.0	掩码地址。
EndIp	String	192.XX.XX.254	DHCP地址池结束地址。
PortName	String	0	端口名称。
StartIp	String	192.XX.XX.2	DHCP地址池起始地址。
IPType	String	DHCP	LAN口连接类型。 DHCP：动态IP。利用DHCP协议，向连接设备动态下发IP地址。 STATIC：静态IP。静态指定LAN口IP地址。
IP	String	192.XX.XX.1	LAN口IP地址。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSagLanList
&RegionId=cn-shanghai
&SmartAGId=sag-whfn****
&SmartAGSn=sag32a30****
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeSagLanListResponse>
<RequestId>ADDEF8CA-D96F-4002-812A-36FDF4114135</RequestId>
<TaskStates>
    <State>Succeed</State>
    <CreateTime>1586869664000</CreateTime>
    <ErrorCode>200</ErrorCode>
    <ErrorMessage>Successful.</ErrorMessage>
</TaskStates>
<Lans>
    <IPType>STATIC</IPType>
    <IP>192.XX.XX.1</IP>
    <Mask>255.255.255.0</Mask>
    <PortName>0</PortName>
</Lans>
<Lans>
    <IPType>STATIC</IPType>
    <IP>172.XX.XX.10</IP>
    <Mask>255.255.255.0</Mask>
    <PortName>4</PortName>
</Lans>
</DescribeSagLanListResponse>

JSON格式

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

{
  "RequestId" : "ADDEF8CA-D96F-4002-812A-36FDF4114135",
  "TaskStates" : [ {
    "State" : "Succeed",
    "CreateTime" : 1586869664000,
    "ErrorCode" : "200",
    "ErrorMessage" : "Successful"
  } ],
  "Lans" : [ {
    "IPType" : "STATIC",
    "IP" : "192.XX.XX.1",
    "Mask" : "255.255.255.0",
    "PortName" : "0"
  }, {
    "IPType" : "STATIC",
    "IP" : "172.XX.XX.10",
    "Mask" : "255.255.255.0",
    "PortName" : "4"
  } ]
}

错误码


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.	智能接入网关离线，请求无法完成。

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