响应示例 { "status" : 1, "message" : "SUC CES S", "error" : null, "data" : { "data" : [ { "streamTotal" : 0, "firmware" : null, "deviceAbility" : "intelligent", "mac" : null, "createTime" : null, "updateTime" : null, "protocolVersion" : null, "deviceIp" : null, "devicePort" : null, "tenantId" : 1, "createdBy" : 101482, "creationDate" : 1616570870000, "lastUpdatedBy" : -1, "lastUpdateDate" : 1627452138000, "fileId" : null, "fileExt" : null, "fileName" : null, "fileSize" : null, "sysType" : null, "webPlayUrl" : null, "isdpDeviceId" : "2102412462WLL4003540-0", "deviceAlarmStatus" : "pulse", "deviceSubType" : "IPC-BOX", "deviceManageState" : "ACTIVATION", "deleteFlag" : "0", "autoJoin" : null, "battery" : null, "longitude" : null, "coordType" : null, "chatJid" : null, "liveChannelId" : null, "create_state" : null, "chatId" : null, "deviceUserId" : null, "buOrgId" : 503, "buOrgName" : "XXXX公司", "appName" : "holosens-server", "entityName" : "device", "deviceGbUsername" : null, "deviceGbPassword" : null, "ownnerName" : null, "deviceUserName" : null, "storageRemain" : null, "customerOrgCode" : null, "customerOrgName" : null } ], "pos" : 0, "total_count" : 1, "entityName" : null }, "timestamp" : "2021-07-28T14:04:20.909+0800" }

响应参数 参数 类型 描述 status int 状态 message String 返回的接口状态描述 error String 错误 data Object 数据 data出参： 参数 类型 描述 streamTotal int 每个通道码流数量 firmware String 摄像头固件版本号 deviceAbility String 能力集 mac String mac地址 createTime String 创建时间 updateTime String 更新时间 protocolVersion String 协议版本 deviceIp String 设备ip devicePort String 设备端口 tenantId int 租户ID createdBy int 设备创建人 creationDate int 设备创建时间 lastUpdatedBy int 设备更新人 lastUpdateDate int 最后更新时间 fileId String 图片编号 fileExt String 文件扩展名 fileName String 文件名称 fileSize String 文件大小 sysType String 系统类型 webPlayUrl String web播放地址 isdpDeviceId String isdp唯一设备ID deviceAlarmStatus String 设备告警状态 deviceSubType String 子设备类型 deviceManageState String 设备管理状态 deleteFlag String 删除标识 autoJoin String 是否主动入会 battery String 电量 longitude String 经度 latitude String 纬度 coordType String 坐标类型 chatJid String IM群组ID liveChannelId String 频道播放ID create_state String 创建状态 chatId String IM聊天ID deviceUserId String 设备使用人ID buOrgId String 组织id buOrgName String 组织名称 appName String 应用名称 entityName String 实体名称 deviceGbUsername String 设备使用人名称 deviceGbPassword String 设备使用人名称对应密码 ownnerName String 设备责任人名称 storageRemain String 存储保留 customerOrgCode String 供应商ID customerOrgName String 供应商名称 deviceState String 设备状态 deviceId String 设备ID channelId String 通道ID deviceName String 设备名称 deviceType String 设备类型 projectName String 项目名称 projectNumber String 项目编码

请求示例 添加国标协议设备 POST /v1/2562572829***/devices/gb/batch-add { "devices" : [ { "device_id" : "952352LWXT***", "device_name": "DEVICE01", "device_username" : "admin", "device_password" : "***", "algorithm": "MD5" } ] }

响应示例 状态码： 200 OK { "failed_num" : 0, "devices" : [ { "device_id" : "952352LWXT***", "sip_server_id" : "3402000000***", "sip_server_domain" : "3402***", "sip_server_host" : "123.123.*.*", "sip_server_port" : "5060", "result" : { "code" : "IVM.0", "msg" : "Success" } } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 failed_num Integer 失败数量 devices Array of BatchAddGBDevicesRespItem objects 添加结果详细信息 表6 BatchAddGBDevicesRespItem 参数 参数类型 描述 device_id String 设备ID，设备唯一标识符 sip_server_id String SIP服务器ID sip_server_domain String SIP服务器域 sip_server_host String SIP服务器地址 sip_server_port String SIP服务器端口 result Result object 错误或成功信息 表7 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息

请求示例 HTTP的示例 PUT /controller/campus/v1/systemparameter/securityconfig/verify-controller HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "controllerValidate" : "true" }

响应参数 返回状态码为200：修改CPE接入非法控制器防范功能开关成功，响应体参考ControllerValidateModifyOutput。 表3 ControllerValidateModifyOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~2048个字符。 - 错误信息。 "OK" controllerValidate string 4~5个字符。 - 校验开关状态，该字段为“true”时，开关已开启，该字段为“false”时，开关未开启。 "true" 返回状态码为500：接口调用内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：修改CPE接入非法控制器防范功能开关成功，响应体参考ControllerValidateModifyOutput。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "OK", "controllerValidate" : "true" } 返回状态码为500：接口调用内部错误，无响应体。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 controllerValidateModifyInput 是 REFERENCE 详细请参见表2。 修改CPE接入非法控制器防范功能开关请求体。 - 表2 ControllerValidateModifyInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 controllerValidate 否 string 4~5个字符。 - 校验开关状态，该字段为“true”时，开关已开启，该字段为“false”时，开关未开启。 "true"

请求示例 HTTP的示例 PUT /controller/sdwan/v1/naas/virtual/device HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "deviceInfos" : [ { "parentId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "tenant1", "isExclusiveResource" : false, "vpnNumber" : 100, "bandWidth" : 100, "siteNumber" : 100, "sdwanBandwidth" : 100, "encryptedSdwanBandwidth" : 100, "vxlanBandwidth" : 100, "status" : 0, "role" : "Interworking Gateway", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1" } ] }

响应示例 返回状态码为200：更新成功返回。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "totalRecords" : 100, "data" : [ { "parentId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "tenant1", "isExclusiveResource" : false, "vpnNumber" : 100, "bandWidth" : 100, "siteNumber" : 100, "sdwanBandwidth" : 100, "encryptedSdwanBandwidth" : 100, "vxlanBandwidth" : 100, "status" : 0, "role" : "Interworking Gateway", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1" } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应示例 返回状态码为200：查询证书校验安全开关信息成功，响应体参考ControllerValidateQueryOutput。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "OK", "controllerValidate" : "true" } 返回状态码为500：接口调用内部错误，无响应体。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：查询证书校验安全开关信息成功，响应体参考ControllerValidateQueryOutput。 表1 ControllerValidateQueryOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~2048个字符。 - 错误信息。 "OK" controllerValidate string 4~5个字符。 - 校验开关状态，该字段为“true”时，开关已开启，该字段为“false”时，开关未开启。 "true" 返回状态码为500：接口调用内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/systemparameter/securityconfig/verify-controller HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

请求示例 HTTP的示例 GET /controller/campus/v1/systemparameter/securityconfig/verify-device HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy