-
该接口用于增加新的设备关系。注意事项目前支持两种关系类型,一种关系类型是邻接关系(ADJOIN),单向邻接关系(UNILATERAL)。对于邻接关系来说,在添加关系时,添加了A->B关系的同时也添加B→A的关系,二者的关系具有自反性。对于单向邻接关系来说,只单向添加逻辑,例如,A→B→C,只能单向查找关系,不具有自反性。可以反应出流程,例如水流从阀门A经过阀门B再到阀门C,关闭阀门A之后,B和C阀门即可以无需关闭,leftPart存储上游设备,rightPart存储下游设备。基本信息接口名称addDeviceRelation接口路径/service/Device/0.1.0/DeviceRelation/create接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选(M)/可选(O)参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言,如zh_CN。deviceRelationDeviceRelation[]MBody设备关系数组。表2 DeviceRelation参数说明 名称类型必选(M)/可选(O)位置描述sourceDeviceCodeStringMDeviceRelation待创建设备关系源设备Code。长度不超过255字节。对于单向关系来说,该字段为下游设备。relatedDeviceCodeStringMDeviceRelation设备关系关联设备Code。长度不超过255字节。对于单向关系来说,该字段为上游设备。relationTypeCodeStringMDeviceRelation设备关系类型编码。长度不超过64字节。可通过如下方式获取设备关系类型编码:在AppCube平台首页单击“管理”,进入租户管理台。选择“应用管理 > BO配置”。单击“Device”,打开设备BO的配置界面。选择“设备规格配置 > 设备关系类型配置”,查看设备关系类型编码。请求样例{ "deviceRelation": [{ "sourceDeviceCode": "Device201912271424430000013238", "relatedDeviceCode": "Device201912271500390000013239", "relationTypeCode": "ADJOIN" }] }响应参数响应参数如表3所示。表3 响应参数说明参数名称类型必选(M)/可选(O)参数位置参数含义resCodeStringMBody返回码。resMsgStringOBody返回消息。resultOutputs[]MBody接口响应参数。表4 Outputs参数说明 参数名称类型必选(M)/可选(O)参数位置参数含义idsStringOOutputs新创建的设备关系ID列。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ "ids": "0E22000000WErL82Co76" }] }
-
该接口用于变更设备关系的生命周期状态为已启用。仅当设备关系的状态为已禁用时,可以变更状态为已启用。注意事项无。基本信息接口名称enableDeviceRelation接口路径/service/Device/0.1.0/enableDeviceRelation/{id}接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选(M)/可选(O)参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言,如zh_CN。idStringMPath设备关系ID。请求样例无响应参数响应参数如表2所示。表2 响应参数说明参数名称类型必选(M)/可选(O)参数位置参数含义resCodeStringMBody返回码。resMsgStringOBody返回消息。resultOutputs[]MBody接口响应参数。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ }] }
-
该接口用于删除已有的设备关联关系。注意事项目前支持两种关系类型,一种关系类型是 邻接关系(ADJOIN),单向邻接关系(UNILATERAL)。对于邻接关系来说,在添加关系时,添加了A->B关系的同时也添加B→A的关系,二者的关系具有自反性。对于单向邻接关系来说,只单向添加逻辑,例如,A→B→C,只能单向查找关系,不具有自反性。可以反应出流程,例如水流从阀门A经过阀门B再到阀门C,关闭阀门A之后,B和C阀门即可以无需关闭,leftPart存储上游设备,rightPart存储下游设备。基本信息接口名称deleteDeviceRelation接口路径/service/Device/0.1.0/DeviceRelation接口协议HTTPS接口方法DELETE请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选(M)/可选(O)参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言,如zh_CN。deviceRelationArray<DeviceRelation>MBody设备关系数组。表2 DeviceRelation参数说明 名称类型必选(M)/可选(O)位置描述relatedDeviceCodeStringMDeviceRelation设备关系关联设备Code。对于单向关系来说,该字段为上游设备。relationTypeCodeStringMDeviceRelation设备关系类型Code。目前支持的取值为ADJOIN,CONTAINsourceDeviceCodeStringMDeviceRelation待删除设备关系源设备Code。对于单向关系来说,该字段为下游设备。请求样例{ "deviceRelation": [{ "relatedDeviceCode": "Device201912211600570000013189", "relationTypeCode": "ADJOIN", "sourceDeviceCode": "Device201912231031180000013202" }] }响应参数响应参数如表3所示。表3 响应参数说明参数名称类型必选(M)/可选(O)参数位置参数含义resCodeStringMBody返回码。resMsgStringOBody返回消息。resultOutputs[]MBody接口响应参数。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ }] }
-
功能描述该接口用于获取指定摄像头的录像播放地址。注意事项无。基本信息接口名称获取录像回放地址v1.1外部接口路径/io-adapter/south/video-surveillance/v1.1/get-playback-urlHTTP方法POST请求参数请求参数如表1所示。表1 请求消息参数说明参数名称类型必选(M)/可选(O)位置参数含义X-HW-APPKEYStringOHeaderROMA授权的应用的密钥。说明:如果调用侧在ROMA平台设置了白名单,该参数可不填,如果没有,该参数必填。X-HW-IDStringMHeaderROMA授权的应用ID。channelStringMHeader选择的子系统渠道。由上层应用携带,供ROMA平台做路由选择。厂家无需实现。cameraIdStringMBody摄像头ID。mediaTypeStringMBody返回的视频媒体类型。RTMPMP4HTTP-FLVstartTimeStringMBody录像开始时间,毫秒时间戳。endTimeStringMBody录像结束时间,毫秒时间戳。当mediaType=MP4时,最多获取60秒视频,即endTime-startTime最多支持60秒。streamTypeStringOBody码流类型,默认使用主码流。1:表示主码流2:表示子码流3:表示第三码流protocolTypeIntOBodyurl协议类型,默认值1。1 http2 https注意:HTTP为不安全协议,建议使用安全协议HTTPS。extensionextensionOBody扩展对象。用于携带厂家定义的特有字段。返回媒体类型为MP4时,该字段非必填。templetIdStringOBody视频转码的模板ID,默认值为“100001”,为透传模板,视频透传,静音。H265编码的视频转H264时,必须要选转码模板。具体的转码模板说明请参见录像视频转码模板说明。clientTypeIntOquery客户端类型,默认值1。1:表示标准RTSP客户端。5:表示获取外域设备的短URL,当设备为外域时必填。表2 请求消息参数说明 参数名称类型必选(M)/可选(O)位置参数含义nvrCodeStringOextensionNVR编码。请求样例{ "cameraId": "03208476744846850101#8e5ec0b8cf624f82ad410a7b5b0a6847", "mediaType": "HTTP-FLV", "startTime": "1584266719000", "endTime": "1584270319000", "extension": { "nvrCode": "be159ef0892542fe8e55050a43e5a52c" } }响应参数响应参数如表3所示。表3 响应消息参数说明参数名称类型参数含义resCodeString返回码。“0”表示成功,其他错误码请参考“视频调阅错误码”。resMsgString返回信息。originalResInfooriginalResInfo原始响应参数。resultresultObj接口响应参数。表4 originalResInfo参数说明 参数名称类型参数含义originalResCodeString原始返回码。originalResMsgString原始返回消息。表5 resultObj参数说明 参数名称类型参数含义urlString返回的实况播放地址。extensionextension扩展字段,用于传递不同厂家特有的字段。媒体类型为MP4时,无该字段返回。表6 extension参数说明 参数名称类型参数含义fileIdString返回的录像文件ID,用于录像播放的媒体控制。响应样例{ "resCode": "0", "resMsg": "Success.", "originalResInfo": { "originalResCode": "0", "originalResMsg": "SUCCESS" }, "result": { "url": "https://43.xx.xx.249:8000/flv/MT_20200316114203670aFQDvuD0QbcL?cid=03208476744846850101_8e5ec0b8cf624f82ad410a7b5b0a6847&stype=1&ttype=100001&st=20200315100519&et=20200315110519&sn=MT_20200316114203670aFQDvuD0QbcL&rm=0&nc=be159ef0892542fe8e55050a43e5a52c&encrypt=ieTgsKz6A9TFGXkg×tamp=1584330123670", "extension": { "fileId": "MT_20200316114203670aFQDvuD0QbcL" } } }
-
功能描述该接口用于获取指定摄像头的实况播放地址。注意事项无。基本信息接口名称获取实况播放地址v1.1外部接口路径/io-adapter/south/video-surveillance/v1.1/get-live-urlHTTP方法POST请求参数请求参数如表1所示。表1 请求消息参数说明参数名称类型必选(M)/可选(O)位置参数含义X-HW-APPKEYStringOHeaderROMA授权的应用的密钥。说明:如果调用侧在ROMA平台设置了白名单,该参数可不填,如果没有,该参数必填。X-HW-IDStringMHeaderROMA授权的应用ID。channelStringMHeader选择的子系统渠道。由上层应用携带,供ROMA平台做路由选择。厂家无需实现。cameraIdStringMBody摄像头ID。mediaTypeStringMBody返回的视频媒体类型。RTMPHLSHTTP-FLVprotocolTypeIntOBodyurl协议类型,默认值1。1 http2 https注意:HTTP为不安全协议,建议使用安全协议HTTPS。templetIdStringOBody视频转码的模板ID,默认值为“000001”,为透传模板,视频透传,静音。H265编码的视频转H264时,必须要选转码模板。具体的转码模板说明请参见直播视频转码模板说明。clientTypeIntOquery客户端类型,默认值1。1:表示标准RTSP客户端。5:表示获取外域设备的短URL,当设备为外域时必填。streamTypeIntOBody视频的主副码流。1:主码流2:辅码流3:第三码流请求样例{ "cameraId": "08398343702013030101#9459fe3bfa424f959bed0504a469093d", "mediaType": "RTMP" }响应参数响应参数如表2所示。表2 响应消息参数说明参数名称类型参数含义resCodeString返回码。“0”表示成功,其他错误码请参考“视频调阅错误码”。resMsgString返回消息。originalResInfooriginalResInfo原始响应参数。resultresult接口响应参数。表3 originalResInfo参数说明 参数名称类型参数含义originalResCodeString原始返回码。originalResMsgString原始返回消息。表4 result参数说明 参数名称类型参数含义urlString返回的实况播放地址。响应样例{ "resCode": "0", "resMsg": "Success.", "originalResInfo": { "originalResCode": "0", "originalResMsg": "SUCCESS" }, "result": { "url": "rtmp://10.170.136.234:1935/live/08398343702013030101_9459fe3bfa424f959bed0504a469093d" } }
-
功能描述该接口用于控制摄像头的云台转动,以及镜头的变倍、变焦。注意事项无。基本信息接口名称云台控制v1.1外部接口路径/io-adapter/south/video-surveillance/v1.1/controlPTZHTTP方法POST请求参数请求参数如表1所示。表1 请求消息参数说明参数名称类型必选(M)/可选(O)位置参数含义X-HW-APPKEYStringOHeaderROMA授权的应用的密钥。说明:如果调用侧在ROMA平台设置了白名单,该参数可不填,如果没有,该参数必填。X-HW-IDStringMHeaderROMA授权的应用ID。channelStringMHeader选择的子系统渠道。由上层应用携带,供ROMA平台做路由选择。cameraIdStringMBody摄像头ID。controlCodeStringMBody云台控制码,详见云台控制码、控制参数说明。controlParam1StringOBody云台控制参数1,详见云台控制码、控制参数说明。云台控制码为“PTZ_STOP”、“PTZ_AUTO”、“PTZ_FLIP”、“PTZ_START”时可不填,为其他值时,必填。当云台控制码支持“1”或“2”,输入“1”或“2”之外的其他值时,无效。当云台控制码只支持“2”,输入任何值都当作“2”处理。controlParam2StringOBody云台控制参数2,详见云台控制码、控制参数说明。云台控制码为“PTZ_STOP”、“PTZ_AUTO”、“PTZ_FLIP”、“PTZ_START”时可不填,为其他值时,必填。表2 云台控制码、控制参数说明 云台控制码云台控制参数1云台控制参数2描述PTZ_STOP空值空值云台停止转动。PTZ_UP1:点动模式2:连续模式步长/速度(1-10)云台向上转动。连续模式下使用1-PTZ_STOP停止转动。PTZ_DOWN1:点动模式2:连续模式步长/速度(1-10)云台向下转动。连续模式下使用1-PTZ_STOP停止转动。PTZ_LEFT1:点动模式2:连续模式步长/速度(1-10)云台向左转动。连续模式下使用1-PTZ_STOP停止转动。PTZ_UP_LEFT1:点动模式2:连续模式步长/速度(1-10)云台左上转动。连续模式下使用1-PTZ_STOP停止转动。PTZ_DOWN_LEFT1:点动模式2:连续模式步长/速度(1-10)云台左下转动。连续模式下使用1-PTZ_STOP停止转动。PTZ_RIGHT1:点动模式2:连续模式步长/速度(1-10)云台向右转动。连续模式下使用1-PTZ_STOP停止转动。PTZ_UP_RIGHT1:点动模式2:连续模式步长/速度(1-10)云台右上转动。连续模式下使用1-PTZ_STOP停止转动。PTZ_DOWN_RIGHT1:点动模式2:连续模式步长/速度(1-10)云台右下转动。连续模式下使用1-PTZ_STOP停止转动。PTZ_AUTO空值空值云台自动控制。PTZ_FLIP空值空值云台翻转180度。PTZ_START空值空值云台转至起始位。PTZ_LENS_APERTURE_OPEN2:连续模式速度(1-10)光圈放大。PTZ_LENS_APERTURE_CLOSE2:连续模式速度(1-10)光圈缩小。PTZ_LENS_ZOOM_IN2:连续模式速度(1-10)范围放大。PTZ_LENS_ZOOM_OUT2:连续模式速度(1-10)范围缩小。PTZ_LENS_FOCAL_NEAR2:连续模式速度(1-10)聚焦近。PTZ_LENS_FOCAL_FAR2:连续模式速度(1-10)聚焦远。请求样例{ "cameraId": "08398343702361570101#9459fe3bfa424f959bed0504a469093d", "controlCode": "PTZ_DOWN", "controlParam1": "1", "controlParam2": "2" }响应参数响应参数如表3所示。表3 响应消息参数说明参数名称类型参数含义resCodeString返回码。“0”表示成功,其他错误码请参考“视频调阅错误码”。resMsgString返回消息。originalResInfooriginalResInfo原始响应消息。表4 originalResInfo参数说明 参数名称类型参数含义originalResCodeString原始返回码。originalResMsgString原始返回消息。响应样例{ "resCode": "0", "resMsg": "Success.", "originalResInfo": { "originalResCode": "0", "originalResMsg": "SUCCESS" } }
-
南方中心伟岸众横的地图今天加载报错,昨天还是好的加载地图一直超时
-
该接口用于从租户中导出设备产品接口。该接口主要用于同步数据给数据平台贴源层,同步给第三方子系统,或在设备管理界面上的文件导出。导出时有记录数限制,最大不超过1000条。如果当前数据超过这个数量,则需要调用方分多次调用此接口。当增量导出时,该接口会返回指定时间段内新增或变更的记录,但删除的记录不会携带。如果该记录在业务上无需再使用,应更新该记录的状态字段,并作为变更的记录返回。注意事项无。基本信息接口名称exportDeviceProducts接口路径/service/Device/0.1.0/DeviceProduct/export接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选(M)/可选(O)参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言。如zh_CN。conditionQueryConditionOBody查询参数对象。cursorNumberOBody本次导出的游标,表示起始位置。该字段的值是在连续导出的上次调用时返回的。IsIncrementBooleanOBody是否增量导出。默认为全量。fromTimeDatetimeOBody当为增量导出时,该字段必填,表示有更新数据的起始时间,应精确到秒。toTimeDatetimeOBody当为增量导出时,该字段可选,表示有更新数据的结束时间,应精确到秒,默认为当前时间。limitNumberOBody用户自定义一次导出数据条数(不填默认1000)。表2 QueryCondition 参数名称类型必选(M)/可选(O)参数位置参数含义deviceDefinitionCodeParameterODeviceProductQueryCondition设备产品所属的设备规格Code,通过“查询设备规格”获取规格Code值。允许的算子包括:=,in。表3 Parameter 参数名称类型必选(M)/可选(O)参数位置参数含义valueAnyOParameter查询条件的参数值,适用于算子为=,<,>等单值的参数。当算子为in或between时,参数值为一个数组。operatorStringOParameter查询条件的算子。包括:=,<,>,like,in。不同的查询条件所允许的算子不同。不填则默认为=。请求样例{ "condition": { }, "cursor": 0, "isIncrement": false }响应参数响应参数如表4所示。表4 响应参数说明参数名称类型必选(M)/可选(O)参数位置参数含义resultOutputsOBody接口响应参数。resCodeStringMBody设备服务的返回码。resMsgStringOBody设备服务的返回消息。表5 Outputs 参数名称类型必选(M)/可选(O)参数位置参数含义recordsDeviceProductRecord[]OBody/result/outputs本次调用返回的记录。countNumberOBody/result/outputs符合条件的记录总数。长度范围最大20位数字。cursorNumberOBody/result/outputs本次导出接口返回的游标,表示结束位置。用于连续导出的下次接口调用。如果本次调用已经返回完了所有数据,无需下次调用,则该字段为空。长度范围最大20字符。表6 DeviceProductRecord 参数名称类型必选(M)/可选(O)参数位置参数含义idStringMDeviceProductRecord设备产品ID。长度范围20字符。definitionCodeStringMDeviceProductRecord设备规格编码。长度范围最大64字符。productCodeStringMDeviceProductRecord设备产品编码。长度范围最大64字符。productNameStringODeviceProductRecord设备产品名称。长度范围最大64字符。modelStringODeviceProductRecord设备产品型号。长度范围最大128字符。brandStringODeviceProductRecord设备产品品牌。长度范围最大128字符。manufacturerStringODeviceProductRecord设备产品生产厂商。长度范围最大128字符。displayTemplateStringODeviceProductRecord设备产品显示模板。长度范围最大128字符。statusStringODeviceProductRecord设备产品状态。长度范围最大255字符。包括:VALID:生效INVALID:失效descriptionStringODeviceProductRecord描述。长度范围最大256k字符。categoryCodeStringODeviceProductRecord归属规格的默认分类Code。长度范围最大 64字符。categoryNameStringODeviceProductRecord归属规格的默认分类名称。长度范围最大65535字符。categoryNameTypeIdStringODeviceProductRecord归属规格的默认分类多语言ID。长度范围最大20字符。actionTypeStringODeviceRecord操作类型。当请求为增量同步模式时返回。包括:INSERT:新增记录。UPDATE:更新记录。长度范围最大6字符。insertTimeDateTimeODeviceRecord该记录在源表里的添加时间。updateTimeDateTimeODeviceRecord该记录在源表里的更新时间。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ "count": 2, "cursor": null, "isIncrement": false, "records": [{ "brand": "tem1", "displayTemplate": "显示模板", "id": "050S000000ScpDgKZ6wq", "insertTime": "2019-08-14 16:09:08", "model": "tem1", "productCode": "tem1", "productName": "tem1", "status": "VALID", "updateTime": "2019-08-14 16:14:17" }, { "brand": "蓝居", "categoryCode": "BUED-ENV", "categoryName": "环境传感器", "definitionCode": "IndoorEnvSensor", "id": "050S000000TVAMRTQxrU", "insertTime": "2019-09-16 09:55:41", "model": "UMINI208", "productCode": "UMINI208", "productName": "蓝居", "status": "VALID", "updateTime": "2019-09-16 09:55:41" } ] } ] }
-
该接口用于从租户中导出设备规格接口。该接口主要用于同步数据给数据平台贴源层,同步给第三方子系统,或在设备管理界面上的文件导出。导出时有记录数限制,最大不超过1000条。如果当前数据超过这个数量,则需要调用方分多次调用此接口。当增量导出时,该接口会返回指定时间段内新增或变更的记录,但删除的记录不会携带。如果该记录在业务上无需再使用,应更新该记录的状态字段,并作为变更的记录返回。注意事项无。基本信息接口名称exportDeviceDefinitions接口路径/service/Device/0.1.0/DeviceDefinition/export接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选(M)/可选(O)参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言。如zh_CN。conditionQueryConditionOBody查询参数对象。cursorStringOBody本次导出的游标,表示起始位置。该字段的值是在连续导出的上次调用时返回的。isIncrementBooleanOBody是否增量导出。默认为全量。fromTimeDatetimeOBody当为增量导出时,该字段必填,表示有更新数据的起始时间,应精确到秒。toTimeDatetimeOBody当为增量导出时,该字段可选,表示有更新数据的结束时间,应精确到秒,默认为当前时间。limitNumberOBody用户自定义一次导出数据条数(不填默认1000)表2 QueryCondition 参数名称类型必选(M)/可选(O)参数位置参数含义definitionCategoryCodeParameterODeviceDefinitionQueryCondition设备规格所属的分类Code,通过“查询设备规格分类”获取分类Code值。允许的算子包括:=。表3 Parameter 参数名称类型必选(M)/可选(O)参数位置参数含义valueAnyOParameter查询条件的参数值,适用于算子为=,<,>等单值的参数。当算子为in或between时,参数值为一个数组。operatorStringOParameter查询条件的算子。包括:=,<,>,like,in。不同的查询条件所允许的算子不同。不填则默认为=。请求样例{ "cursor": 0, "condition": { }, "isIncrement": false, "fromTime": "1970-01-01 00:00:00", "toTime": "2019-08-30 14:45:08", "limit": 2 }响应参数响应参数如表4所示。表4 响应参数说明参数名称类型必选(M)/可选(O)参数位置参数含义resultOutputsOBody接口响应参数。resCodeStringMBody设备服务的返回码。resMsgStringOBody设备服务的返回消息。表5 Outputs 参数名称类型必选(M)/可选(O)参数位置参数含义recordsDeviceDefinitionRecord[]OBody/result/outputs本次调用返回的记录。countNumberOBody/result/outputs符合条件的记录总数。长度范围最大20位数字。cursorNumberOBody/result/outputs本次导出接口返回的游标,表示结束位置。用于连续导出的下次接口调用。如果本次调用已经返回完了所有数据,无需下次调用,则该字段为空。长度范围最大20字符。表6 DeviceDefinitionRecord 参数名称类型必选(M)/可选(O)参数位置参数含义idStringMDeviceDefinitionRecord设备规格ID。长度范围20字符。definitionCodeStringMDeviceDefinitionRecord设备规格编码。长度范围最大64字符。deviceNameStringODeviceDefinitionRecord设备规格名称。长度范围最大65535字符。deviceNameTypeIdStringODeviceDefinitionRecord设备规格名称对应的多语言ID。descriptionStringODeviceDefinitionRecord设备规格描述。长度范围最大256k字符。descriptionTypeIdStringODeviceDefinitionRecord设备规格描述多语言ID。长度范围最大20字符。defaultChannelCodeStringODeviceDefinitionRecord设备规格默认渠道Code。长度范围最大64字符。defaultChannelNameStringODeviceDefinitionRecord设备规格默认渠道Name。长度范围最大65535字符。defaultChannelNameTypeIdStringODeviceDefinitionRecord设备规格默认渠道多语言ID。长度范围最大20字符。definitionCategoryCodeStringODeviceDefinitionRecord设备规格分类编码。长度范围最大64字符。definitionCategoryNameStringODeviceDefinitionRecord分类名称。长度范围最大65535字符。definitionCategoryNameTypeIdStringODeviceDefinitionRecord分类名称对应的多语言ID。actionTypeStringODeviceDefinitionRecord操作类型。当请求为增量同步模式时返回。包括:INSERT:新增记录UPDATE:更新记录长度范围最大6字符。insertTimeDateTimeODeviceDefinitionRecord该记录在源表里的添加时间。updateTimeDateTimeODeviceDefinitionRecord该记录在源表里的更新时间。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ "count": 138, "cursor": 2, "records": [{ "defaultChannelCode": "basepoint.connectionmax.iot", "defaultChannelName": "新基点IoT", "definitionCategoryCode": "PSS-SS03", "definitionCategoryName": "出入口控制", "definitionCategoryNameTypeId": "003J000000UYDYITmmsS", "definitionCode": "YKT", "description": "一卡通设备", "deviceName": "一卡通设备", "deviceNameTypeId": "003J000000QToTZnssj2", "id": "0507000000QToUrIhhJI", "insertTime": "2019-05-26 12:47:29", "updateTime": "2019-10-25 18:02:16" }, { "defaultChannelCode": "basepoint.connectionmax.iot", "defaultChannelName": "新基点IoT", "definitionCategoryCode": "PSS-SS03", "definitionCategoryName": "出入口控制", "definitionCategoryNameTypeId": "003J000000UYDYITmmsS", "definitionCode": "AccessControl", "description": "门禁", "deviceName": "门禁", "deviceNameTypeId": "003J000000RdikY7nAe0", "id": "0507000000RVThQfuoxU", "insertTime": "2019-07-03 21:23:12", "updateTime": "2019-10-25 17:06:57" }] }] }
-
该接口用于从租户中导出设备实例,主要用于同步数据给数据平台贴源层,同步给第三方子系统,或在设备管理界面上的文件导出。导出时有记录数限制,最大不超过1000条。如果当前数据超过这个数量,则需要调用方分多次调用此接口。当增量导出时,该接口会返回指定时间段内新增或变更的记录。如果该记录在业务上无需再使用,其状态字段(status)为“DELETED",表示该设备被软删除。注意事项无。基本信息接口名称exportDeviceInstances接口路径/service/Device/0.1.0/Device/export接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选(M)/可选(O)参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言,如zh_CN。conditionQueryConditionOBody查询参数对象。cursorNumberOBody本次导出的游标,表示起始位置。该字段的值是在连续导出的上次调用时返回的。isIncrementBooleanOBody是否增量导出。默认为全量。true:增量false:全量fromTimeDatetimeOBody当为增量导出时,该字段必填,表示有更新数据的起始时间,应精确到秒。toTimeDatetimeOBody当为增量导出时,该字段可选,表示有更新数据的结束时间,应精确到秒,默认为当前时间。limitNumberOBody用户自定义一次导出数据条数(不填默认1000)。表2 QueryCondition 参数名称类型必选(M)/可选(O)参数位置参数含义deviceDefinitionCodeParameterODeviceQueryCondition设备实例所属的类型编码,通过“查询设备规格定义”的DE_DeviceDef获取Code字段。允许的算子包括:=。deviceDefCategoryCodeParameterODeviceQueryCondition设备规格所属的分类Code,通过“查询设备规格分类”获取分类Code值。允许的算子包括:=。statusparameterODeviceQueryCondition设备实例状态。UNREG:未注册ACTIVE:生效INACTIVE:失效DELETED:删除允许的算子包括:=。deviceAttrDeviceAttrParameter[]ODeviceQueryCondition设备实例的扩展属性。可以传入多个扩展属性作为查询条件。spaceInPathParameterODeviceQueryCondition设备实例所在空间位置。可以是空间路径中的某个节点ID。允许的算子包括:=, in。表3 Parameter 参数名称类型必选(M)/可选(O)参数位置参数含义valueAnyOParameter查询条件的参数值,适用于算子为=,<,>等单值的参数。当算子为in或between时,参数值为一个数组。valueListAnyOParameter当算子为in或between时,参数值为一个数组。operatorStringOParameter查询条件的算子。包括:=,<,>,like,in。不同的查询条件所允许的算子不同。不填则默认为=。表4 DeviceAttrParameter 参数名称类型必选(M)/可选(O)参数位置参数含义codeParameterMDeviceAttrParameter设备属性定义的标识符。允许的算子包括:=。attrValueParameterMDeviceAttrParameter设备实例属性的值。允许的算子包括:=,in。请求样例{ "cursor": 0, "condition": { }, "isIncrement": true, "fromTime": "2022-01-10 00:00:00", "limit": 1, "toTime": "2022-12-10 14:45:08" }响应参数响应参数如表5所示。表5 响应参数说明参数名称类型必选(M)/可选(O)参数位置参数含义resultOutputsOBody接口响应参数。resCodeStringMBody设备服务的返回码。resMsgStringOBody设备服务的返回消息。表6 Outputs 参数名称类型必选(M)/可选(O)参数位置参数含义recordsDeviceRecord[]OBody/result/outputs本次调用返回的记录。countNumberOBody/result/outputs符合条件的记录总数。长度范围最大20位数字。cursorNumberOBody/result/outputs本次导出接口返回的游标,表示结束位置。用于连续导出的下次接口调用。如果本次调用已经返回完了所有数据,无需下次调用,则该字段为空。长度范围最大20字符。表7 DeviceRecord 参数名称类型必选(M)/可选(O)参数位置参数含义idStringODeviceRecord设备实例ID。长度范围20字符。deviceCodeStringODeviceRecord设备实例编码。长度范围最大64字符。externalCodeStringODeviceRecord设备实例外部编码。长度范围最大255字符。deviceNameStringODeviceRecord设备实例名称。长度范围最大65535字符。deviceDefinitionCodeStringODeviceRecord设备规格Code。长度范围最大64字符。deviceProductCodeStringODeviceRecord设备产品Code。长度范围最大64字符。channelCodeStringODeviceRecord设备渠道Code。长度范围最大64字符。remarkStringODeviceRecord备注。长度范围最大256k字符。statusStringODeviceRecord设备状态。长度范围最大255字符。包括:UNREG:未注册ACTIVE:生效INACTIVE:失效DELETED:删除spaceCodeStringODeviceRecord设备归属空间Code。长度范围最大 64字符。space_<levelCode>StringODeviceRecord设备归属空间层级Code。长度范围最大70字符。例如:space_PARKlatitudeStringODeviceRecord设备位置-维度。长度范围最大255字符。longitudeStringODeviceRecord设备位置-经度。长度范围最大255字符。altitudeStringODeviceRecord设备位置-高度。长度范围最大255字符。buildingStringODeviceRecord设备位置-楼栋。长度范围最大255字符。floorStringODeviceRecord设备位置-楼层。长度范围最大255字符。channelNameStringODeviceRecord设备来源渠道。长度范围最大65535字符。channelNameTypeIdStringODeviceRecord设备渠道多语言ID。长度范围最大20字符。productModelStringODeviceRecord产品型号。长度范围最大128字符。productBrandStringODeviceRecord产品品牌。长度范围最大128字符。productManufacturerStringODeviceRecord产品厂家。长度范围最大128字符。categoryCodeStringODeviceRecord设备规格默认分类Code。长度范围最大 64字符。categoryNameStringODeviceRecord设备规格默认分类名称。长度范围最大65535字符。categoryNameTypeIdStringODeviceRecord设备规格默认分类多语言ID。长度范围最大20字符。ex_<attrCode>StringODeviceRecord设备的扩展属性值。字段中的<attrCode>表示设备BO中定义的该类型的扩展属性编码。一个设备实例可以有多个ex_<attrCode>字段。例如ex_deviceType,ex_deviceLevel等。扩展名长度范围最大67字符;扩展属性值长度范围最大262144。actionTypeStringODeviceRecord操作类型。当请求为增量同步模式时返回。包括:INSERT:新增记录。UPDATE:更新记录。长度范围最大6字符。insertTimeDateTimeODeviceRecord该记录在源表里的添加时间。updateTimeDateTimeODeviceRecord该记录在源表里的更新时间。connectStatusStringODeviceRecord设备的连接状态:“0”:已连接“1”:未连接“2”:不需要连接默认值为“2”telemetryPeriodNumberODeviceRecord设备实例遥测周期。单位:秒。statusCodeStringODeviceRecord设备状态标志位,不存在时返回空字符串。第1位表示是否启用,第2位表示是否在线,第3位表示是否故障,第4位表示是否运行,第5位表示是否手动,第6位表示是否可用。如:1xxxxx启用,x1xxxx在线、xx1xxx故障、xxx1xx运行、xxxx1x手动、xxxxx1可用gatewayIdStringODeviceRecord设备所属网关的外部编码。deviceNumberStringODeviceRecord设备编号。响应样例{ "resCode": "0", "resMsg": "成功", "result": [ { "count": 34, "cursor": 1, "records": [ { "actionType": "INSERT", "altitude": "", "building": "", "categoryCode": "BCSS", "categoryName": "楼宇控制与安全系统", "categoryNameTypeId": "003J000000nlxtM4ynDs", "channelCode": "huawei.oc.hlink.iot", "channelName": null, "channelNameTypeId": "003J000000piirP8Ge5A", "connectStatus": "1", "deviceCode": "Device2022011116342900000000000000000564", "deviceDefinitionCode": "IoTGateWay", "deviceName": "测试网关导入2", "deviceNumber": "GATEWAY-1-1-12", "deviceProductCode": "AR502H", "externalCode": "测试网关导入2cX60000000pXbBK8wM0u", "floor": "", "gatewayId": null, "id": "050C000000qD5Mawd8rY", "insertTime": "2022-01-11 16:34:29", "latitude": "", "longitude": "", "productBrand": "AR", "productManufacturer": "华为", "productModel": "AR502H", "remark": null, "spaceCode": "济南市", "space_community": "3", "status": "ACTIVE", "statusCode": "100xxx", "telemetryPeriod": 0, "updateTime": "2022-01-11 16:34:29" } ] } ] }
-
该接口用于更新设备产品的定义,更新的信息包含产品的基本信息、产品属性列表、服务列表、消息列表、附件列表。注意事项无。基本信息接口名称updateDeviceProduct接口路径/service/Device/0.1.0/DeviceProduct/update/{id}接口协议HTTPS接口方法POST请求参数表1 请求参数说明 参数名称类型必选(M)/可选(O)参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言。如zh_CN。idStringMPath设备产品ID,长度不超过20字节。codeStringOBody设备产品的标识符。唯一标识一个产品,长度不超过64字节。productNameStringOBody设备产品的名称。长度不超过64字节。modelStringOBody设备产品的型号。长度不超过128字节。brandStringOBody设备产品的品牌。长度不超过128字节。manufacturerStringOBody设备产品的厂商。长度不超过128字节。displayTemplateStringOBody设备产品的显示模板。长度不超过128字节。descriptionStringOBody设备产品的描述文本。长度不超过262144字节。manufacturerCodeStringOBody设备产品的厂商编号。长度不超过255字节。protocolTypeStringOBody设备产品的协议类型。长度不超过255字节。deviceProductAttributeDeviceProductAttribute[]OBody设备产品具有的属性列表。deviceProductMessageDeviceProductMessage[]OBody设备产品能上报的消息列表。deviceProductServiceDeviceProductService[]OBody设备产品支持的服务列表。deviceProductAttachmentDeviceProductAttachment[]OBody设备产品附件列表表2 DeviceProductAttribute参数说明 参数名称类型必选(M)/可选(O)参数位置参数含义actionStringMDeviceProductAttribute操作类型。包括:ADD:添加属性。DEL:删除属性。CHG:修改属性。idStringODeviceProductAttribute属性ID,action为DEL和CHG时必填。长度不超过20字节。inheritModeStringODeviceProductAttribute属性规格继承模式。EXTRA:额外新增属性。UNSUPPORT:不继承的属性。fromAttributeStrinODeviceProductAttribute不继承的属性关联ID。长度不超过255字节。attributeDefIdStringODeviceProductAttribute属性规格。其值为属性规格的编码。长度不超过20字节。attrValueStringODeviceProductAttribute属性值。长度不超过128字节。remarkStringODeviceProductAttribute备注文本。长度不超过262144字节。表3 DeviceProductMessage参数说明 参数名称类型必选(M)/可选(O)参数位置参数含义actionStringMDeviceProductMessage操作类型。包括:ADD:添加属性。DEL:删除属性。idStringODeviceProductMessage消息ID,action为DEL时必填。长度不超过20字节。inheritModeStringODeviceProductMessage产品消息继承模式。EXTRA:额外新增消息。UNSUPPORT:不继承的消息。messageIdStringODeviceProductMessage消息标识符。在设备规格下应唯一。长度不超过255字节。表4 DeviceProductService参数说明 名称类型必选(M)/可选(O)位置描述actionStringMDeviceProductService操作类型。包括:ADD:添加属性。DEL:删除属性。idStringODeviceProductService消息ID,action为DEL。长度不超过20字节。inheritModeStringODeviceProductService产品服务指定的继承模式。UNSUPPORT:不继承的服务serviceIdStringODeviceProductService服务Id。在设备规格下唯一标识一个服务能力。在接口中调用该服务时需要传入。长度不超过255字节。表5 DeviceProductAttachment参数说明 名称类型必选(M)/可选(O)位置描述actionStringMDeviceProductAttachment操作类型。包括:ADD:添加附件。DEL:删除附件。CHG:修改附件。idStringODeviceProductAttachment设备产品的附件ID。长度不超过20字节。typeStringODeviceProductAttachment设备产品的附件类型。IMAGE:图片。VIDEO:视频。DOC:文档。pathStringODeviceProductAttachment该字段表示保存附件文件的路径,通常为相对路径URL。descriptionStringODeviceProductAttachment附件描述。长度不超过255字节。请求样例{ "code": "845454" }响应参数响应参数如表6所示。表6 响应参数说明参数名称类型必选(M)/可选(O)参数位置参数含义resCodeStringMBody返回码。resMsgStringOBody返回消息。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ }] }
-
该接口用于删除租户中已有的设备产品数据。该接口从设备BO的模型中直接删除该设备产品的所有相关数据,包括设备产品的基本信息、产品属性、产品指令、产品消息等。数据不可恢复。注意事项无。基本信息接口名称deleteDeviceProduct接口路径/service/Device/0.1.0/DeviceProduct/{id}接口协议HTTPS接口方法DELETE请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选(M)/可选(O)参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言,如zh_CNidStringMPath设备产品的id请求样例无响应参数响应参数如表2所示。表2 响应参数说明参数名称类型必选(M)/可选(O)参数位置参数含义resCodeStringMBody返回码。resMsgStringOBody返回消息。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ }] }
-
设备产品包含产品的基本信息、属性列表、服务列表和消息列表,该接口用于设备产品的定义。注意事项无。基本信息接口名称createDeviceProduct接口路径/service/Device/0.1.0/DeviceProduct/create接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选(M)/可选(O)参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言。如zh_CN。codeStringMBody设备产品的标识符。唯一标识一个产品。长度不超过64字节。deviceDefStringMBody该设备产品所归属的设备规格的ID。长度不超过20字节。productNameStringOBody设备产品的名称。长度不超过64字节。modelStringOBody设备产品的型号。长度不超过128字节。brandStringOBody设备产品的品牌。长度不超过128字节。manufacturerStringOBody设备产品的厂商。长度不超过128字节。displayTemplateStringOBody设备产品的显示模板。长度不超过128字节。descriptionStringOBody设备产品的描述文本。长度不超过262144字节。manufacturerCodeStringOBody设备产品的厂商编号。长度不超过255字节。protocolTypeStringOBody设备产品的协议类型。长度不超过255字节。deviceProductAttributeDeviceProductAttribute[]OBody设备产品具有的属性列表。deviceProductMessageDeviceProductMessage[]OBody设备产品能上报的消息列表。deviceProductServiceDeviceDefinitionService[]OBody设备产品支持的服务列表。deviceProductAttachmentDeviceProductAttachment[]OBody设备产品的附件。表2 DeviceProductAttribute参数说明 参数名称类型必选(M)/可选(O)参数位置参数含义inheritModeStringMDeviceProductAttribute属性规格继承模式。EXTRA:额外新增属性。UNSUPPORT:不继承的属性。fromAttributeStringODeviceProductAttribute产品不继承其所属设备规格的属性。inheritMode为UNSUPPORT时,标识设备规格的属性关联ID。长度不超过255字节。attributeDefStringODeviceProductAttribute属性规格。其值为属性规格的记录ID。inheritMode为EXTRA时,进行赋值。长度不超过255字节。attrValueStringODeviceProductAttribute属性值。inheritMode为EXTRA时,进行赋值。长度不超过128字节。remarkStringODeviceProductAttribute备注文本。长度不超过262144字节。表3 DeviceProductMessage参数说明 参数名称类型必选(M)/可选(O)参数位置参数含义inheritModeStringMDeviceProductMessage产品消息的继承模式。UNSUPPORT:不继承的消息messageIdStringMDeviceProductMessage设备规格的消息ID。在设备规格下应唯一。长度不超过255字节。表4 DeviceProductService参数说明 参数名称类型必选(M)/可选(O)参数位置参数含义inheritModeStringMDeviceProductMessage产品服务指定的继承模式。UNSUPPORT:不继承的服务serviceIdStringMDeviceProductMessage设备规格的服务ID。在设备规格下唯一标识一个服务能力。在接口中调用该服务时需要传入。长度不超过255字节。表5 DeviceProductAttachment参数说明 参数名称类型必选(M)/可选(O)参数位置参数含义typeStringMDeviceProductAttachment设备产品的附件类型。IMAGE:图片。VIDEO:视频。DOC:文档。pathStringMDeviceProductAttachment该字段表示保存附件文件的路径,通常为相对路径URL。长度不超过255字节。descriptionStringODeviceProductAttachment附件描述。长度不超过255字节。请求样例{ "brand": "qewwe", "code": "12345", "description": "2133", "deviceDef": "0507000000W2qwNnxrge", "displayTemplate": "", "manufacturer": "", "model": "", "productName": "" }响应参数响应参数如表6所示。表6 响应参数说明参数名称类型必选(M)/可选(O)参数位置参数含义resCodeStringMBody返回码。resMsgStringOBody返回消息。resultOutputsOBody接口响应参数。表7 Outputs参数说明 参数名称类型必选(M)/可选(O)参数位置参数含义idIntegerMBody/result/outputs产品ID。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ "id": "050S000000WDFVqDsXJ2" }] }
-
本章节描述基于AppCube轻量化SSO集成方案,将第三方系统应用(例如:未使用华为技术堆栈进行改造的应用)内嵌在园区Portal,实现从园区IOC系统单点登录后,通过点击配置在园区IOC上的菜单链接免登录跳转相应的第三方业务系统的场景。整个集成场景,项目中仅需完成相应配置及少量适配定制开发,即可实现快速集成交付。基于AppCube轻量化SSO集成,与IAM SSO有以下区别:基于IAM SSO集成:支持多种协议类型,适用于对安全性要求高的园区,但是成本较高。集成方法请参见基于IAM(OneAccess)集成第三方系统。基于AppCube轻量化SSO集成:只支持OAuth2.0标准协议,基线自带的能力,成本低。基于AppCube轻量化SSO集成方案介绍基于AppCube轻量化SSO集成方案,采用Authorization Code获取Access Token的授权验证流程(又被称为Web Server Flow),使用OAuth2.0的鉴权方式访问子系统的portal。适用于所有有Server端的应用,如Web/Wap站点、有Server端的手机/桌面客户端应用等。对于第三方系统应用而言,其流程由以下几步组成:获取Authorization Code通过Authorization Code获取Access Token通过Access Token获取User信息IOC侧集成流程在AppCube OAuthServer中注册第三方系统应用,获取client_id和client_secret。登录AppCube开发环境,选择“管理 > 系统管理 > OAuth”,单击“新建”创建OAuth。名称:自定义,例如:SSODEV授权类型:选择“授权码模式”。重定向地址:第三方系统页面的访问地址,例如:https://www.huawei.com保存后回到OAuth列表界面,单击操作列的查看密钥图标,将上一步创建的OAuth下载到本地,获取client_id和client_secret,并做好保存,以备后续使用。例如: redirect_uriclient_idclient_secrethttps://www.huawei.com564a3cba30**********49dbd3cebf5f45c99838e8e7**************b35a9899957bd8aa7afecd在IOC菜单中增加第三方系统的页面。在IOC菜单中添加第三方系统的页面,详细操作请参见在IOC中增加业务菜单。“菜单链接”配置为:IOC地址 + client_id + redirect_uri,样例如下。其中{tenantId}是变量,用于获取AppCube租户ID,不用修改,只需要替换样例中的红色内容。studio.e.huawei.com是IOC的域名;client_id和redirect_uri是1中获取的值。https://studio.e.huawei.com/magno/render/SmartCampus__UnifiedPortal_{tenantId}/MainPortal?client_id=564a3cba30**********49dbd3cebf5f&redirect_uri=https://www.huawei.com“菜单打开方式”选择“新的页签”。在权限BO中创建业务权限,MENU权限资源值为上一步添加的菜单ID,详细操作请参见定义业务权限。不用配置FUNCTION权限。为IOC角色配置权限,勾选上一步创建的业务权限。详细操作请参见配置角色与业务权限的对应关系。
推荐直播
-
OpenHarmony应用开发之网络数据请求与数据解析
2025/01/16 周四 19:00-20:30
华为开发者布道师、南京师范大学泰州学院副教授,硕士研究生导师,开放原子教育银牌认证讲师
科技浪潮中,鸿蒙生态强势崛起,OpenHarmony开启智能终端无限可能。当下,其原生应用开发适配潜力巨大,终端设备已广泛融入生活各场景,从家居到办公、穿戴至车载。 现在,机会敲门!我们的直播聚焦OpenHarmony关键的网络数据请求与解析,抛开晦涩理论,用真实案例带你掌握数据访问接口,轻松应对复杂网络请求、精准解析Json与Xml数据。参与直播,为开发鸿蒙App夯实基础,抢占科技新高地,别错过!
回顾中 -
Ascend C高层API设计原理与实现系列
2025/01/17 周五 15:30-17:00
Ascend C 技术专家
以LayerNorm算子开发为例,讲解开箱即用的Ascend C高层API
回顾中
热门标签