API列表

2023-08-23 14:32| 来源: 网络整理| 查看: 265

以下是物联网平台API列表。

产品管理相关APIAPI描述CreateProduct创建产品。UpdateProduct修改产品信息。QueryProductList查询产品列表。QueryProduct查询产品详细信息。DeleteProduct删除指定产品。CreateProductTags创建产品标签。UpdateProductTags更新产品标签。DeleteProductTags删除产品标签。ListProductTags查询产品的所有标签。ListProductByTags根据标签查询产品。CancelReleaseProduct发布指定产品。ReleaseProduct取消指定产品的发布。设备管理相关APIAPI描述RegisterDevice注册设备。QueryDeviceDetail查询设备详情。BatchQueryDeviceDetail批量查询设备详情。QueryDevice查询产品的设备列表。DeleteDevice删除设备。GetDeviceStatus获取设备的运行状态。BatchGetDeviceState批量获取设备状态。DisableThing禁用设备。EnableThing解禁设备。BatchCheckDeviceNames批量检查设备名称。BatchRegisterDeviceWithApplyId根据ApplyId批量申请设备。BatchRegisterDevice批次申请特定数量设备。QueryBatchRegisterDeviceStatus查询批量注册设备状态。QueryPageByApplyId查询批次设备列表。QueryDeviceEventData查询设备的事件历史数据。QueryDevicePropertyData查询设备的属性历史数据。QueryDevicePropertiesData批量查询指定设备的多个属性的历史数据。QueryDeviceServiceData获取设备的服务记录历史数据。InvokeThingService调用设备的服务。InvokeThingsService批量调用设备的服务。QueryDevicePropertyStatus查询设备的属性快照。SetDeviceProperty设置设备的属性。SetDevicesProperty批量设置设备属性。SaveDeviceProp设置设备标签。QueryDeviceProp查询设备标签列表。DeleteDeviceProp删除设备标签。GetThingTopo查询网关设备或子设备所具有的拓扑关系。NotifyAddThingTopo通知网关增加设备拓扑关系。RemoveThingTopo移除网关设备或子设备所具有的拓扑关系。QueryDeviceStatistics获取设备的统计数量。GetGatewayBySubDevice根据挂载的子设备信息查询对应的网关设备信息。QueryDeviceByTags根据标签查询设备。SetDeviceDesiredProperty为指定设备批量设置期望属性值。QueryDeviceDesiredProperty查询指定设备的期望属性值。QueryDeviceFileList查询指定设备上传到物联网平台的所有文件。QueryDeviceFile查询指定设备上传到物联网平台的指定文件信息。DeleteDeviceFile删除指定设备上传到物联网平台的指定文件。BatchUpdateDeviceNickname批量更新设备备注名称。分组管理相关APIAPI描述CreateDeviceGroup创建分组。DeleteDeviceGroup删除分组。UpdateDeviceGroup修改分组信息。QueryDeviceGroupInfo查询分组详情。QueryDeviceGroupList分页查询分组列表。BatchAddDeviceGroupRelations添加设备到分组。BatchDeleteDeviceGroupRelations删除分组中已添加的指定设备。SetDeviceGroupTags添加或更新分组标签。QueryDeviceGroupTagList查询分组标签列表。QueryDeviceGroupByDevice查询指定设备所在的分组列表。QuerySuperDeviceGroup根据子分组ID查询父分组信息。QueryDeviceListByDeviceGroup查询分组中的设备列表。QueryDeviceGroupByTags根据标签查询设备分组。规则引擎相关APIAPI描述ListRule查询规则列表。CreateRule创建规则。GetRule查询规则信息。UpdateRule修改规则。DeleteRule删除规则。ListRuleActions查询规则动作列表。GetRuleAction查询规则动作信息。CreateRuleAction创建规则动作。UpdateRuleAction更新规则动作。DeleteRuleAction删除规则动作。StartRule启动规则。StopRule停止规则。Topic管理相关APIAPI描述QueryProductTopic查询产品Topic类。CreateProductTopic创建产品Topic类。UpdateProductTopic修改产品Topic类。DeleteProductTopic删除产品Topic类。CreateTopicRouteTable添加Topic路由表。QueryTopicRouteTable查询Topic路由表。QueryTopicReverseRouteTable查询Topic反向路由表。DeleteTopicRouteTable删除Topic路由表。消息通信相关APIAPI描述Pub发布消息到Topic。RRPC发消息给设备，并同步返回响应。PubBroadcast发布广播消息。设备影子相关APIAPI描述GetDeviceShadow查询设备影子。UpdateDeviceShadow更新设备影子。固件升级相关APIAPI描述GenerateOTAUploadURL生成固件文件的上传对象存储的信息。CreateOTAFirmware创建固件。DeleteOTAFirmware删除指定固件。ListOTAFirmware查询固件列表。QueryOTAFirmware查询指定固件的详细信息。CreateOTAVerifyJob创建固件验证批次。CreateOTAStaticUpgradeJob创建静态批量升级批次。CreateOTADynamicUpgradeJob创建动态升级批次。ListOTAJobByFirmware获取固件下的升级批次列表。ListOTAJobByDevice获取设备所在的固件升级批次列表。ListOTATaskByJob查询指定升级批次下的设备升级作业列表。QueryOTAJob查询指定升级批次的详情。CancelOTAStrategyByJob取消动态升级批次所关联的动态升级策略。CancelOTATaskByJob取消指定批次下的设备升级作业。CancelOTATaskByDevice取消指定固件下状态为待升级的设备升级作业物模型管理相关APIAPI描述CreateThingModel为指定产品的物模型新增功能，支持定义物模型扩展描述。UpdateThingModel更新指定产品物模型中的单个功能，支持更新物模型扩展描述。QueryThingModel查看指定产品的物模型中的功能定义详情。CopyThingModel复制指定产品的物模型到目标产品。PublishThingModel发布指定产品的物模型。DeleteThingModel删除指定产品物模型中的指定功能。ListThingTemplates获取物联网平台预定义的产品品类列表。GetThingTemplate查询指定品类的标准物模型信息。ListThingModelVersion获取指定产品的物模型历史版本列表。GetThingModelTsl查询指定产品的物模型。ImportThingModelTsl为指定产品导入物模型TSL，暂不支持扩展描述配置。QueryThingModelPublished查看指定产品的已发布物模型中的功能定义详情。GetThingModelTslPublished查询指定产品的已发布物模型TSL。QueryThingModelExtendConfig导出指定产品的物模型扩展描述配置。物模型使用相关APIAPI描述SetDeviceProperty设置设备的属性。SetDevicesProperty批量设置设备属性。InvokeThingService调用设备的服务。InvokeThingsService批量调用设备的服务。QueryDevicePropertyData查询设备的属性历史数据。QueryDevicePropertiesData批量查询指定设备的多个属性的历史数据。QueryDeviceEventData查询设备的事件历史数据。QueryDeviceServiceData获取设备的服务记录历史数据。SetDeviceDesiredProperty为指定设备批量设置期望属性值。QueryDeviceDesiredProperty查询指定设备的期望属性值。QueryDevicePropertyStatus查询指定设备的属性快照。服务端订阅相关APIAPI描述CreateSubscribeRelation创建AMQP服务端订阅。UpdateSubscribeRelation修改AMQP服务端订阅。QuerySubscribeRelation查询AMQP服务端订阅。DeleteSubscribeRelation删除AMQP服务端订阅。CreateConsumerGroup创建一个消费组，用于创建AMQP服务端订阅。UpdateConsumerGroup修改消费组名称。QueryConsumerGroupByGroupId根据消费组ID查询消费组详情。QueryConsumerGroupList查询用户所有消费组列表，或按消费组名称进行模糊查询。QueryConsumerGroupStatus使用AMQP服务端订阅时，查询某个消费组的状态，包括在线客户端信息、消息消费速率、消息堆积数、最近消息消费时间。ResetConsumerGroupPosition使用AMQP服务端订阅时，清空某个消费组的堆积消息。DeleteConsumerGroup删除消费组。CreateConsumerGroupSubscribeRelation在AMQP订阅中添加一个消费组。DeleteConsumerGroupSubscribeRelation从AMQP订阅中的多个消费组移除指定消费组。视频边缘智能服务API API类型 API名称描述云存储生命周期SetDeviceRecordLifeCycle设置云存储录像文件的生命周期。QueryDeviceRecordLifeCycle获取云存储录像文件的生命周期。SetDevicePictureLifeCycle设置云存储图片的生命周期。QueryDevicePictureLifeCycle获取云存储图片的生命周期。图片功能TriggerCapturePicture主动触发IPC设备拍摄图片并上传至云端。QueryPictureFiles获取IPC设备的图片列表。QueryDevicePictureFile查询IPC设备的图片信息。直播功能QueryLiveStreaming获取IPC设备的直播开播地址。StopLiveStreaming停止IPC设备推流。时间模板CreateTimeTemplate创建时间模板。UpdateTimeTemplate更新时间模板。QueryTimeTemplate查询时间模板信息。QueryTimeTemplateDetail查询时间模板详情。DeleteTimeTemplate删除时间模板。智能告警事件QueryDeviceEvent查询IPC设备的智能告警事件列表。QueryDeviceEventRecord获取触发智能告警事件时，IPC设备拍摄上传的图片。QueryDeviceEventPicture获取智能告警事件的关联录像。连续录像计划CreateRecordPlan根据时间模板创建连续录像计划。UpdateRecordPlan更新连续录像计划。QueryRecordPlans查询连续录像计划列表。QueryRecordPlanDetail查询连续录像计划详情。DeleteRecordPlan删除连续录像计划。AddRecordPlanDevice为IPC设备添加连续录像计划。DeleteRecordPlanDevice删除PC设备关联的连续录像计划。QueryRecordPlanDeviceByPlan查询连续录像计划关联的IPC设备。QueryRecordPlanDeviceByDevice根据设备ID，查询IPC设备的连续录像计划。智能告警事件录像计划CreateEventRecordPlan 创建智能告警事件录像计划。UpdateEventRecordPlan更新智能告警事件录像计划。DeleteEventRecordPlan删除智能告警事件录像计划。QueryEventRecordPlans查询智能告警事件录像计划列表。QueryEventRecordPlanDetail查询智能告警事件录像计划详情。AddEventRecordPlanDevice为IPC设备添加智能告警事件录像计划。DeleteEventRecordPlanDevice删除智能告警事件录像计划关联的IPC设备。QueryEventRecordPlanDeviceByPlan根据IPC设备ID查询智能告警事件录像计划。QueryEventRecordPlanDeviceByDevice查询智能告警事件录像计划，关联的IPC设备列表。主动录像TriggerRecord立即触发指定IPC设备开始录像，并上传录像文件至云端。StopTriggeredRecord停止主动触发录像。云端录像播放QueryRecord查询云端录像列表。QueryMonthRecord查询IPC设备某月份的每一天是否有录像。QueryRecordUrl查询云端录像文件的播放地址。QueryRecordByRecordId通过录像文件ID查询录像文件URL。本地录像QueryDeviceVodUrl获取本地NVR或IPC设备存储卡中，指定录像文件名的录像文件播放地址。QueryDeviceVodUrlByTime获取本地NVR或IPC设备存储卡中，指定录像时间的录像文件播放地址。语音对讲QueryVoiceIntercom获取语音对讲的地址。

【本文地址】

公司简介

联系我们