该接口用于删除一个设备注册请求。注意事项无基本信息接口名称deleteDeviceRegisterRequest接口路径/service/Device/0.1.0/DeviceRegisterRequest/{id}接口协议HTTPS接口方法DELETE请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义idStringMPath记录ID请求样例无响应参数响应参数如表2所示。表2 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resCodeStringMBody返回码。resMsgStringOBody返回消息。响应样例{ "resCode": "0", "resMsg": "成功", "result": [ {} ] }

该接口用于更新一个设备注册请求。注意事项无基本信息接口名称updateDeviceRegisterRequest接口路径/service/Device/0.1.0/DeviceRegisterRequest/update接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义idStringMPath设备注册IDdataDeviceRegisterRequestData[]OBody设备注册信息表2 DeviceRegisterRequestData 参数名称类型必选（M）/可选（O）参数位置参数含义nameStringODeviceRegisterRequestData设备注册请求名称DeviceBrandStringODeviceRegisterRequestData设备品牌DeviceModelStringODeviceRegisterRequestData设备模型RequestBodyStringODeviceRegisterRequestData请求bodyStatusStringODeviceRegisterRequestData状态(Fail、Sucess)RemarkStringODeviceRegisterRequestData备注请求样例{ "id":"0D18000000fa1yC8bTDE", "data": { "DeviceBrand":"霍尼", "DeviceModel":"SP_TEST", "name": "pytest_DeviceRegisterRequest", "Status": "Fail" }}响应参数响应参数如表3所示。表3 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resCodeStringMBody返回码。resMsgStringOBody返回消息。响应样例{ "resCode": "0", "resMsg": "成功", "result": { } }

该接口用于新增一条设备注册请求。注意事项无基本信息接口名称addDeviceRegisterRequest接口路径/service/Device/0.1.0/DeviceRegisterRequest/add接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言。如zh_CN。dataDeviceRegisterRequestData[]MBody设备规格ID（同一个设备组的设备规格相同），长度不超过20字节。表2 DeviceRegisterRequestData 参数名称类型必选（M）/可选（O）参数位置参数含义nameStringMDeviceRegisterRequestData名称DeviceBrandStringODeviceRegisterRequestData设备的品牌可参考以下步骤查看获取：在AppCube平台首页单击“管理”，进入租户管理台。选择“应用管理 > BO配置”。单击“Device”，打开设备BO的配置界面。选择“设备规格定义”单击具体设备规格标识符的操作栏编辑图标进入规格定义页面。选择“设备功能>产品”，在产品页签下查看获取。DeviceModelStringODeviceRegisterRequestData设备的产品型号可参考以下步骤查看获取：在AppCube平台首页单击“管理”，进入租户管理台。选择“应用管理 > BO配置”。单击“Device”，打开设备BO的配置界面。选择“设备规格定义”单击具体设备规格标识符的操作栏编辑图标进入规格定义页面。选择“设备功能>产品”，在产品页签下查看获取。RequestBodyStringODeviceRegisterRequestData请求bodyStatusStringMDeviceRegisterRequestData状态（Fail、Sucess）RemarkStringODeviceRegisterRequestData备注表3 RequestBody 参数名称类型必选（M）/可选（O）参数位置参数含义deviceInfodeviceInfo[]MRequestBody设备信息notifyTypeStringORequestBody通知类型接口不做处理，可不填写。或参考样例填写为：deviceAddedgatewayIdStringORequestBody网关platformIdStringORequestBody设备来源deviceCodeStringMRequestBody设备编码表4 deviceInfo 参数名称类型必选（M）/可选（O）参数位置参数含义deviceTypeStringMdeviceInfo设备规格标识符。可在“应用管理 >BO配置”单击“Device”进入设备BO配置页面，在“设备规格定义”中查看获取。manufacturerNameStringOdeviceInfo制造商名称onlineStatusStringOdeviceInfo在线状态manufacturerIdStringOdeviceInfo制造商IDdescriptionStringOdeviceInfo描述remarkStringOdeviceInfo备注protocolTypeStringOdeviceInfo协议类型eventTimeUTCStringOdeviceInfo事件时间macStringOdeviceInfo设备mac地址nameStringOdeviceInfo设备名称eventTimeStringOdeviceInfo事件时间modelStringOdeviceInfo模型locationStringOdeviceInfo位置请求样例{ "data": { "DeviceBrand":"霍尼", "DeviceModel":"SP_TEST", "RequestBody":{ "deviceInfo": {"deviceType":"SumpPit", "manufacturerName":"霍尼", "onlineStatus":1, "manufacturerId":2010, "description":"", "remark":"NONE", "protocolType":"MQTT", "eventTimeUTC":"20201021T024530Z", "mac":"AR502-SumpPit01", "name":"SumpPit01", "eventTime":"20201021104530", "model":"SP_TEST", "location":""}, "notifyType":"deviceAdded", "gatewayId":"98f8b299-6310-4453-80de-757cb723c62e", "platformId":"basepoint.hlink.iot", "deviceCode":"8beda6b2-651b-4991-9727-4e9929042d69"}, "name": "pytest_DeviceRegisterRequest", "Status": "Fail" } }响应参数响应参数如表5所示。表5 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resultOutputs[]MBody接口响应参数。resCodeStringMBody返回码。resMsgStringOBody返回消息。表6 Outputs响应参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idStringMBody记录ID响应样例{ "resCode": "0", "resMsg": "成功", "result": [ { "id": "0D18000000fa1d2DAeOG" } ] }

