-
响应示例 返回状态码为200：查询成功，响应体参考ScanRuleDeviceQueryOutputDto。 HTTPS 200 OK
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode":"0",
"errmsg":"",
"totalRecords": 1,
"data": [
{
"devIsBound": false,
"id": "d3e43f5a-a654-4ec9-a2bc-34abb43ffa75",
"name": "devcie01",
"esn": "1019A0055991",
"deviceModel": "LSW",
"deviceRole": "ACC",
"manageType": 0,
"siteId": "104d216d-99f9-62ff-f7fa-f1e50024d8d5",
"siteName": "site01",
"mac"："11-11-11-11-11"
}
]
} 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 HTTPS 400 ERROR
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode":"0x00c80014",
"errmsg":"data not exist",
"errdesc": "",
"errreason": "",
"errdetail": "",
"erradvice": ""
} 返回状态码为500：内部错误，响应体参考CommonErrorDto。 HTTPS 500 ERROR
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode":"0x00c80018",
"errmsg":"internal error",
"errdesc": "",
"errreason": "",
"errdetail": "",
"erradvice": ""
}
-
请求示例 HTTP的示例 get /controller/campus/api/v1/terminal/scanrule/devices?siteId=allSites&filter=sortField::+name|keyword::device&page=pageIndex::1|pageSize::100 HTTPS
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AC
CES S-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
-
响应参数 返回状态码为200：查询成功，响应体参考ScanRuleDeviceQueryOutputDto。 表2 ScanRuleDeviceQueryOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~20个字符。 - 状态码，0：请求成功。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "" totalRecords int32 [0-10000] - 总条数。 - data ARRAY_REFERENCE 0-10000个列表项，详细请参见表3。 查询的设备信息。 - 表3 ScanRuleDeviceBaseBean对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 devIsBound boolean true false false 设备是否已绑定规则。 false id string 0~36个字符。 - 设备id。 "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" name string 0~64个字符。 - 设备名称。 "AR500102390000009990" esn string 0~64个字符。 - 设备ESN号。 "AR500102390000009990" deviceModel string 0~64个字符。 - 设备型号。 "AR7030" deviceRole string 0~36个字符。 - 设备角色 "接入" deviceType string 0~12个字符。 - 设备类型，支持以下几种：“AR”、“AP”、“FW”或者“LSW”。 "AP" manageType int32 [0-2] 0 管理对象，0：单设备、1：堆叠、2：堆叠成员 0 siteId string 0~36个字符。 - 设备所属站点的Id。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" siteName string 0~64个字符。 - 设备所属站点名称。 "siteName" mac string 0~18个字符。 - 设备mac。 "xx-xx-xx-xx-xx-xx" 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。 返回状态码为500：内部错误，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。
-
URI /controller/campus/api/campusaccesscfgservice/v1/terminal/scanrule/query-binding-devices 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 0~36个字符。 - 站点ID，查询全部传allSites，查询单站点传对应站点ID。 "3237b6ef-1a3f-4f74-ae4f-7fc47fe92683" filter 否 string 0~200个字符。 - 查询条件。 "sortField::+name|keyword::device" page 否 string 0~32个字符。 - 分页。 "pageIndex::1|pageSize::100"
-
响应示例 返回状态码为200：扫描成功，响应体参考ScanRuleGetOutputDto。 HTTPS 200 OK
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode": "0",
"errmsg": "",
"result": "scan terminal success",
"scanDetailResult": [{
"scanRuleId": "62e1977b-bd6c-46c8-8f8f-e3a1649fa802",
"scanRuleName": "rule01",
"scanSuccessList": [{"deviceName": "dev001"}],
"scanFailList": []
}]
} 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 HTTPS 400 ERROR
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode":"0x00c80014",
"errmsg":"data not exist",
"errdesc": "",
"errreason": "",
"errdetail": "",
"erradvice": ""
} 返回状态码为500：内部错误，响应体参考CommonErrorDto。 HTTPS 500 ERROR
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode":"0x00c80018",
"errmsg":"internal error",
"errdesc": "",
"errreason": "",
"errdetail": "",
"erradvice": ""
}
-
响应参数 返回状态码为200：扫描成功，响应体参考ScanRuleGetOutputDto。 表5 ScanTerminalsOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" result string 0~1024个字符。 - 扫描结果。 "scan terminal success" scanDetailResult ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 立即扫描结果详细信息。 - 表6 ScanDetailResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 scanRuleId string 0~36个字符。 - 扫描规则ID "11111111-1111-1111-1111-111111111112" scanRuleName string 0~128个字符。 - 规则名称 "rule1" errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" scanType int32 [0-1] 0 扫描类型，0表示普通扫描，1表示深度扫描 0 scanSuccessList ARRAY_REFERENCE 0-100个列表项，详细请参见表7。 立即扫描成功列表。 - scanFailList ARRAY_REFERENCE 0-100个列表项，详细请参见表8。 立即扫描失败列表。 - 表7 ScanSuccessList对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 0~36个字符。 - 设备ID "11111111-1111-1111-1111-111111111113" deviceName string 0~64个字符。 - 设备名称 "device1" 表8 ScanFailList对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 0~36个字符。 - 设备ID "11111111-1111-1111-1111-111111111113" deviceName string 0~64个字符。 - 设备名称 "device1" errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。 返回状态码为500：内部错误，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。
-
请求示例 HTTP的示例 post /controller/campus/api/v1/terminal/scanrule/scanTerminal HTTPS
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
{
"scanTerminalList": [
{
"scanRuleId": "62e1977b-bd6c-46c8-8f8f-e3a1649fa802",
"scanDeviceList": [
{
"deviceId": "41875bb9-0fdb-4643-9a8f-ab9719a77ce6",
"deviceName": "dev001"
}
]
}
]
}
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 scanTerminalsDto 是 REFERENCE 详细请参见表2。 发起交换机设备主动扫描探测终端信息 - 表2 ScanTerminalsDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 scanTerminalList 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 绑定设备列表 - scanType 否 int32 [0-1] 0 扫描类型，0表示普通扫描，1表示深度扫描 0 表3 ScanTerminalInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 scanRuleId 否 string 0~36个字符。 - 扫描规则ID "11111111-1111-1111-1111-111111111112" scanDeviceList 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 绑定设备列表 - 表4 ScanDeviceInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 否 string 0~36个字符。 - 设备ID "11111111-1111-1111-1111-111111111113" deviceName 否 string 0~64个字符。 - 设备名称 "device1"
-
请求示例 HTTP的示例 post /controller/campus/api/v1/terminal/scanrule HTTPS
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
{
"id": "f0039bfc-5cf0-1f24-2865-86016a8a83c0",
"name": "scanRule",
"description": "scanRule",
"scanType": [
"Real-time","Periodic"
],
"scanPeriod": 30,
"scanRangeList": [
{
"id": "e555c570-2247-a16e-03e4-033e142474da",
"sourceIp": "xxx",
"vlanId": 1234,
"scanIp": "xxx",
"mask": 24,
"description": "scanRange"
}
],
"vendors": [
"huawei","hikvision","dahua","uniview","tplink"
],
"categories": "ip-camera"
}
-
响应参数 返回状态码为200：更新成功，响应体参考TerminalScanResponse。 TerminalScanResponse对象的参数列表，详细请参见表4。 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。 返回状态码为500：内部错误，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。
-
响应示例 返回状态码为200：更新成功，响应体参考TerminalScanResponse。 HTTPS 200 OK
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode": "0",
"errmsg": "",
"data": {
"id": "f0039bfc-5cf0-1f24-2865-86016a8a83c0",
"name": "scanRule",
"description": "scanRule",
"scanType": [
"Real-time","Periodic"
],
"scanPeriod": 30,
"scanRangeList": [
{
"id": "e555c570-2247-a16e-03e4-033e142474da",
"sourceIp": "xxx",
"vlanId": 1234,
"scanIp": "xxx",
"mask": 24,
"description": "scanRange"
}
],
"vendors": [
"huawei","hikvision","dahua","uniview","tplink"
],
"categories": "ip-camera"
}
} 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 HTTPS 400 ERROR
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode":"0x00c80014",
"errmsg":"data not exist",
"errdesc": "",
"errreason": "",
"errdetail": "",
"erradvice": ""
} 返回状态码为500：内部错误，响应体参考CommonErrorDto。 HTTPS 500 ERROR
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode":"0x00c80018",
"errmsg":"internal error",
"errdesc": "",
"errreason": "",
"errdetail": "",
"erradvice": ""
}
-
响应示例 返回状态码为200：查询成功，响应体参考QueryDevicesOutputDto。 HTTPS 200 OK
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode":"0",
"errmsg":"",
"data": [
{
"devIsBound": false,
"id": "d3e43f5a-a654-4ec9-a2bc-34abb43ffa75",
"name": "devcie01",
"esn": "1019A0055991",
"deviceModel": "LSW",
"deviceRole": "ACC",
"manageType": 0,
"siteId": "104d216d-99f9-62ff-f7fa-f1e50024d8d5",
"siteName": "site01",
"mac"："11-11-11-11-11"
}
]
} 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 HTTPS 400 ERROR
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode":"0x00c80014",
"errmsg":"data not exist",
"errdesc": "",
"errreason": "",
"errdetail": "",
"erradvice": ""
} 返回状态码为500：内部错误，响应体参考CommonErrorDto。 HTTPS 500 ERROR
Date: Jan,13 Fri 2023 10:00:00 GMT
Server: example-server
Content-Type: application/json
{
"errcode":"0x00c80018",
"errmsg":"internal error",
"errdesc": "",
"errreason": "",
"errdetail": "",
"erradvice": ""
}
-
响应参数 返回状态码为200：查询成功，响应体参考QueryDevicesOutputDto。 表3 QueryDevicesOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~20个字符。 - 状态码，0：请求成功。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "" data ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 查询的设备信息。 - 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。 返回状态码为500：内部错误，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。
-
请求示例 HTTP的示例 post /controller/campus/api/v1/terminal/scanrule/devices/action/batch-query HTTPS
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
{
"deviceIds": ['f0039bfc-5cf0-1f24-2865-86016a8a83c0', 'e555c570-2247-a16e-03e4-033e142474da']
}
-
请求示例 HTTP的示例 get /controller/campus/api/v1/terminal/scanrule/scanrules?filter=sortField::+name|keyword::rule&page=pageIndex::1|pageSize::10 HTTPS
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925
