{ "name": "iotvideo", "display_name": "物联网智能视频服务", "description": "介绍如何使用 API 对物联网智能视频服务进行操作，包括终端管理、OTA 固件管理等。", "domain": "other", "api_version": "2021-11-25", "endpoint": "iotvideo.tencentcloudapi.com", "actions": [ { "name": "ApplyAIModel", "description": "申请AI模型", "status": "online", "parameters": [ { "name": "ModelId", "type": "string", "required": true, "description": "AI模型ID", "example": "body_detection" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" } ], "required": [ "ModelId", "ProductId" ] }, { "name": "BatchUpdateFirmware", "description": "本接口（BatchUpdateFirmware）用于批量更新设备固件", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件新版本号", "example": "1-2-2" }, { "name": "FirmwareOriVersion", "type": "string", "required": false, "description": "固件原版本号，根据文件列表升级固件不需要填写此参数", "example": "1-2-1" }, { "name": "UpgradeMethod", "type": "integer", "required": false, "description": "升级方式，0 静默升级 1 用户确认升级。 不填默认为静默升级方式", "example": "0" }, { "name": "FileName", "type": "string", "required": false, "description": "设备列表文件名称，根据文件列表升级固件需要填写此参数", "example": "firm.ios" }, { "name": "FileMd5", "type": "string", "required": false, "description": "设备列表的文件md5值", "example": "af7c365370f85e7983fe3ef05405bb3c" }, { "name": "FileSize", "type": "integer", "required": false, "description": "设备列表的文件大小值", "example": "19941" }, { "name": "DeviceNames", "type": "array", "required": false, "description": "需要升级的设备名称列表", "example": "[\"dev1\",\"dev2\"]", "item_type": "string" }, { "name": "TimeoutInterval", "type": "integer", "required": false, "description": "固件升级任务默认超时时间。 最小取值60秒，最大为3600秒", "example": "60" } ], "required": [ "ProductID", "FirmwareVersion" ] }, { "name": "BindCloudStorageUser", "description": "绑定云存用户", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev1" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID", "example": "user" } ], "required": [ "ProductId", "DeviceName", "UserId" ] }, { "name": "CallDeviceActionAsync", "description": "异步调用设备行为", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品Id", "example": "TOIDHQ3AOQ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "TOIDHQ2AOQ" }, { "name": "ActionId", "type": "string", "required": true, "description": "产品数据模板中行为功能的标识符，由开发者自行根据设备的应用场景定义", "example": "actid" }, { "name": "InputParams", "type": "string", "required": false, "description": "输入参数", "example": "{\"vol\":3}" } ], "required": [ "ProductId", "DeviceName", "ActionId" ] }, { "name": "CallDeviceActionSync", "description": "同步调用设备行为", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品Id", "example": "TOIDHQ3AOQ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "light1" }, { "name": "ActionId", "type": "string", "required": true, "description": "产品数据模板中行为功能的标识符，由开发者自行根据设备的应用场景定义", "example": "actid" }, { "name": "InputParams", "type": "string", "required": false, "description": "输入参数", "example": "{\"vol\":3}" } ], "required": [ "ProductId", "DeviceName", "ActionId" ] }, { "name": "CallTRTCDevice", "description": "呼叫TRTC设备", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "AQTV2839QJ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "p2p_32731213_1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "CancelAIModelApplication", "description": "取消AI模型申请", "status": "online", "parameters": [ { "name": "ModelId", "type": "string", "required": true, "description": "AI模型ID", "example": "body_detection" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" } ], "required": [ "ModelId", "ProductId" ] }, { "name": "CancelDeviceFirmwareTask", "description": "本接口用于取消设备升级任务", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "abcde" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev1" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "1-2-1" }, { "name": "TaskId", "type": "integer", "required": true, "description": "固件升级任务ID", "example": "12314" } ], "required": [ "ProductID", "DeviceName", "FirmwareVersion", "TaskId" ] }, { "name": "ChangeP2PRoute", "description": "p2p路线切换（此接口目前处于内测接口，可以联系申请加白 ）", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "RouteId", "type": "integer", "required": true, "description": "P2P线路", "example": "1" } ], "required": [ "ProductId", "DeviceName", "RouteId" ] }, { "name": "CheckForwardAuth", "description": "判断是否开启转发的权限", "status": "online", "parameters": [ { "name": "Skey", "type": "string", "required": true, "description": "控制台Skey", "example": "safawef" }, { "name": "QueueType", "type": "integer", "required": true, "description": "队列类型 0.CMQ 1.Ckafka", "example": "1" } ], "required": [ "Skey", "QueueType" ] }, { "name": "ControlDeviceData", "description": "根据设备产品ID、设备名称，设置控制设备的属性数据。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev1" }, { "name": "Data", "type": "string", "required": true, "description": "属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义", "example": "{\"payload\":\"test\",\"id\":\"abc\"}" }, { "name": "Method", "type": "string", "required": false, "description": "请求类型 , 不填该参数或者 desired 表示下发属性给设备, reported 表示模拟设备上报属性", "example": "reported" }, { "name": "DataTimestamp", "type": "integer", "required": false, "description": "上报数据UNIX时间戳(毫秒), 仅对Method:reported有效", "example": "1623742521" } ], "required": [ "ProductId", "DeviceName", "Data" ] }, { "name": "CreateAIDetection", "description": "发起AI推理请求", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "H541SOP191" }, { "name": "ModelId", "type": "string", "required": true, "description": "AI模型ID", "example": "detect" }, { "name": "StartTime", "type": "integer", "required": true, "description": "图片上传的开始时间", "example": "1619431648" }, { "name": "EndTime", "type": "integer", "required": true, "description": "图片上传的结束时间", "example": "1619431658" } ], "required": [ "ProductId", "DeviceName", "ModelId", "StartTime", "EndTime" ] }, { "name": "CreateBatch", "description": "创建批次", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DevNum", "type": "integer", "required": true, "description": "批次创建的设备数量", "example": "1" }, { "name": "DevPre", "type": "string", "required": true, "description": "批次创建的设备前缀。不超过24个字符", "example": "dev" } ], "required": [ "ProductId", "DevNum", "DevPre" ] }, { "name": "CreateCOSCredentials", "description": "创建COS上传密钥", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "H541SOP191" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "CreateCloudStorage", "description": "开通云存服务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "PackageId", "type": "string", "required": true, "description": "云存套餐ID： yc1m3d ： 全时3天存储月套餐。 yc1m7d ： 全时7天存储月套餐。 yc1m30d ：全时30天存储月套餐。 yc1y3d ：全时3天存储年套餐。 yc1y7d ：全时7天存储年套餐。 yc1y30d ：全时30天存储年套餐。 ye1m3d ：事件3天存储月套餐。 ye1m7d ：事件7天存储月套餐。 ye1m30d ：事件30天存储月套餐 。 ye1y3d ：事件3天存储年套餐。 ye1y7d ：事件7天存储年套餐。 ye1y30d ：事件30天存储年套餐。 yc1...", "example": "yc1m3d" }, { "name": "Override", "type": "integer", "required": false, "description": "如果当前设备已开启云存套餐，Override=1会使用新套餐覆盖原有套餐。不传此参数则默认为0。", "example": "0" }, { "name": "PackageQueue", "type": "string", "required": false, "description": "套餐列表顺序：PackageQueue=front会立即使用新购买的套餐，新购套餐结束后，列表中下一个未过期的套餐继续生效；PackageQueue=end会等设备当前所有已购买套餐过期后才会生效新购套餐。与Override参数不能同时使用。", "example": "front" }, { "name": "OrderId", "type": "string", "required": false, "description": "订单id", "example": "slfie21321" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" }, { "name": "StorageRegion", "type": "string", "required": false, "description": "云存视频存储区域，国内默认为ap-guangzhou。海外默认为东南亚ap-singapore，可选美东na-ashburn、欧洲eu-frankfurt。", "example": "ap-guangzhou" } ], "required": [ "ProductId", "DeviceName", "PackageId" ] }, { "name": "CreateDataForward", "description": "创建数据转发", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID。", "example": "TOIDHQ3AOQ" }, { "name": "ForwardAddr", "type": "string", "required": true, "description": "转发地址。如果有鉴权Token，则需要自行传入，例如 [{\\\"forward\\\":{\\\"api\\\":\\\"http://123.207.117.108:1080/sub.php\\\",\\\"token\\\":\\\"testtoken\\\"}}]", "example": "[{\\\"forward\\\":{\\\"api\\\":\\\"http://123.207.117.108:1080/sub.php\\\"}}" }, { "name": "DataChose", "type": "integer", "required": false, "description": "1-数据信息转发 2-设备上下线状态转发 3-数据信息转发\u0026设备上下线状态转发", "example": "0" } ], "required": [ "ProductId", "ForwardAddr" ] }, { "name": "CreateDeviceChannel", "description": "创建设备通道", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "ChannelId", "type": "integer", "required": true, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName", "ChannelId" ] }, { "name": "CreateForwardRule", "description": "创建转发规则", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "PTROMP3AOB" }, { "name": "MsgType", "type": "integer", "required": true, "description": "消息类型", "example": "1" }, { "name": "Skey", "type": "string", "required": true, "description": "控制台Skey", "example": "xrnWgKu0fCz7q8JIQYFiNP" }, { "name": "QueueRegion", "type": "string", "required": true, "description": "队列区域", "example": "gz" }, { "name": "QueueType", "type": "integer", "required": true, "description": "队列类型 0.CMQ 1.Ckafka", "example": "1" }, { "name": "Consecretid", "type": "string", "required": false, "description": "临时密钥", "example": "safawef" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "ins-epc65t7i" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称", "example": "hub_test_ins" }, { "name": "QueueID", "type": "string", "required": false, "description": "队列或主题ID", "example": "topic-epc65t7i" }, { "name": "QueueName", "type": "string", "required": false, "description": "队列或主题名称", "example": "hub_test_topic" } ], "required": [ "ProductID", "MsgType", "Skey", "QueueRegion", "QueueType" ] }, { "name": "CreateFreeCloudStorage", "description": "开通免费云存服务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "PackageId", "type": "string", "required": true, "description": "云存套餐ID： lye1w3d：低功耗事件3天周套餐。 ye1w3d：事件3天周套餐", "example": "lye1w3d" }, { "name": "Override", "type": "integer", "required": false, "description": "如果当前设备已开启云存套餐，Override=1会使用新套餐覆盖原有套餐。不传此参数则默认为0。", "example": "0" }, { "name": "PackageQueue", "type": "string", "required": false, "description": "套餐列表顺序：PackageQueue=front会立即使用新购买的套餐，新购套餐结束后，列表中下一个未过期的套餐继续生效；PackageQueue=end会等设备当前所有已购买套餐过期后才会生效新购套餐。与Override参数不能同时使用。", "example": "front" }, { "name": "OrderId", "type": "string", "required": false, "description": "订单id", "example": "slfie21321" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" }, { "name": "StorageRegion", "type": "string", "required": false, "description": "云存视频存储区域，国内默认为ap-guangzhou。海外默认为东南亚ap-singapore，可选美东na-ashburn、欧洲eu-frankfurt。", "example": "ap-guangzhou" } ], "required": [ "ProductId", "DeviceName", "PackageId" ] }, { "name": "CreateProduct", "description": "创建产品", "status": "online", "parameters": [ { "name": "ProductName", "type": "string", "required": true, "description": "产品名称", "example": "camera" }, { "name": "DeviceType", "type": "integer", "required": true, "description": "产品设备类型 1.普通设备 2.NVR设备", "example": "1" }, { "name": "ProductVaildYears", "type": "integer", "required": true, "description": "产品有效期", "example": "1" }, { "name": "Features", "type": "array", "required": true, "description": "设备功能码 ypsxth音频双向通话 spdxth视频单向通话 sxysp双向音视频 注意：此字段只支持创建'摄像头'和'儿童手表'，摄像头传[\"ypsxth\",\"spdxth\"]，儿童手表传[\"ypsxth\",\"spdxth\",\"sxysp\"]，创建其它品类的产品需要传递CategoryId字段，通过云api调用此接口时，如果传了CategoryId字段，将忽略Features字段,但Features仍需传值(可传任意字符串数组)", "example": "ypsxth", "item_type": "string" }, { "name": "ChipManufactureId", "type": "string", "required": true, "description": "芯片厂商id，通用设备填default", "example": "x86" }, { "name": "ChipId", "type": "string", "required": true, "description": "芯片id，通用设备填default", "example": "chip1" }, { "name": "ProductDescription", "type": "string", "required": true, "description": "产品描述信息", "example": "desc" }, { "name": "ChipOs", "type": "string", "required": true, "description": "设备操作系统，通用设备填default", "example": "linux" }, { "name": "EncryptionType", "type": "integer", "required": false, "description": "认证方式 只支持取值为2 psk认证", "example": "2" }, { "name": "CategoryId", "type": "integer", "required": false, "description": "产品品类id,113:摄像头,567:儿童手表,595:可视对讲门锁 注意：通过云api调用此接口时，如果传了CategoryId字段，将忽略Features字段,但Features仍需传值(可传任意字符串数组)", "example": "113" }, { "name": "NetType", "type": "string", "required": false, "description": "连接类型，wifi表示WIFI连接，cellular表示4G连接", "example": "wifi" } ], "required": [ "ProductName", "DeviceType", "ProductVaildYears", "Features", "ChipManufactureId", "ChipId", "ProductDescription", "ChipOs" ] }, { "name": "CreateTaskFileUrl", "description": "本接口（CreateTaskFileUrl）用于获取产品级任务文件上传链接", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" } ], "required": [ "ProductId" ] }, { "name": "DeleteCloudStorageEvent", "description": "删除云存事件", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "AQTV2839QJ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "p2p_32731213_1" }, { "name": "EventId", "type": "string", "required": true, "description": "事件id", "example": "id1_data" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间，unix时间", "example": "32874" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间，unix时间", "example": "234ui32" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName", "EventId", "StartTime", "EndTime" ] }, { "name": "DeleteDevice", "description": "删除设备", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID。", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称。", "example": "test1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DeleteFirmware", "description": "本接口（DeleteFirmware）用于删除固件", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本", "example": "1.1.0" } ], "required": [ "ProductID", "FirmwareVersion" ] }, { "name": "DeleteForwardRule", "description": "删除转发规则", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "PV1674YINM" }, { "name": "Skey", "type": "string", "required": true, "description": "控制台Skey", "example": "xrnWgKu0fCz7q8JIQYFiNP" }, { "name": "QueueType", "type": "integer", "required": true, "description": "队列类型", "example": "1" }, { "name": "QueueName", "type": "string", "required": true, "description": "队列名称", "example": "iot_hub_test" } ], "required": [ "ProductID", "Skey", "QueueType", "QueueName" ] }, { "name": "DeleteProduct", "description": "删除产品", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "PTROMP3AOB" } ], "required": [ "ProductId" ] }, { "name": "DescribeAIModelApplications", "description": "用户AI模型申请记录", "status": "online", "parameters": [ { "name": "ModelId", "type": "string", "required": true, "description": "模型ID", "example": "body_detection" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页的大小，最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，Offset从0开始", "example": "0" }, { "name": "ProductId", "type": "string", "required": false, "description": "产品ID", "example": "PV1674YINM" } ], "required": [ "ModelId", "Limit", "Offset" ] }, { "name": "DescribeAIModelChannel", "description": "查看AI推理结果推送配置", "status": "online", "parameters": [ { "name": "ModelId", "type": "string", "required": true, "description": "模型ID", "example": "body_detection" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" } ], "required": [ "ModelId", "ProductId" ] }, { "name": "DescribeAIModelUsage", "description": "查看AI模型资源包", "status": "online", "parameters": [ { "name": "ModelId", "type": "string", "required": true, "description": "模型ID", "example": "body_detection" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，从0开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页的大小，最大100", "example": "10" } ], "required": [ "ModelId", "ProductId", "Offset", "Limit" ] }, { "name": "DescribeAIModels", "description": "拉取AI模型列表", "status": "online", "parameters": [ { "name": "ModelId", "type": "string", "required": true, "description": "模型ID", "example": "body_detection" }, { "name": "Status", "type": "integer", "required": true, "description": "申请状态：1-已申请；2-已取消；3-已拒绝；4-已通过", "example": "1" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，Offset从0开始", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页的大小，最大100", "example": "10" } ], "required": [ "ModelId", "Status", "Offset", "Limit" ] }, { "name": "DescribeAccount", "description": "获取消费版账号信息", "status": "online", "parameters": [ { "name": "AccountType", "type": "integer", "required": true, "description": "1设备，2云存，3ai", "example": "2" } ], "required": [ "AccountType" ] }, { "name": "DescribeBalance", "description": "查询账户余额", "status": "online", "parameters": [ { "name": "AccountType", "type": "integer", "required": true, "description": "账户类型：1-设备接入；2-云存。", "example": "1" } ], "required": [ "AccountType" ] }, { "name": "DescribeBalanceTransactions", "description": "拉取账户流水", "status": "online", "parameters": [ { "name": "AccountType", "type": "integer", "required": true, "description": "账户类型：1-设备接入；2-云存。", "example": "2" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页游标开始，默认为0开始拉取第一条。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页每页数量。", "example": "10" }, { "name": "Operation", "type": "string", "required": false, "description": "流水类型：All-全部类型；Recharge-充值；CreateOrder-新购。默认为All", "example": "All" } ], "required": [ "AccountType", "Offset", "Limit" ] }, { "name": "DescribeBatch", "description": "获取批次详情", "status": "online", "parameters": [ { "name": "BatchId", "type": "integer", "required": true, "description": "批次ID", "example": "12" } ], "required": [ "BatchId" ] }, { "name": "DescribeBatchs", "description": "获取批次列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "PTROMP3AOB" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页的大小，最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，Offset从0开始", "example": "0" } ], "required": [ "ProductId", "Limit", "Offset" ] }, { "name": "DescribeBonuses", "description": "查看运营活动资源包列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "分页拉取偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页拉取数量", "example": "10" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeCategory", "description": "获取Category详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "Category ID。", "example": "113" } ], "required": [ "Id" ] }, { "name": "DescribeCloudStorage", "description": "获取设备云存服务详情", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "UserId", "type": "string", "required": false, "description": "云存用户ID", "example": "default" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID 非NVR设备不填 NVR设备必填 默认为无", "example": "1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeCloudStorageDate", "description": "获取具有云存的日期", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "AQTV2839QJ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "p2p_32731213_1" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeCloudStorageEvents", "description": "拉取云存事件列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "QDA1PZLBNB" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev01" }, { "name": "StartTime", "type": "integer", "required": false, "description": "起始时间（Unix 时间戳，秒级）, 为0 表示 当前时间 - 24h", "example": "1560355200" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间（Unix 时间戳，秒级）, 为0 表示当前时间", "example": "1601196327" }, { "name": "Context", "type": "string", "required": false, "description": "请求上下文, 用作查询游标", "example": "DnF1ZXJ5VGhlbkZldGNoCgAAAAAAABO3FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EA" }, { "name": "Size", "type": "integer", "required": false, "description": "查询数据项目的最大数量, 默认为10。假设传Size=10，返回的实际事件数量为N，则 5 \u003c= N \u003c= 10。", "example": "10" }, { "name": "EventId", "type": "string", "required": false, "description": "事件标识符，可以用来指定查询特定的事件，如果不指定，则查询所有事件。", "example": "low_voltage" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID 非NVR设备则不填 NVR设备则必填 默认为无", "example": "1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeCloudStorageMultiThumbnail", "description": "拉取多个云存事件缩略图", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "MultiThumbnail", "type": "string", "required": true, "description": "多个缩略图文件名根据 | 分割", "example": "\"/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg|/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg\"" } ], "required": [ "ProductId", "DeviceName", "MultiThumbnail" ] }, { "name": "DescribeCloudStorageOrder", "description": "查询云存服务详情", "status": "online", "parameters": [ { "name": "OrderId", "type": "string", "required": true, "description": "订单id", "example": "\"sdfsdfsd\"" } ], "required": [ "OrderId" ] }, { "name": "DescribeCloudStoragePackageConsumeDetails", "description": "获取云存套餐包消耗详细记录", "status": "online", "parameters": [ { "name": "StartDate", "type": "string", "required": true, "description": "开始日期", "example": "2021-11-02" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束日期", "example": "2021-11-03" } ], "required": [ "StartDate", "EndDate" ] }, { "name": "DescribeCloudStoragePackageConsumeStats", "description": "获取云存套餐包消耗统计", "status": "online", "parameters": [ { "name": "StartDate", "type": "string", "required": true, "description": "开始日期", "example": "2021-11-02" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束日期，开始与结束日期间隔不可超过一年", "example": "2021-11-03" } ], "required": [ "StartDate", "EndDate" ] }, { "name": "DescribeCloudStorageStreamData", "description": "获取设备图片流数据", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "user" }, { "name": "StartTime", "type": "integer", "required": true, "description": "图片流事件开始时间", "example": "1660561529" } ], "required": [ "ProductId", "DeviceName", "StartTime" ] }, { "name": "DescribeCloudStorageThumbnail", "description": "拉取云存事件缩略图", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "Thumbnail", "type": "string", "required": true, "description": "缩略图文件名", "example": "/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg" } ], "required": [ "ProductId", "DeviceName", "Thumbnail" ] }, { "name": "DescribeCloudStorageThumbnailList", "description": "批量拉取云存事件缩略图", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "ThumbnailList", "type": "array", "required": true, "description": "缩略图文件名列表", "example": "[\"/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg\",\"/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg\"]", "item_type": "string" } ], "required": [ "ProductId", "DeviceName", "ThumbnailList" ] }, { "name": "DescribeCloudStorageTime", "description": "获取某一天云存时间轴", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "AQTV2839QJ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "p2p_32731213_1" }, { "name": "Date", "type": "string", "required": true, "description": "云存日期，例如\"2020-01-05\"", "example": "2021-01-14" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间，unix时间", "example": "0" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间，unix时间", "example": "0" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName", "Date" ] }, { "name": "DescribeCloudStorageUsers", "description": "拉取云存用户列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页拉取数量", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页拉取偏移", "example": "0" } ], "required": [ "ProductId", "DeviceName", "Limit", "Offset" ] }, { "name": "DescribeCsReportCountDataInfo", "description": "获取云存上报统计信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品id", "example": "PTROMP3AOB" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名", "example": "dfsdfsd" }, { "name": "StartTime", "type": "integer", "required": true, "description": "统计开始时间戳", "example": "1743587952" }, { "name": "EndTime", "type": "integer", "required": true, "description": "统计结束时间戳", "example": "1743587952" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "设备通道", "example": "1" } ], "required": [ "ProductId", "DeviceName", "StartTime", "EndTime" ] }, { "name": "DescribeDataForwardList", "description": "获取数据转发列表", "status": "online", "parameters": [ { "name": "ProductIds", "type": "string", "required": true, "description": "产品ID列表", "example": "[\"78PZBTDLX6\"]" } ], "required": [ "ProductIds" ] }, { "name": "DescribeDevice", "description": "查看设备详情", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名", "example": "test1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeDeviceActionHistory", "description": "为用户提供获取动作历史的能力。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品Id", "example": "TDCZ2WD29Z" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "autotest_33842121_13" }, { "name": "MinTime", "type": "integer", "required": true, "description": "开始范围的 unix 毫秒时间戳", "example": "1612235884839" }, { "name": "MaxTime", "type": "integer", "required": true, "description": "结束范围的 unix 毫秒时间戳", "example": "1612237684839" }, { "name": "ActionId", "type": "string", "required": false, "description": "动作Id", "example": "action1" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询条数 默认为0 最大不超过500", "example": "10" }, { "name": "Context", "type": "string", "required": false, "description": "游标，标识查询位置。", "example": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAgnMbFnZpOEh2MVNWUm95SjdoYTNGUGtGR1EA" } ], "required": [ "ProductId", "DeviceName", "MinTime", "MaxTime" ] }, { "name": "DescribeDeviceCommLog", "description": "获取设备在指定时间范围内的通讯日志", "status": "online", "parameters": [ { "name": "MinTime", "type": "integer", "required": true, "description": "开始时间 13位时间戳 单位毫秒", "example": "1612235855834" }, { "name": "MaxTime", "type": "integer", "required": true, "description": "结束时间 13位时间戳 单位毫秒", "example": "1612237655834" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "TDCZ2WD29Z" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "DoNotDelete_34082530_1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回条数 默认为50", "example": "10" }, { "name": "Context", "type": "string", "required": false, "description": "检索上下文", "example": "xrnWgKu0fCz7q8JIQYFiNP" }, { "name": "Type", "type": "string", "required": false, "description": "类型：shadow 下行，device 上行 默认为空则全部查询", "example": "shadow" } ], "required": [ "MinTime", "MaxTime", "ProductId", "DeviceName" ] }, { "name": "DescribeDeviceData", "description": "获取设备属性数据", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeDeviceDataHistory", "description": "获取设备在指定时间范围内上报的历史数据。", "status": "online", "parameters": [ { "name": "MinTime", "type": "integer", "required": true, "description": "区间开始时间（Unix 时间戳，毫秒级）", "example": "1612235965943" }, { "name": "MaxTime", "type": "integer", "required": true, "description": "区间结束时间（Unix 时间戳，毫秒级）", "example": "1612237765943" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "TDCZ2WD29Z" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "DoNotDelete_34082530_1" }, { "name": "FieldName", "type": "string", "required": true, "description": "属性字段名称，对应数据模板中功能属性的标识符", "example": "tencent_handsome" }, { "name": "Limit", "type": "array", "required": false, "description": "返回条数", "example": "1", "item_type": "integer" }, { "name": "Context", "type": "string", "required": false, "description": "检索上下文", "example": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAk0zcFnBpdzE2UUE4UlZ1UnFtTjhIeV81THcA" } ], "required": [ "MinTime", "MaxTime", "ProductId", "DeviceName", "FieldName" ] }, { "name": "DescribeDeviceDataStats", "description": "查询设备数据统计", "status": "online", "parameters": [ { "name": "StartDate", "type": "string", "required": true, "description": "开始日期", "example": "2022-06-12" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束日期", "example": "2022-06-13" }, { "name": "ProductId", "type": "string", "required": false, "description": "产品id", "example": "T6xxxxKSxx" } ], "required": [ "StartDate", "EndDate" ] }, { "name": "DescribeDeviceEventHistory", "description": "获取设备的历史事件", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "QDA1PZLBNB" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev01" }, { "name": "Type", "type": "string", "required": false, "description": "搜索的事件类型：alert 表示告警，fault 表示故障，info 表示信息，为空则表示查询上述所有类型事件", "example": "alert" }, { "name": "StartTime", "type": "integer", "required": false, "description": "起始时间（Unix 时间戳，秒级）, 为0 表示 当前时间 - 24h", "example": "1560355200" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间（Unix 时间戳，秒级）, 为0 表示当前时间", "example": "1601196327" }, { "name": "Context", "type": "string", "required": false, "description": "搜索上下文, 用作查询游标", "example": "DnF1ZXJ5VGhlbkZldGNoCgAAAAAAABO3FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EA" }, { "name": "Size", "type": "integer", "required": false, "description": "单次获取的历史数据项目的最大数量, 缺省10", "example": "10" }, { "name": "EventId", "type": "string", "required": false, "description": "事件标识符，可以用来指定查询特定的事件，如果不指定，则查询所有事件。", "example": "low_voltage" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeDevicePackages", "description": "根据设备信息拉取有效套餐列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页拉取数量", "example": "20" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页拉取偏移", "example": "0" }, { "name": "CSUserId", "type": "string", "required": false, "description": "用户id", "example": "sdfdsf" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道id", "example": "0" } ], "required": [ "ProductId", "DeviceName", "Limit", "Offset" ] }, { "name": "DescribeDeviceStatusLog", "description": "获取设备上下线日志", "status": "online", "parameters": [ { "name": "MinTime", "type": "integer", "required": true, "description": "开始时间（毫秒）", "example": "1548677099000" }, { "name": "MaxTime", "type": "integer", "required": true, "description": "结束时间（毫秒）", "example": "1548763499000" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "QY8BAN391G" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev_test" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回条数", "example": "5" }, { "name": "Context", "type": "string", "required": false, "description": "检索上下文", "example": "H541SOP191FAWEF==" } ], "required": [ "MinTime", "MaxTime", "ProductId", "DeviceName" ] }, { "name": "DescribeDevices", "description": "获取设备列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "需要查看设备列表的产品 ID", "example": "PTROMP3AOB" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，Offset从0开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页的大小，最大100", "example": "10" }, { "name": "DeviceName", "type": "string", "required": false, "description": "需要过滤的设备名称", "example": "test1" } ], "required": [ "ProductId", "Offset", "Limit" ] }, { "name": "DescribeFirmware", "description": "本接口（DescribeFirmware）用于查询固件信息", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "1-2-1" } ], "required": [ "ProductID", "FirmwareVersion" ] }, { "name": "DescribeFirmwareTask", "description": "此接口查询固件升级任务详情", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "1-2-1" }, { "name": "TaskId", "type": "integer", "required": true, "description": "固件任务ID", "example": "1" } ], "required": [ "ProductID", "FirmwareVersion", "TaskId" ] }, { "name": "DescribeFirmwareTaskDevices", "description": "本接口用于查询固件升级任务的设备列表", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "adad" }, { "name": "FirmwareVersion", "type": "string", "required": false, "description": "固件版本", "example": "1-2-1" }, { "name": "Filters", "type": "array", "required": false, "description": "筛选条件", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "搜索条件的Key", "example": "data" }, { "name": "Value", "type": "string", "required": false, "description": "搜索条件的值", "example": "str" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询偏移量 默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询的数量 默认为50", "example": "10" } ], "required": [ "ProductID" ] }, { "name": "DescribeFirmwareTaskDistribution", "description": "本接口用于查询固件升级任务状态分布", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "1-2-1" }, { "name": "TaskId", "type": "integer", "required": true, "description": "固件升级任务ID", "example": "1" } ], "required": [ "ProductID", "FirmwareVersion", "TaskId" ] }, { "name": "DescribeFirmwareTaskStatistics", "description": "本接口用于查询固件升级任务统计信息", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "1-2-1" } ], "required": [ "ProductID", "FirmwareVersion" ] }, { "name": "DescribeFirmwareTasks", "description": "本接口用于查询固件升级任务列表", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "1-2-1" }, { "name": "Offset", "type": "integer", "required": true, "description": "查询偏移量", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "返回查询结果条数", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "搜索过滤条件", "example": "[{\"Key\":\"a\",\"Value\":\"b\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "搜索条件的Key", "example": "data" }, { "name": "Value", "type": "string", "required": false, "description": "搜索条件的值", "example": "str" } ] } ], "required": [ "ProductID", "FirmwareVersion", "Offset", "Limit" ] }, { "name": "DescribeForwardRule", "description": "获取产品转发规则", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "PTROMP3AOB" }, { "name": "Skey", "type": "string", "required": true, "description": "控制台Skey", "example": "safaweffawef" }, { "name": "QueueType", "type": "integer", "required": true, "description": "队列类型，0：CMQ，1：Ckafka", "example": "1" }, { "name": "Consecretid", "type": "string", "required": false, "description": "临时密钥", "example": "safawef" } ], "required": [ "ProductID", "Skey", "QueueType" ] }, { "name": "DescribeFreeCloudStorageNum", "description": "查询云存卡套餐信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMessageDataStats", "description": "查询设备消息数量统计", "status": "online", "parameters": [ { "name": "StartDate", "type": "string", "required": true, "description": "统计开始日期", "example": "2022-06-12" }, { "name": "EndDate", "type": "string", "required": true, "description": "统计结束日期", "example": "2022-06-13" }, { "name": "ProductId", "type": "string", "required": false, "description": "产品id", "example": "T6xxxxKSxx" } ], "required": [ "StartDate", "EndDate" ] }, { "name": "DescribeModelDefinition", "description": "查询产品配置的数据模板信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" } ], "required": [ "ProductId" ] }, { "name": "DescribeP2PInfo", "description": "拉取设备p2p信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeP2PRoute", "description": "当前p2p线路", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribePackageConsumeTask", "description": "查询套餐消耗记录详情", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务id", "example": "12" } ], "required": [ "TaskId" ] }, { "name": "DescribePackageConsumeTasks", "description": "查询套餐消耗记录列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页单页量", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页的偏移量，第一页为0", "example": "0" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeProduct", "description": "获取产品详情", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品id", "example": "PTROMP3AOB" } ], "required": [ "ProductId" ] }, { "name": "DescribeProductDynamicRegister", "description": "获取产品动态注册详情", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "KO9JAFB9W" } ], "required": [ "ProductId" ] }, { "name": "DescribeProducts", "description": "获取产品列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页的大小，最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，Offset从0开始", "example": "0" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribePushChannel", "description": "查看推送通道", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" } ], "required": [ "ProductId" ] }, { "name": "DescribeSDKLog", "description": "获取设备sdk日志", "status": "online", "parameters": [ { "name": "MinTime", "type": "integer", "required": true, "description": "日志开始时间", "example": "1591089960000" }, { "name": "MaxTime", "type": "integer", "required": true, "description": "日志结束时间", "example": "1591091819999" }, { "name": "Keywords", "type": "string", "required": true, "description": "查询关键字，可以同时支持键值查询和文本查询， 例如，查询某key的值为value，并且包含某word的日志，该参数为：key:value word。 键值或文本可以包含多个，以空格隔开。 其中可以索引的key包括：productid、devicename、loglevel 一个典型的查询示例：productid:7JK1G72JNE devicename:name publish loglevel:WARN一个典型的查询示例：productid:ABCDE12345 devicename:test scene:SHADOW publish", "example": "productid%3ABJQM4UXMKN+devicename%3Adev01" }, { "name": "Context", "type": "string", "required": false, "description": "日志检索上下文", "example": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAMjxEFjM2eHBiRXhJVGctQWhqdHoxNUxEeWcA" }, { "name": "MaxNum", "type": "integer", "required": false, "description": "查询条数", "example": "10" } ], "required": [ "MinTime", "MaxTime", "Keywords" ] }, { "name": "DescribeUser", "description": "获取video消费版用户信息", "status": "online", "parameters": [], "required": [] }, { "name": "EditFirmware", "description": "本接口用于编辑固件信息", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID。", "example": "UWUJ98XC0" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号。", "example": "1-2-1" }, { "name": "FirmwareName", "type": "string", "required": true, "description": "固件名称。", "example": "firmware" }, { "name": "FirmwareDescription", "type": "string", "required": false, "description": "固件描述。", "example": "testdes" } ], "required": [ "ProductID", "FirmwareVersion", "FirmwareName" ] }, { "name": "GenSingleDeviceSignatureOfPublic", "description": "获取设备的绑定签名", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "设备所属的产品ID", "example": "dev001" }, { "name": "DeviceName", "type": "string", "required": true, "description": "需要绑定的设备", "example": "H4ExxxxIZR" }, { "name": "Expire", "type": "integer", "required": true, "description": "设备绑定签名的有效时间,以秒为单位。取值范围：0 \u003c Expire \u003c= 86400，Expire == -1（十年）", "example": "86400" } ], "required": [ "ProductId", "DeviceName", "Expire" ] }, { "name": "GenerateSignedVideoURL", "description": "获取视频防盗链播放URL", "status": "online", "parameters": [ { "name": "VideoURL", "type": "string", "required": true, "description": "视频播放原始URL地址", "example": "http://zylcb.iotvideo.tencentcs.com/timeshift/live/1.m3u8" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "播放链接过期时间（时间戳，单位秒）", "example": "1619331648" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID 非NVR设备不填 NVR设备必填 默认为无", "example": "1" } ], "required": [ "VideoURL", "ExpireTime" ] }, { "name": "GetAllFirmwareVersion", "description": "本接口（GetAllFirmwareVersion）用于获取所有的版本列表", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" } ], "required": [ "ProductID" ] }, { "name": "GetFirmwareURL", "description": "本接口（GetFirmwareURL）用于获取固件存储的URL", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本", "example": "1-2-1" } ], "required": [ "ProductID", "FirmwareVersion" ] }, { "name": "ImportModelDefinition", "description": "导入其它产品的数据模板，覆盖现有数据模板的物模型和产品分类信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "ModelSchema", "type": "string", "required": true, "description": "数据模板定义", "example": "{\"model\":\"schema\"}" } ], "required": [ "ProductId", "ModelSchema" ] }, { "name": "InheritCloudStorageUser", "description": "继承云存用户", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev" }, { "name": "UserId", "type": "string", "required": true, "description": "原始用户ID", "example": "user" }, { "name": "ToUserId", "type": "string", "required": true, "description": "目标用户ID", "example": "user2" } ], "required": [ "ProductId", "DeviceName", "UserId", "ToUserId" ] }, { "name": "ListFirmwares", "description": "本接口（ListFirmwares）用于获取固件列表", "status": "online", "parameters": [ { "name": "PageNum", "type": "integer", "required": true, "description": "获取的页数", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页的大小", "example": "10" }, { "name": "ProductID", "type": "string", "required": false, "description": "产品ID", "example": "UWUJ98XC0" }, { "name": "Filters", "type": "array", "required": false, "description": "搜索过滤条件", "example": "[{\"Key\":\"test\",\"Value\":\"b\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "搜索条件的Key", "example": "data" }, { "name": "Value", "type": "string", "required": false, "description": "搜索条件的值", "example": "str" } ] } ], "required": [ "PageNum", "PageSize" ] }, { "name": "ModifyDataForward", "description": "修改数据转发", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID。", "example": "TOIDHQ3AOQ" }, { "name": "ForwardAddr", "type": "string", "required": true, "description": "转发地址。如果有鉴权Token，则需要自行传入，例如 [{\\\"forward\\\":{\\\"api\\\":\\\"http://123.207.117.108:1080/sub.php\\\",\\\"token\\\":\\\"testtoken\\\"}}]", "example": "[{\\\"forward\\\":{\\\"api\\\":\\\"http://123.207.117.108:1080/sub.php\\\"}}" }, { "name": "DataChose", "type": "integer", "required": false, "description": "1-数据信息转发 2-设备上下线状态转发 3-数据信息转发\u0026设备上下线状态转发", "example": "0" } ], "required": [ "ProductId", "ForwardAddr" ] }, { "name": "ModifyDataForwardStatus", "description": "设置数据转发状态", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID。", "example": "TOIDHQ3AOQ" }, { "name": "Status", "type": "integer", "required": true, "description": "转发状态，1启用，0禁用。", "example": "1" } ], "required": [ "ProductId", "Status" ] }, { "name": "ModifyDevice", "description": "修改设备信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "设备所属产品id", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "test1" }, { "name": "EnableState", "type": "integer", "required": false, "description": "要设置的设备状态，1为启用，0为禁用", "example": "1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "ModifyDeviceLogLevel", "description": "更新设备日志级别", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "PVEF3ZB22G" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev01" }, { "name": "LogLevel", "type": "integer", "required": true, "description": "日志级别，0：关闭，1：错误，2：告警，3：信息，4：调试", "example": "1" } ], "required": [ "ProductId", "DeviceName", "LogLevel" ] }, { "name": "ModifyForwardRule", "description": "修改转发规则", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "PV1674YINM" }, { "name": "MsgType", "type": "integer", "required": true, "description": "消息类型", "example": "1" }, { "name": "Skey", "type": "string", "required": true, "description": "控制台Skey", "example": "xrnWgKu0fCz7q8JIQYFiNP" }, { "name": "QueueRegion", "type": "string", "required": true, "description": "队列区域", "example": "gz" }, { "name": "QueueType", "type": "integer", "required": true, "description": "队列类型 0.CMQ 1.CKafka", "example": "1" }, { "name": "Consecretid", "type": "string", "required": false, "description": "临时密钥", "example": "XpyaziljFvrQg4A" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "ckafka-cy614eit" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称", "example": "iot_test_no_delete" }, { "name": "QueueID", "type": "string", "required": false, "description": "队列或主题ID", "example": "ins-queue-f1fva1" }, { "name": "QueueName", "type": "string", "required": false, "description": "队列或主题名称", "example": "iot_hub_test" } ], "required": [ "ProductID", "MsgType", "Skey", "QueueRegion", "QueueType" ] }, { "name": "ModifyModelDefinition", "description": "提供修改产品的数据模板的能力", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "ModelSchema", "type": "string", "required": true, "description": "数据模板定义", "example": "{\"data\":\"str\"}" } ], "required": [ "ProductId", "ModelSchema" ] }, { "name": "ModifyProduct", "description": "修改产品信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品id", "example": "37MFSSRMZY" }, { "name": "ProductName", "type": "string", "required": false, "description": "修改的产品名称 （支持中文、英文、数字、下划线组合，最多不超过20个字符）", "example": "name" }, { "name": "ProductDescription", "type": "string", "required": false, "description": "修改的产品描述 （最多不超过128个字符）", "example": "desc" } ], "required": [ "ProductId" ] }, { "name": "ModifyProductDynamicRegister", "description": "修改产品动态注册", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "KO9JAFB9W" }, { "name": "RegisterType", "type": "integer", "required": true, "description": "动态注册类型，0-关闭 1-预创建设备 2-自动创建设备", "example": "2" }, { "name": "RegisterLimit", "type": "integer", "required": true, "description": "动态注册设备上限", "example": "50" } ], "required": [ "ProductId", "RegisterType", "RegisterLimit" ] }, { "name": "ModifyPushChannel", "description": "更新推送通道", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "Type", "type": "string", "required": true, "description": "推送类型。ckafka：消息队列；forward：http/https推送", "example": "forward" }, { "name": "ForwardAddress", "type": "string", "required": false, "description": "第三方推送地址", "example": "https://yourdomain.com:8000/api" }, { "name": "ForwardKey", "type": "string", "required": false, "description": "第三方推送密钥，不填写则不生成签名。", "example": "kugaiuwef8rfwe" }, { "name": "CKafkaRegion", "type": "string", "required": false, "description": "ckafka地域", "example": "gz" }, { "name": "CKafkaInstance", "type": "string", "required": false, "description": "ckafka实例", "example": "ins-wehnaf" }, { "name": "CKafkaTopic", "type": "string", "required": false, "description": "ckafka订阅主题", "example": "topic" } ], "required": [ "ProductId", "Type" ] }, { "name": "PublishMessage", "description": "本接口（PublishMessage）用于使用自定义透传协议进行设备远控", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "Nlasdf****ABCd" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev1" }, { "name": "Topic", "type": "string", "required": true, "description": "消息发往的主题", "example": "RL0BAZKZ6V/dev1/control" }, { "name": "Payload", "type": "string", "required": true, "description": "云端下发到设备的控制报文", "example": "AASDFASFSADFASDF" }, { "name": "Qos", "type": "integer", "required": false, "description": "消息服务质量等级，取值为0或1", "example": "1" }, { "name": "PayloadEncoding", "type": "string", "required": false, "description": "Payload的内容编码格式，取值为base64或空。base64表示云端将接收到的base64编码后的报文再转换成二进制报文下发至设备，为空表示不作转换，透传下发至设备", "example": "base64" } ], "required": [ "ProductId", "DeviceName", "Topic", "Payload" ] }, { "name": "ReportAliveDevice", "description": "上报活跃设备", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "H541SOP191" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "ResetCloudStorage", "description": "重置云存服务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID 非NVR设备则不填 NVR设备则必填 默认为无", "example": "1" }, { "name": "UserId", "type": "string", "required": false, "description": "云存用户Id，为空则为默认云存空间。", "example": "username" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "ResetCloudStorageEvent", "description": "重置云存事件", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "RetryDeviceFirmwareTask", "description": "本接口用于重试设备升级任务", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev1" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "1-2-1" }, { "name": "TaskId", "type": "integer", "required": true, "description": "固件升级任务ID", "example": "23141421" } ], "required": [ "ProductID", "DeviceName", "FirmwareVersion", "TaskId" ] }, { "name": "SetForwardAuth", "description": "设置转发权限", "status": "online", "parameters": [ { "name": "Skey", "type": "string", "required": true, "description": "控制台Skey", "example": "xrnWgKu0fCz7q8JIQYFiNP" }, { "name": "QueueType", "type": "integer", "required": true, "description": "消息队列类型 0.CMQ 1.CKafka", "example": "1" } ], "required": [ "Skey", "QueueType" ] }, { "name": "TransferCloudStorage", "description": "转移云存服务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "已开通云存的设备名称", "example": "event_36502632_1" }, { "name": "ToDeviceName", "type": "string", "required": true, "description": "未开通云存的设备名称", "example": "event_36502632_2" }, { "name": "ToProductId", "type": "string", "required": false, "description": "未开通云存的设备产品ID", "example": "T6YxxxxS8F" } ], "required": [ "ProductId", "DeviceName", "ToDeviceName" ] }, { "name": "UpdateAIModelChannel", "description": "更新AI推理结果推送配置", "status": "online", "parameters": [ { "name": "ModelId", "type": "string", "required": true, "description": "模型ID", "example": "body_detection" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "Type", "type": "string", "required": true, "description": "推送类型。ckafka：消息队列；forward：http/https推送", "example": "forward" }, { "name": "ForwardAddress", "type": "string", "required": false, "description": "第三方推送地址", "example": "https://yourdomain.com:8000/api" }, { "name": "ForwardKey", "type": "string", "required": false, "description": "第三方推送密钥，不填写则腾讯云自动生成。", "example": "kugaiuwef8rfwe" }, { "name": "CKafkaRegion", "type": "string", "required": false, "description": "ckafka地域", "example": "gz" }, { "name": "CKafkaInstance", "type": "string", "required": false, "description": "ckafka实例", "example": "ins-wehnaf" }, { "name": "CKafkaTopic", "type": "string", "required": false, "description": "ckafka订阅主题", "example": "topic" } ], "required": [ "ModelId", "ProductId", "Type" ] }, { "name": "UploadFirmware", "description": "本接口（UploadFirmware）用于上传设备固件信息", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "UWUJ98XC0" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "1-2-1" }, { "name": "Md5sum", "type": "string", "required": true, "description": "固件的MD5值", "example": "md5" }, { "name": "FileSize", "type": "integer", "required": true, "description": "固件的大小", "example": "1" }, { "name": "FirmwareName", "type": "string", "required": false, "description": "固件名称", "example": "name" }, { "name": "FirmwareDescription", "type": "string", "required": false, "description": "固件描述", "example": "des" }, { "name": "FwType", "type": "string", "required": false, "description": "固件升级模块；可选值 mcu|moudule", "example": "mcu" } ], "required": [ "ProductID", "FirmwareVersion", "Md5sum", "FileSize" ] }, { "name": "WakeUpDevice", "description": "设备唤醒", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev" } ], "required": [ "ProductId", "DeviceName" ] } ] }