中山附一项目，院方组织数据较多，分批次导入，前几批成功了，后面一直报错，请问有办法解决吗？

查询告警实例。该接口为告警实例对象查询模型的实际实现，可以接受多种查询条件进行组合，多个条件之间为与关系。返回结果为符合所有条件的告警实例列表的完整查询模型。注意事项因平台ES性能限制，单次查询传入的limit需要小于等于5000；当业务需要的查询数量大于5000时，请分批多次调用该接口。基本信息接口名称queryAlarm接口路径/service/Alarm/0.1.0/Alarm/query接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言。如zh_CN、en_US。默认为zh_CN。startNumberMBody起始行数（min：0）。limitNumberMBody本次查询要求返回的行数（min：0，max：5000）。conditionQueryConditionMBody查询参数对象。querySchemaQuerySchemaOBody该参数数据结构和查询结果结构相同。querySchema只对数组和结构体起作用（唯一的例外是总记录数，因为这个需要额外进行查询）。querySchema不输入，或者为空对象时不起作用，兼容原有查询逻辑。querySchema一旦输入，则只会查询其中指定的数据节点下的数据。querySchema中的路径节点不对时会直接报错。alarmAttrConditionModeStringOBody告警实例的扩展属性条件alarmAttr中各个属性之间的关联关系（AND：与方式；OR：或方式）。默认为AND。不输入本参数，或者输入的本参数的值不为AND或者OR的时候，按照本参数为AND处理。表2 QueryCondition参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idParameterOQueryCondition告警实例的ID。允许的算子包括“=”和“in”。长度范围：20字节。alarmNumberParameterOQueryCondition告警实例的标识符。允许的算子包括“=”和“like”。长度范围：1~64字节。alarmDefIdParameterOQueryCondition告警实例所属规格ID。允许的算子包括“=”和“in”。长度范围：20字节。alarmDefNameParameterOQueryCondition告警实例所属规格名称。允许的算子包括“=”和“like”。长度范围：1~65535字节。descriptionParameterOQueryCondition告警实例的描述文本。该文本根据告警规格里的描述模板默认生成，可以被修改。alarmDefCategoryIdParameterOQueryCondition告警实例所属规格分类ID。允许的算子包括“=”和“in”。长度范围：20字节。alarmDefCategoryCodeParameterOQueryCondition告警实例所属规格分类Code。允许的算子包括“=”和“in”。长度范围：1~64字节。occuringTimeParameterOQueryCondition告警实例的发生时间，Parameter中允许的operator（算子）是“between”，且只能使用valueList查询某个时间段内的告警。 "occuringTime": { "operator": "between", "valueList": [ "2020-10-11 00:00:00", "2020-10-12 00:00:00" ] }alarmLevelParameterOQueryCondition告警实例的等级。INFO：提示NORMAL：普通MAJOR：重要CRITICAL：严重允许的算子包括“=”和“in”。fromDeviceParameterOQueryCondition告警实例的来源设备ID。允许的算子是“=”。长度范围：1~255字节。statusParameterOQueryCondition告警实例的生命周期状态。包括：CREATED：已创建CONFIRMED：已确认HANDLING：处理中PENDING：挂起中允许的算子包括：=， in。spaceInPathParameterOQueryCondition告警实例发生的空间位置。可以是空间路径中的某个节点ID。允许的算子包括“=”和“in”。长度范围：1~255字节。alarmAttrAlarmAttrParameter[]OQueryCondition告警实例的扩展属性。可以传入多个扩展属性作为查询条件。reporterParameterOQueryCondition告警实例上报人。允许的算子包括：=， in。长度范围：1~255字节。alarmOriginalInfoParameterOQueryCondition告警原始信息。允许的算子包括：=，like。长度范围：1~255字节。readedParameterOQueryCondition告警是否已读。值为：Y，N。允许算子：=。mainSubtypeParameterOQueryCondition告警主子告警类型。值为：SUB，DEVICE，SYSTEM。也可以为null，为NULL时，传字符串“null”。允许算子：=，in。devParentIdParameterOQueryCondition设备级告警父告警id。允许算子：=，in。sysParentIdParameterOQueryCondition系统级告警父告警id。允许算子：=，in。表3 Parameter参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义valueAnyOParameter查询条件的参数值。valueListAny[]OParameter当算子为“in”或者“between”时，参数值为一个数组。operatorStringOParameter查询条件的算子。包括：=，<，>，like，in，between。不同的查询条件所允许的算子不同。不填则默认为“=”。表4 AlarmAttrParameter参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义codecodeMAlarmAttrParameter告警实例属性定义的标识符。允许的算子是“=”。长度范围：1~64字节。attrValueattrValueMAlarmAttrParameter告警实例属性的值。允许的算子包括“=”和“in”。长度范围：1~255字节。表5 QuerySchema参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义alarmsAlarm[]OQuerySchema是否展示具体告警数据。countanyOQuerySchema是否展示告警数量。请求样例{ "condition": { "alarmNumber": { "operator": "=", "value": "SEC_2022022500000001" } }, "limit": 10, "start": 0 }响应参数响应参数如表6所示。表6 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resultOutputs[]MBody服务的响应参数。resCodeStringMBody服务的返回码。resMsgStringOBody接口的返回消息。表7 Outputs参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义countIntegerOBody/result/outputs查询的告警实例总数。alarmsAlarm[]OBody/result/outputs告警实例列表。按告警实例的发生时间降序排列。表8 Alarm参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idStringOAlarm告警实例ID。alarmNumberStringOAlarm告警实例的唯一编号。alarmDefAlarmDefOAlarm告警实例所属的告警规格对象。occuringTimeDatetimeOAlarm告警实例的发生时间。closingTimeDatetimeOAlarm告警实例的关闭时间。alarmLevelStringOAlarm告警实例级别。INFO：提示NORMAL：普通MAJOR：重要CRITICAL：严重fromChannelStringOAlarm告警实例发生的来源渠道ID。其值来自设备BO。fromDeviceStringOAlarm告警实例发生的来源设备ID。其值来自设备BO。descriptionStringOAlarm告警实例的描述文本。该文本根据告警规格里的描述模板默认生成，可以被修改。statusStringOAlarm告警实例的生命周期状态。CREATED：已创建CONFIRMED：已确认HANDLING：处理中CLOSED：已关闭PENDING：挂起中alarmLocationAlarmLocationOAlarm告警实例发生的空间位置。alarmAttrAlarmAttribute[]OAlarm告警实例的属性列表。alarmAttachmentAlarmAttachment[]OAlarm告警实例的附件列表。reportTimesNumberOAlarm告警重复上报次数。如果当前告警的告警规格不允许合并告警，则为1。lastUpdateTimeDateTimeOAlarm最后更新时间。如果当前告警允许告警合并，则为最后一次上报该告警的时间。relatedCameraStringOAlarm告警关联的摄像机code。支持多个，多个时以逗号隔开。reporterStringOAlarm告警上报人的身份id。alarmOriginalInfoAlarmOriginalInfo[]OAlarm告警实例的关联原始信息列表deviceExternalCodeStringOAlarm告警实例发生的来源设备外部编码。其值来自设备BO。readedStringOAlarm告警是否已读。mainSubtypeStringOAlarm告警主子告警类型。devParentIdStringOAlarm设备级告警父告警id。sysParentIdStringOAlarm系统级告警父告警id。表9 AlarmDef参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idStringOAlarmDef告警规格ID。codeStringOAlarmDef告警规格标识符。defNameStringOAlarmDef告警规格名称。defNameEnStringOAlarmDef告警规格英文名称。defCategoryAlarmDefCategoryOAlarmDef告警规格所在分类对象。表10 AlarmDefCategory参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idStringOAlarmDefCategory告警规格分类ID。codeStringOAlarmDefCategory告警规格分类标识符。categoryNameStringOAlarmDefCategory告警规格分类名称。表11 AlarmDefDisplay参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义iconIdStringOAlarmDefDisplay告警的显示图标ID。iconUrlStringOAlarmDefDisplay告警的显示图标URL。audtioIdStringOAlarmDefDisplay告警到达时提示音频ID。audioUrlStringOAlarmDefDisplay告警到达时提示音频URL。表12 AlarmAttribute参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义attrCodeStringOAlarmAttribute告警实例属性的属性编码。attrDefAttributeDefinitionOAlarmAttribute告警实例属性的属性定义。attrValueStringOAlarmAttribute告警实例属性的属性值。表13 AttributeDefinition参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idStringOAttributeDefinition告警规格属性定义的ID。codeStringOAttributeDefinition告警规格属性的标识符。labelStringOAttributeDefinition告警规格属性的名称。isMandatoryStringOAttributeDefinition告警规格属性是否强制的。primaryTypeStringOAttributeDefinition告警规格属性的原始类型。picklistNameStringOAttributeDefinition当原始类型为枚举类型时，可选项所来自的Picklist的名称。unitUnitOAttributeDefinition告警规格属性的单位。表14 Unit参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idStringOUnit单位定义的ID。codeStringOUnit单位定义的标识符。unitLabelStringOUnit单位定义的名称。表15 AlarmLocation参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义spaceStringOAlarmLocation告警实例所在的最小空间实例的ID。该值来自SpaceBO。spaceNameStringOAlarmLocation告警实例所在的最小空间实例的名称。该值来自SpaceBO。spaceInPathSpace[]OAlarmLocation告警实例所在空间实例在空间树路径里的各个层级节点。该值为一个数组，元素即空间实例的各层级父节点。coordinateStringOAlarmLocation告警实例所在的地理坐标。格式：<longitude>，< latitude>，<altitude>。表16 Space参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idStringOSpace空间节点实例的ID。该值来自SpaceBO。spaceLevelStringOSpace空间节点实例所属的空间层级ID。该值来自SpaceBO。parentStringOSpace空间节点实例的父亲节点ID。通过该字段可以构造空间路径中节点的链接顺序。spaceNameStringOSpace空间节点实例的名称。表17 AlarmAttachment参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idStringOAlarmAttachment告警实例的附件ID。typeStringOAlarmAttachment告警实例的附件类型。取值范围：IMAGE：图片VIDEO：视频pathStringOAlarmAttachment附件的URL路径。descriptionStringOAlarmAttachment附件的描述。fromDeviceStringOAlarmAttachment该字段为设备实例ID，表示该附件是由哪个设备捕捉生成的。positionStringOAlarmAttachment告警消息中位置信息，以逗号隔开，顺序为左，上，右，下。表18 AlarmOriginalInfo参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义codeStringOAlarmOriginalInfo原始信息标识符。valueStringOAlarmOriginalInfo原始信息值。响应样例{ "resCode": "0", "resMsg": "成功", "result": [ { "alarms": [ { "alarmAttachment": [], "alarmAttr": [ { "attrDef": { "code": "deviceGroupId", "id": "0C0A000******HYnekYy", "isMandatory": false, "label": "设备分组ID", "picklistName": "", "primaryType": "String" }, "attrValue": "1005" }, { "attrDef": { "code": "alarmMergeType", "id": "0C0A000******eNFJlQ0", "isMandatory": false, "label": "告警合并类型", "picklistName": "", "primaryType": "String" }, "attrValue": "device" }, { "attrDef": { "code": "groupId", "id": "0C0A000******rpSBPO4", "isMandatory": false, "label": "告警规则集ID", "picklistName": "", "primaryType": "String" }, "attrValue": "1015" } ], "alarmDef": { "code": "EquipmentFaultDiagnosis", "defCategory": { "categoryName": "设备故障诊断", "code": "EquipmentFaultDiagnosis", "id": "0500000******b9ZkiA4" }, "defName": "设备故障诊断告警", "id": "0501000******C3GuLHk" }, "alarmLevel": "MAJOR", "alarmLocation": { "coordinate": "0,0,,,", "space": "0A11000******hiT8OaO", "spaceInPath": [ { "id": "0A11000******QdVVulc", "parent": "0A11000******Os2JHay", "spaceLevel": "0A10000******QZ3nmUq", "spaceName": "龙岗区" }, { "id": "0A11000******Os2JHay", "parent": "0A11000******OhTSgW8", "spaceLevel": "0A10000******Obp632O", "spaceName": "深圳市" }, { "id": "0A11000******OhTSgW8", "parent": "0A11000******OgV07oO", "spaceLevel": "0A10000******MjqFou0", "spaceName": "广东省" }, { "id": "0A11000******OgV07oO", "parent": "", "spaceLevel": "0A10000******Khvjddg", "spaceName": "中国" } ], "spaceName": "坂田基地J区" }, "alarmNumber": "equipment_2021101400000008", "description": "设备故障诊断告警", "fromDevice": "050C00******LtBzifw", "id": "0504000******A2R2icy", "lastUpdateTime": "2021-10-14 09:52:05", "occuringTime": "2021-10-14 09:52:05", "readed": "N", "reportTimes": 1, "reporter": "xie******an2", "status": "CREATED" } ], "count": 458160 } ] }

更新告警实例。包括告警信息、告警状态、告警附件列表。注意事项无。基本信息接口名称updateAlarm接口路径/service/Alarm/0.1.0/Alarm/update/{id}接口协议HTTPS接口方法PUT请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言。如zh_CN、en_US。默认为zh_CN。idStringMPath告警实例ID。表示要更新哪个告警实例。长度范围：20字节。actionTypeStringMBody操作类型。单次调用进行多种操作时，通过逗号隔开。CHANGE_ALARMLEVEL：修改告警级别CHANGE_DETAIL：修改描述CHANGE_ATTR：修改扩展属性值CHANGE_STATUS：变更状态MGMT_ATTACH：管理附件CHANGE_CAMERA：修改关联摄像机ADD_REMARK：添加评论CHANGE_READ：修改是否已读CHANGE_MAINSUBTYPE：修改主子告警标识CHANGE_MAINALARMID：修改父告警idalarmLevelStringOBody更新事件中的事件级别（“actionType”取值“CHANGE_ALARMLEVEL”时传入）。INFO：提示NORMAL：一般MAJOR：重要CRITICAL：严重statusStringOBody更新事件中的事件状态（“actionType”取值为“CHANGE_STATUS”时传入）。CREATED：已创建CONFIRMED：已确认CLOSED：已关闭PENDING：挂起中CANCELED ：取消reasonStringOBody修改原因。长度范围：1~262144字节。descriptionStringOBody事件描述（“actionType”取值为“CHANGE_DETAIL”时传入）。更新详情时，中英文详情通过此字段实现同步修改。长度范围：1~262144字节。alarmAttrAlarmAttribute[]OBody告警实例的扩展属性列表。（“actionType”为“CHANGE_ATTR”时传入）。attachmentAlarmAttachment[]OBody告警附件列表（“actionType”为“MGMT_ATTACH”时传入）。relatedCameraStringOBody告警关联的摄像机code。支持多个，多个时以逗号隔开。（“actionType”为“CHANGE_CAMERA”时传入）。长度范围：1~262144字节。operatorStringOBody操作人员。长度范围：1~262144字节。isRefreshESBooleanOBody是否手动刷新Elasticsearch，取true时手动刷新ES，反之等待ES自动刷新，自动刷新时列表查询会有1s左右的延时，默认为truereadedStringOBody告警是否已读。（actionType为“CHANGE_READ”时传入）devParentIdStringOBody设备级告警父告警id（actionType为“CHANGE_MAINALARMID”时传入）sysParentIdStringOBody系统级告警父告警id（actionType为“CHANGE_MAINALARMID”时传入）表2 AlarmAttribute参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义attrDefStringOAlarmAttribute要修改的扩展属性的定义ID。长度范围：20字节。attrDefCodeStringOAlarmAttribute要修改的扩展属性的标识符。长度范围：1~64字节。actionTypeStringMAlarmAttribute操作类型。PUT：设置属性值DEL：删除该属性值attrValueStringOAlarmAttribute新的属性值。长度范围：1~255字节。表3 AlarmAttachment参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idStringOAlarmAttachment新建时没有id，编辑和删除时传入。长度范围：20字节。nameStringOAlarmAttachment附件的名称（如：XX.png）。长度范围：1~64字节。typeStringOAlarmAttachment附件类型。在添加新附件时必须传。取值范围：IMAGE：图片VIDEO：视频pathStringOAlarmAttachment附件URL路径。附件先通过上传接口上传到文件服务器，获取到访问URL后放入此参数中携带。长度范围：1~1024字节。descriptionStringOAlarmAttachment附件的描述。长度范围：1~255字节。actionStringMAlarmAttachment操作类型。ADD：添加新属性DEL：删除属性CHG：修改属性positionStringOAlarmAttachment告警消息中位置信息。以逗号隔开，顺序为左，上，右，下。长度范围：1~255字节。请求样例{ "alarmLevel": "MAJOR", "actionType": "CHANGE_ALARMLEVEL" }响应参数响应参数如表4所示。表4 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resultObjectOBody服务的响应参数，参照错误信息。resCodeStringMBody服务的返回码，参照错误码列表。resMsgStringOBody服务的返回消息。响应样例{ "resCode": "0", "resMsg": "成功", "result": [ {} ] }

设备管理场景，ROMA能提供设备规格数据吗？ 设备规格数据是不是只有应用和IOT才能实现和交互？

该接口用于导入设备触发器实例。注意事项无。基本信息接口名称deviceTriggerImport接口路径/service/Device/0.1.0/DeviceTrigger/import接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言，如zh_CN。recordsRecord[]OBody导入告警触发器数据。表2 Record 参数名称类型必选（M）/可选（O）参数位置参数含义triggerNameStringORecord触发器实例名称。triggerDefCodeStringORecord触发器规格ID。statusStringORecord触发器状态（只能为ENABLED、DISABLED）。remarkStringORecord备注文本。fromDateStringORecord生效起始时间。生效时间需要早于失效时间。如果不传，默认生效时间为当前时间。toDateStringORecord失效时间。不传时，默认写入2099-12-31。deviceExternalCodeStringORecord设备实例外部编码。channelCodeStringORecord外部渠道编码。deviceDefCodeStringORecord设备规格ID。如果不填，会根据deviceId查询规格ID填入。注意：deviceId和deviceDef至少二选其一。如果同时传入两个参数，触发器会关联到设备实例上（deviceId优先级高）。deviceAttrDefCodeStringORecord触发器监测的设备实例动态属性对应的属性编码。externalCodeStringORecord动态属性对应的外部编码【设备实例属性对应多值属性时才保存外部编码】。ALARM_CODEStringORecord告警规格编码。ALARM_LEVELStringORecord告警级别。ALARM_STATUS_ATTR_CODEStringORecord告警状态属性编码。RELIEVE_MESSAGE_CODEStringORecord解除报警消息编码列表。MESSAGE_CODEStringORecord报警消息值列表ABNORMAL_STATEStringORecord异常状态数组HIGH_THRESHOLD_LIMITStringORecord高高值HIGH_THRESHOLDStringORecord高阈值LOW_THRESHOLDStringORecord低域值LOW_THRESHOLD_LIMITStringORecord低低值请求样例{ "records": [ { "ABNORMAL_STATE": "string", "ALARM_CODE": "string", "ALARM_LEVEL": "string", "ALARM_STATUS_ATTR_CODE": "string", "HIGH_THRESHOLD": "string", "HIGH_THRESHOLD_LIMIT": "string", "LOW_THRESHOLD": "string", "LOW_THRESHOLD_LIMIT": "string", "MESSAGE_CODE": "string", "RELIEVE_MESSAGE_CODE": "string", "channelCode": "string", "deviceAttrDefCode": "string", "deviceDefCode": "string", "deviceExternalCode": "string", "externalCode": "string", "fromDate": "string", "remark": "string", "status": "string", "toDate": "string", "triggerDefCode": "string", "triggerName": "string" } ] }响应参数响应参数如表3所示。表3 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resultOutputsOBody接口响应参数。resCodeStringMBody返回码。resMsgStringOBody返回消息。表4 Outputs 参数名称类型必选（M）/可选（O）参数位置参数含义failedRecordsObject[]MBody/result/outputs导入失败的数据。表5 响应码 状态码描述200 OK接口调用成功。响应样例{ "failedRecords": [ {} ] }

该接口用于删除租户中已有的设备实例触发器数据。该接口从设备BO的模型中直接删除掉该设备实例的触发器相关配置和参数。且数据不可恢复。注意事项无。基本信息接口名称deleteDeviceTrigger接口路径/service/Device/0.1.0/Trigger/{id}接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言，如zh_CN。idStringMPath将被删除的设备实例触发器的ID。请求样例无响应参数响应参数如表2所示。表2 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resCodeStringMBody返回码。resMsgStringOBody返回消息。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ }] }

该接口用于更新设备产品的定义，更新的信息包含产品的基本信息、产品属性列表、服务列表、消息列表、附件列表。注意事项无。基本信息接口名称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": [{ }] }

该接口用于变更设备实例的生命周期状态为已启用。仅当设备实例的状态为已禁用时，可以变更状态为已启用。在启用中的设备实例，可以被当前系统管理控制，能接受调用服务、抛出设备消息、执行触发器规则、更新动态属性。注意事项无。基本信息接口名称enableDevice接口路径/service/Device/0.1.0/enableDevice/{id}接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言，如zh_CN。idStringMPath将被启用的设备实例的数据ID。请求样例无响应参数响应参数如表2所示。表2 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resultOutputs[]MBody接口响应参数。resCodeStringMBody返回码。resMsgStringOBody返回消息。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ }] }

该接口用于删除租户中已有的作废设备实例数据。该接口从设备BO的模型中直接删除掉该作废设备实例的所有相关数据，包括设备的空间位置、实例属性、设备触发器等。且数据不可恢复。注意事项无。基本信息接口名称deleteDevice接口路径/service/Device/0.1.0/Device/{id}接口协议HTTPS接口方法DELETE请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言，如zh_CN。idStringMPath将被删除的设备实例的数据ID。请求样例无响应参数响应参数如表2所示。表2 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resCodeStringMBody返回码。resMsgStringOBody返回消息。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ }] }

该接口用于变更设备实例的生命周期状态为已作废。当设备实例已经下线了不再投入使用，可以调用此接口将状态改为已作废。从其他任何状态都可以进入已作废状态，设备重新导入或者重新发起自注册时，设备会被重新激活为已启用状态。注意事项无。基本信息接口名称discardDevice接口路径/service/Device/0.1.0/discardDevice/{id}接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言，如zh_CN。idStringMPath将被作废的设备实例的数据ID。请求样例无响应参数响应参数如表2所示。表2 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resultOutputs[]MBody接口响应参数。resCodeStringMBody返回码。resMsgStringOBody返回消息。响应样例{ "resCode": "0", "resMsg": "成功", "result": [{ }] }

更新告警实例。包括告警信息、告警状态、告警附件列表。注意事项无。基本信息接口名称updateAlarm接口路径/service/Alarm/0.1.0/Alarm/update/{id}接口协议HTTPS接口方法PUT请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言。如zh_CN、en_US。默认为zh_CN。idStringMPath告警实例ID。表示要更新哪个告警实例。长度范围：20字节。actionTypeStringMBody操作类型。单次调用进行多种操作时，通过逗号隔开。CHANGE_ALARMLEVEL：修改告警级别CHANGE_DETAIL：修改描述CHANGE_ATTR：修改扩展属性值CHANGE_STATUS：变更状态MGMT_ATTACH：管理附件CHANGE_CAMERA：修改关联摄像机ADD_REMARK：添加评论CHANGE_READ：修改是否已读CHANGE_MAINSUBTYPE：修改主子告警标识CHANGE_MAINALARMID：修改父告警idalarmLevelStringOBody更新事件中的事件级别（“actionType”取值“CHANGE_ALARMLEVEL”时传入）。INFO：提示NORMAL：一般MAJOR：重要CRITICAL：严重statusStringOBody更新事件中的事件状态（“actionType”取值为“CHANGE_STATUS”时传入）。CREATED：已创建CONFIRMED：已确认CLOSED：已关闭PENDING：挂起中CANCELED ：取消reasonStringOBody修改原因。长度范围：1~262144字节。descriptionStringOBody事件描述（“actionType”取值为“CHANGE_DETAIL”时传入）。更新详情时，中英文详情通过此字段实现同步修改。长度范围：1~262144字节。alarmAttrAlarmAttribute[]OBody告警实例的扩展属性列表。（“actionType”为“CHANGE_ATTR”时传入）。attachmentAlarmAttachment[]OBody告警附件列表（“actionType”为“MGMT_ATTACH”时传入）。relatedCameraStringOBody告警关联的摄像机code。支持多个，多个时以逗号隔开。（“actionType”为“CHANGE_CAMERA”时传入）。长度范围：1~262144字节。operatorStringOBody操作人员。长度范围：1~262144字节。isRefreshESBooleanOBody是否手动刷新Elasticsearch，取true时手动刷新ES，反之等待ES自动刷新，自动刷新时列表查询会有1s左右的延时，默认为truereadedStringOBody告警是否已读。（actionType为“CHANGE_READ”时传入）devParentIdStringOBody设备级告警父告警id（actionType为“CHANGE_MAINALARMID”时传入）sysParentIdStringOBody系统级告警父告警id（actionType为“CHANGE_MAINALARMID”时传入）表2 AlarmAttribute参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义attrDefStringOAlarmAttribute要修改的扩展属性的定义ID。长度范围：20字节。attrDefCodeStringOAlarmAttribute要修改的扩展属性的标识符。长度范围：1~64字节。actionTypeStringMAlarmAttribute操作类型。PUT：设置属性值DEL：删除该属性值attrValueStringOAlarmAttribute新的属性值。长度范围：1~255字节。表3 AlarmAttachment参数说明 参数名称类型必选（M）/可选（O）参数位置参数含义idStringOAlarmAttachment新建时没有id，编辑和删除时传入。长度范围：20字节。nameStringOAlarmAttachment附件的名称（如：XX.png）。长度范围：1~64字节。typeStringOAlarmAttachment附件类型。在添加新附件时必须传。取值范围：IMAGE：图片VIDEO：视频pathStringOAlarmAttachment附件URL路径。附件先通过上传接口上传到文件服务器，获取到访问URL后放入此参数中携带。长度范围：1~1024字节。descriptionStringOAlarmAttachment附件的描述。长度范围：1~255字节。actionStringMAlarmAttachment操作类型。ADD：添加新属性DEL：删除属性CHG：修改属性positionStringOAlarmAttachment告警消息中位置信息。以逗号隔开，顺序为左，上，右，下。长度范围：1~255字节。请求样例{ "alarmLevel": "MAJOR", "actionType": "CHANGE_ALARMLEVEL" }响应参数响应参数如表4所示。表4 响应参数说明参数名称类型必选（M）/可选（O）参数位置参数含义resultObjectOBody服务的响应参数，参照错误信息。resCodeStringMBody服务的返回码，参照错误码列表。resMsgStringOBody服务的返回消息。响应样例{ "resCode": "0", "resMsg": "成功", "result": [ {} ] }