tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,299 lines (2,104 loc) • 163 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** AI视频搜索结果结构体。 */
declare interface AISearchInfo {
/** 基于搜索结果的总结 */
Summary?: string;
/** 视频结果集 */
Targets?: TargetInfo[];
/** 视频回放URL */
VideoURL?: string;
}
/** 设备激活详情信息 */
declare interface ActivateDeviceInfo {
/** 实例ID */
InstanceId: string;
/** 实例类型 */
InstanceType: number;
/** 设备激活信息 */
DeviceActivationDetails: DeviceActivationDetail;
/** 已注册设备类型信息 */
RegisteredDeviceType: RegisteredDeviceTypeInfo;
/** 已注册设备通信类型信息 */
RegisteredDeviceNetType: RegisteredDeviceNetTypeInfo;
}
/** 云api直接绑定设备出参 */
declare interface AppDeviceInfo {
/** 产品ID/设备名 */
DeviceId: string;
/** 产品ID */
ProductId: string;
/** 设备名 */
DeviceName: string;
/** 设备别名 */
AliasName: string;
/** icon地址 */
IconUrl: string;
/** 家庭ID */
FamilyId: string;
/** 房间ID */
RoomId: string;
/** 设备类型 */
DeviceType: number;
/** 创建时间 */
CreateTime: number;
/** 更新时间 */
UpdateTime: number;
}
/** 授权小程序信息 */
declare interface AuthMiniProgramAppInfo {
/** 小程序APPID */
MiniProgramAppId?: string;
/** 创建时间 */
CreateTime?: number;
/** 小程序名称 */
MiniProgramName?: string;
/** 激活码数 */
LicenseNum?: number;
/** 应用ID */
IotAppId?: string;
/** 应用名称 */
IotAppName?: string;
}
/** 获取返回列表的详情。 */
declare interface BatchProductionInfo {
/** 量产ID */
BatchProductionId?: string;
/** 产品ID */
ProductId?: string;
/** 烧录方式 */
BurnMethod?: number;
/** 创建时间 */
CreateTime?: number;
/** 产品名称 */
ProductName?: string;
}
/** BindDeviceInfo */
declare interface BindDeviceInfo {
/** 产品ID。 */
ProductId?: string;
/** 设备名称。 */
DeviceName?: string;
}
/** 绑定、未绑定产品详细信息 */
declare interface BindProductInfo {
/** 产品ID。 */
ProductId?: string;
/** 产品名称。 */
ProductName?: string;
/** 产品所属项目ID。 */
ProjectId?: string;
/** 物模型类型。 */
DataProtocol?: number;
/** 产品分组模板ID */
CategoryId?: number;
/** 产品类型 */
ProductType?: number;
/** 连接类型 */
NetType?: string;
/** 状态 */
DevStatus?: string;
/** 产品拥有者名称 */
ProductOwnerName?: string;
}
/** 标签数据结构 */
declare interface CamTag {
/** 标签键 */
TagKey?: string;
/** 标签值 */
TagValue?: string;
}
/** 云存 AI 服务任务信息 */
declare interface CloudStorageAIServiceTask {
/** 云存 AI 服务任务 ID */
TaskId?: string;
/** 产品 ID */
ProductId?: string;
/** 设备名称 */
DeviceName?: string;
/** 通道 ID */
ChannelId?: number;
/** 云存 AI 服务类型。可能取值:- `RealtimeObjectDetect`:目标检测- `Highlight`:视频浓缩- `VideoToText`:视频语义理解 */
ServiceType?: string;
/** 对应云存视频的起始时间(秒级 UNIX 时间戳) */
StartTime?: number;
/** 对应云存视频的起始时间(毫秒级 UNIX 时间戳) */
StartTimeMs?: number;
/** 对应云存视频的结束时间(秒级 UNIX 时间戳) */
EndTime?: number;
/** 对应云存视频的结束时间(毫秒级 UNIX 时间戳) */
EndTimeMs?: number;
/** 任务状态(1:失败;2:成功但结果为空;3:成功且结果非空;4:执行中) */
Status?: number;
/** 任务结果 */
Result?: string;
/** 任务输出文件列表 */
Files?: string[];
/** 任务输出文件信息列表 */
FilesInfo?: CloudStorageAIServiceTaskFileInfo[];
/** 创建时间 */
CreateTime?: number;
/** 最后更新时间 */
UpdateTime?: number;
/** 自定义任务 ID */
CustomId?: string;
}
/** 云存 AI 任务输出文件信息 */
declare interface CloudStorageAIServiceTaskFileInfo {
/** 文件名称(含扩展名) */
FileName?: string;
/** 文件大小(单位:bytes) */
FileSize?: number;
/** 文件下载 URL */
DownloadURL?: string;
/** 文件的 MIME Type */
MimeType?: string;
/** 视频文件元数据(仅当文件为视频类型时包含该字段) */
VideoMetaInfo?: CloudStorageAIServiceTaskVideoMetaInfo;
/** 文件标签 */
Labels?: CloudStorageAIServiceTaskFileLabel[];
}
/** 云存 AI 任务输出文件标签 */
declare interface CloudStorageAIServiceTaskFileLabel {
/** key1 */
Key?: string;
/** value1 */
Value?: string;
}
/** 云存 AI 任务输出视频文件元数据 */
declare interface CloudStorageAIServiceTaskVideoMetaInfo {
/** 视频对应的缩略图的文件名称(含扩展名) */
ThumbnailFileName?: string;
/** 视频时长(单位:毫秒) */
DurationMilliSeconds?: number;
}
/** 云存事件 */
declare interface CloudStorageEvent {
/** 事件起始时间(Unix 时间戳,秒级 */
StartTime: number;
/** 事件结束时间(Unix 时间戳,秒级 */
EndTime: number;
/** 事件缩略图 */
Thumbnail: string;
/** 事件ID */
EventId: string;
/** 事件录像上传状态,Finished: 全部上传成功 Partial: 部分上传成功 Failed: 上传失败 */
UploadStatus?: string;
/** 事件自定义数据 */
Data?: string;
}
/** 云存事件及其关联的云存 AI 任务 */
declare interface CloudStorageEventWithAITasks {
/** 事件起始时间(Unix 时间戳,秒级 */
StartTime?: number;
/** 事件结束时间(Unix 时间戳,秒级 */
EndTime?: number;
/** 事件缩略图 */
Thumbnail?: string;
/** 事件ID */
EventId?: string;
/** 事件录像上传状态,Finished: 全部上传成功 Partial: 部分上传成功 Failed: 上传失败 */
UploadStatus?: string;
/** 事件自定义数据 */
Data?: string;
/** 事件关联的云存 AI 任务列表 */
AITasks?: CloudStorageAIServiceTask[];
}
/** 云存套餐包信息 */
declare interface CloudStoragePackageInfo {
/** 套餐包id */
PackageId?: string;
/** 套餐包名字 */
PackageName?: string;
/** 套餐包数量 */
Num?: number;
/** 已使用数量 */
UsedNum?: number;
}
/** 云存时间轴接口返回数据 */
declare interface CloudStorageTimeData {
/** 云存时间轴信息列表 */
TimeList?: CloudStorageTimeInfo[];
/** 播放地址 */
VideoURL?: string;
}
/** 云存时间轴信息 */
declare interface CloudStorageTimeInfo {
/** 开始时间 */
StartTime?: number;
/** 结束时间 */
EndTime?: number;
}
/** 云存用户信息 */
declare interface CloudStorageUserInfo {
/** 用户ID */
UserId?: string;
}
/** 云存上报统计信息 */
declare interface CountDataInfo {
/** 视频上报异常次数 */
VideoExceptionNum?: number;
/** 视频上报成功次数 */
VideoSuccessNum?: number;
/** 视频上报成功率 */
VideoSuccessRate?: string;
/** 事件上报异常次数 */
EventExceptionNum?: number;
/** 事件上报成功次数 */
EventSuccessNum?: number;
/** 事件上报成功率 */
EventSuccessRate?: string;
}
/** 设备激活详情信息 */
declare interface DeviceActivationDetail {
/** 可注册设备数 */
TotalDeviceNum?: number;
/** 已注册设备数 */
UsedDeviceNum?: number;
/** 设备授权数 */
TotalNormalLicense?: number;
/** 已使用设备授权数 */
UsedNormalLicense?: number;
/** 蓝牙授权数 */
TotalBluetoothLicense?: number;
/** 已使用蓝牙授权数 */
UsedBluetoothLicense?: number;
/** 可免费注册设备数 */
TotalFreeLicense?: number;
/** 已使用注册设备数 */
UsedFreeLicense?: number;
}
/** 设备激活结果数据 */
declare interface DeviceActiveResult {
/** 模板ID */
ModelId?: string | null;
/** SN信息 */
Sn?: string;
/** 设备激活状态,0:激活成功;50011:系统错误;50012:产品不存在;50013:设备不存在;50014:产品无权限;50015:不是音视频产品;50016:SN格式错误;50017:激活码类型错误;50018:激活次数限频;50019:激活码不足;50020:SN已暂停; */
ErrCode?: number;
/** 过期时间 */
ExpireTime?: number;
}
/** DeviceData */
declare interface DeviceData {
/** 设备证书,用于 TLS 建立链接时校验客户端身份。采用非对称加密时返回该参数。 */
DeviceCert?: string;
/** 设备名称。 */
DeviceName?: string;
/** 设备私钥,用于 TLS 建立链接时校验客户端身份,腾讯云后台不保存,请妥善保管。采用非对称加密时返回该参数。 */
DevicePrivateKey?: string;
/** 对称加密密钥,base64编码。采用对称加密时返回该参数。 */
DevicePsk?: string;
}
/** 设备历史数据结构 */
declare interface DeviceDataHistoryItem {
/** 时间点,毫秒时间戳 */
Time?: string;
/** 字段取值 */
Value?: string;
}
/** 设备固件信息 */
declare interface DeviceFirmwareInfo {
/** 固件类型 */
FwType: string;
/** 固件版本 */
Version: string;
/** 最后更新时间 */
UpdateTime: number;
}
/** 设备详细信息 */
declare interface DeviceInfo {
/** 设备名 */
DeviceName?: string;
/** 0: 离线, 1: 在线, 2: 获取失败, 3 未激活 */
Status?: number;
/** 设备密钥,密钥加密的设备返回 */
DevicePsk?: string;
/** 首次上线时间 */
FirstOnlineTime?: number;
/** 最后一次上线时间 */
LoginTime?: number;
/** 设备创建时间 */
CreateTime?: number;
/** 设备固件版本 */
Version?: string;
/** 设备证书 */
DeviceCert?: string;
/** 日志级别 */
LogLevel?: number;
/** LoRaWAN 设备地址 */
DevAddr?: string;
/** LoRaWAN 应用密钥 */
AppKey?: string;
/** LoRaWAN 设备唯一标识 */
DevEUI?: string;
/** LoRaWAN 应用会话密钥 */
AppSKey?: string;
/** LoRaWAN 网络会话密钥 */
NwkSKey?: string;
/** 创建人Id */
CreateUserId?: number;
/** 创建人昵称 */
CreatorNickName?: string;
/** 启用/禁用状态 */
EnableState?: number;
/** 产品ID */
ProductId?: string;
/** 产品名称 */
ProductName?: string;
/** 设备类型(设备、子设备、网关) */
DeviceType?: string;
/** 是否是 lora 设备 */
IsLora?: boolean;
}
/** 设备位置详情 */
declare interface DevicePositionItem {
/** 设备名称 */
DeviceName?: string;
/** 位置信息时间 */
CreateTime?: number;
/** 设备经度信息 */
Longitude?: number;
/** 设备纬度信息 */
Latitude?: number;
}
/** 设备签名 */
declare interface DeviceSignatureInfo {
/** 设备名 */
DeviceName?: string;
/** 设备签名 */
DeviceSignature?: string;
}
/** 设备的用户 */
declare interface DeviceUser {
/** 用户ID */
UserId?: string;
/** 用户角色 1所有者,0:其他分享者 */
Role?: number;
/** 家庭ID,所有者带该参数 */
FamilyId?: string;
/** 家庭名称,所有者带该参数 */
FamilyName?: string;
}
/** ProductId -> DeviceName */
declare interface DevicesItem {
/** 产品id */
ProductId: string;
/** 设备名称 */
DeviceName: string;
}
/** Diary Simple Highlight 配置 */
declare interface DiarySHLConfig {
/** 每个视频偏移时长,单位秒 */
StartOffset?: number;
/** 视频浓缩倍数,支持1,2,4之间 */
PlaySpeed?: number;
/** 单个视频最小提取时长,单位秒 */
MiniExtract?: number;
/** 每天最终输出视频时长,单位秒注:免费版固定10s */
OutDuration?: number;
}
/** 设备事件的搜索结果项 */
declare interface EventHistoryItem {
/** 事件的时间戳 */
TimeStamp?: number;
/** 事件的产品ID */
ProductId?: string;
/** 事件的设备名称 */
DeviceName?: string;
/** 事件的标识符ID */
EventId?: string;
/** 事件的类型 */
Type?: string;
/** 事件的数据 */
Data?: string;
}
/** 子设备详情 */
declare interface FamilySubDevice {
/** 产品Id */
ProductId?: string;
/** 设备名称 */
DeviceName?: string;
/** 设备ID */
DeviceId?: string;
/** 设备别名 */
AliasName?: string;
/** 设备绑定的家庭ID */
FamilyId?: string;
/** 设备所在的房间ID,默认"0" */
RoomId?: string;
/** 图标 */
IconUrl?: string;
/** grid图标 */
IconUrlGrid?: string;
/** 设备绑定时间戳 */
CreateTime?: number;
/** 设备更新时间戳 */
UpdateTime?: number;
}
/** 围栏告警位置点 */
declare interface FenceAlarmPoint {
/** 围栏告警时间 */
AlarmTime?: number;
/** 围栏告警位置的经度 */
Longitude?: number;
/** 围栏告警位置的纬度 */
Latitude?: number;
}
/** 围栏绑定的设备信息 */
declare interface FenceBindDeviceItem {
/** 设备名称 */
DeviceName: string;
/** 告警条件(In,进围栏报警;Out,出围栏报警;InOrOut,进围栏或者出围栏均报警) */
AlertCondition: string;
/** 是否使能围栏(true,使能;false,禁用) */
FenceEnable: boolean;
/** 告警处理方法 */
Method: string;
}
/** 围栏绑定的产品信息 */
declare interface FenceBindProductItem {
/** 围栏绑定的设备信息 */
Devices: FenceBindDeviceItem[];
/** 围栏绑定的产品Id */
ProductId: string;
}
/** 围栏事件详情 */
declare interface FenceEventItem {
/** 围栏事件的产品Id */
ProductId?: string;
/** 围栏事件的设备名称 */
DeviceName?: string;
/** 围栏Id */
FenceId?: number;
/** 围栏事件的告警类型(In,进围栏报警;Out,出围栏报警;InOrOut,进围栏或者出围栏均报警) */
AlertType?: string;
/** 围栏事件的设备位置信息 */
Data?: FenceAlarmPoint;
}
/** 描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等- 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。- 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。 */
declare interface Filter {
/** 需要过滤的字段 */
Name: string;
/** 字段的过滤的一个或多个值 */
Values?: string[];
}
/** 设备固件详细信息 */
declare interface FirmwareInfo {
/** 固件版本 */
Version?: string;
/** 固件MD5值 */
Md5sum?: string;
/** 固件创建时间 */
CreateTime?: number;
/** 产品名称 */
ProductName?: string;
/** 固件名称 */
Name?: string;
/** 固件描述 */
Description?: string;
/** 产品ID */
ProductId?: string;
/** 固件升级模块 */
FwType?: string;
/** 创建者子 uin */
CreateUserId?: number;
/** 创建者昵称 */
CreatorNickName?: string;
/** 固件用户自定义配置信息 */
UserDefined?: string;
}
/** 实例信息公共实例过期时间 0001-01-01T00:00:00Z,公共实例是永久有效 */
declare interface InstanceDetail {
/** 实例ID */
InstanceId?: string;
/** 实例类型(0 公共实例 1 标准企业实例 2新企业实例3新公共实例) */
InstanceType?: number;
/** 地域字母缩写 */
Region?: string;
/** 区域全拼 */
ZoneId?: string;
/** 支持设备总数 */
TotalDeviceNum?: number;
/** 已注册设备数 */
UsedDeviceNum?: number;
/** 项目数 */
ProjectNum?: number;
/** 产品数 */
ProductNum?: number;
/** 创建时间 */
CreateTime?: string;
/** 更新时间 */
UpdateTime?: string;
/** 过期时间,公共实例过期时间 0001-01-01T00:00:00Z,公共实例是永久有效 */
ExpireTime?: string;
/** 总设备数 */
TotalDevice?: number;
/** 激活设备数 */
ActivateDevice?: number;
/** 备注 */
Description?: string;
/** 实例状态 */
Status?: number;
/** 消息上下行配置TPS */
UpDownTPS?: number;
/** 当前消息上下行TPS */
UpDownCurrentTPS?: number;
/** 消息转发配置TPS */
ForwardTPS?: number;
/** 消息转发当前TPS */
ForwardCurrentTPS?: number;
/** 实例单元数 */
CellNum?: number;
/** 实例Tag,企业实例必传 */
BillingTag?: string;
/** 每日消息数 */
EverydayFreeMessageCount?: number;
/** 最大在线设备数 */
MaxDeviceOnlineCount?: number;
}
/** 应用信息 */
declare interface IotApplication {
/** 应用 ID */
IotAppID?: string;
/** 应用名称 */
AppName?: string;
/** 应用说明 */
Description?: string;
/** 开发模式 */
DevMode?: number;
/** iOS 平台 AppKey */
IOSAppKey?: string;
/** iOS 平台 AppSecret */
IOSAppSecret?: string;
/** Android 平台 AppKey */
AndroidAppKey?: string;
/** Android 平台 AppSecret */
AndroidAppSecret?: string;
/** 绑定的产品列表,数据为:ProdcutID 数组 JSON 序列化后的字符串 */
Products?: string;
/** 创建时间 */
CreateTime?: string;
/** 项目ID */
ProjectId?: string;
/** 信鸽推送APP ID */
PushSecretID?: string;
/** 信鸽推送SECRET KEY */
PushSecretKey?: string;
/** iOS平台推送环境 */
PushEnvironment?: string;
/** 小程序平台 AppKey */
MiniProgramAppKey?: string;
/** 小程序平台 AppSecret */
MiniProgramAppSecret?: string;
/** TPNS服务iOS应用AccessID,TPNS全称为腾讯移动推送(Tencent Push Notification Service),详见:https://cloud.tencent.com/document/product/548 */
TPNSiOSAccessID?: string;
/** TPNS服务iOS应用SecretKey */
TPNSiOSSecretKey?: string;
/** TPNS服务iOS应用推送环境 */
TPNSiOSPushEnvironment?: string;
/** TPNS服务Android应用AccessID */
TPNSAndroidAccessID?: string;
/** TPNS服务Android应用SecretKey */
TPNSAndroidSecretKey?: string;
/** TPNS服务iOS应用所属地域,详细说明参见 ModifyApplication 同名入参。 */
TPNSiOSRegion?: string;
/** TPNS服务Android应用所属地域,详细说明参见 ModifyApplication 同名入参。 */
TPNSAndroidRegion?: string;
/** 自主短信配置APPID */
SelfSmsAppId?: string;
/** 自主短信配置APPKey */
SelfSmsAppKey?: string;
/** 自主短信配置签名 */
SelfSmsSign?: string;
/** 自主短信配置模板ID */
SelfSmsTemplateId?: number;
/** 第三方小程序强提醒开关 0:关闭;1:开启 */
WechatNotifyStatus?: number;
/** 互联互通产品ID列表 */
InterconnectionProducts?: string;
}
/** 增值服务数量统计 */
declare interface LicenseServiceNumInfo {
/** 服务类型 */
LicenseType?: string;
/** 授权总数 */
TotalNum?: number;
/** 已使用授权数 */
UsedNum?: number;
/** TWeCall激活码 */
TWeCallLicense?: TWeCallLicenseInfo[];
}
/** LoRa自定义频点信息 */
declare interface LoRaFrequencyEntry {
/** 频点唯一ID */
FreqId?: string;
/** 频点名称 */
FreqName?: string;
/** 频点描述 */
Description?: string;
/** 数据上行信道 */
ChannelsDataUp?: number[];
/** 数据下行信道RX1 */
ChannelsDataRX1?: number[];
/** 数据下行信道RX2 */
ChannelsDataRX2?: number[];
/** 入网上行信道 */
ChannelsJoinUp?: number[];
/** 入网下行RX1信道 */
ChannelsJoinRX1?: number[];
/** 入网下行RX2信道 */
ChannelsJoinRX2?: number[];
/** 创建时间 */
CreateTime?: number;
}
/** LoRa 网关信息 */
declare interface LoRaGatewayItem {
/** LoRa 网关Id */
GatewayId: string;
/** 是否是公开网关 */
IsPublic: boolean;
/** 网关描述 */
Description: string;
/** 网关名称 */
Name: string;
/** 网关位置信息 */
Position: string;
/** 网关位置详情 */
PositionDetails: string;
/** LoRa 网关位置坐标 */
Location: LoRaGatewayLocation;
/** 最后更新时间 */
UpdatedAt: string;
/** 创建时间 */
CreatedAt: string;
/** 最后上报时间 */
LastSeenAt: string;
/** 频点ID */
FrequencyId?: string;
}
/** 网关坐标 */
declare interface LoRaGatewayLocation {
/** 纬度 */
Latitude: number;
/** 精度 */
Longitude: number;
/** 准确度 */
Accuracy?: number;
/** 海拔 */
Altitude?: number;
}
/** 云存套餐包消耗统计 */
declare interface PackageConsumeStat {
/** 云存套餐包id */
PackageId?: string;
/** 云存套餐包名称 */
PackageName?: string;
/** 消耗个数 */
Cnt?: number;
/** 套餐包单价,单位分 */
Price?: number;
/** 消耗来源,1预付费 */
Source?: number;
}
/** 套餐包消耗任务列表 */
declare interface PackageConsumeTask {
/** 任务id */
TaskId?: number;
/** 任务创始时间 */
CreateTime?: string;
/** 任务状态,1待处理,2处理中,3已完成 */
State?: number;
}
/** 结构体(PackageInfo)记录了设备拥有的有效套餐信息,包括云存开启状态、云存类型、云存回看时长、云存套餐过期时间 */
declare interface PackageInfo {
/** 云存开启状态,0为未开启,2为正在生效,1为已过期注:这里只返回状态为0的数据 */
Status?: number;
/** 云存类型,1为全时云存,2为事件云存 */
CSType?: number;
/** 云存回看时长 */
CSShiftDuration?: number;
/** 云存套餐过期时间 */
CSExpiredTime?: number;
/** 云存套餐创建时间 */
CreatedAt?: number;
/** 云存套餐更新时间 */
UpdatedAt?: number;
/** 套餐id */
PackageId?: string;
/** 订单id */
OrderId?: string;
/** 通道id */
ChannelId?: number;
/** 用户id */
CSUserId?: string;
}
/** 围栏详细信息(包含创建时间及更新时间) */
declare interface PositionFenceInfo {
/** 围栏信息 */
GeoFence?: PositionFenceItem;
/** 围栏创建时间 */
CreateTime?: number;
/** 围栏更新时间 */
UpdateTime?: number;
}
/** 围栏信息 */
declare interface PositionFenceItem {
/** 围栏Id */
FenceId?: number;
/** 位置空间Id */
SpaceId?: string;
/** 围栏名称 */
FenceName?: string;
/** 围栏描述 */
FenceDesc?: string;
/** 围栏区域信息,采用 GeoJSON 格式 */
FenceArea?: string;
}
/** 位置点 */
declare interface PositionItem {
/** 位置点的时间 */
CreateTime?: number;
/** 位置点的经度 */
Longitude?: number;
/** 位置点的纬度 */
Latitude?: number;
/** 位置点的定位类型 */
LocationType?: string;
/** 位置点的精度预估,单位为米 */
Accuracy?: number;
}
/** 位置空间详情 */
declare interface PositionSpaceInfo {
/** 项目Id */
ProjectId?: string;
/** 位置空间Id */
SpaceId?: string;
/** 位置空间名称 */
SpaceName?: string;
/** 授权类型 */
AuthorizeType?: number;
/** 描述备注 */
Description?: string;
/** 产品列表 */
ProductIdList?: string[];
/** 缩略图 */
Icon?: string;
/** 创建时间 */
CreateTime?: number;
/** 更新时间 */
UpdateTime?: number;
/** 用户自定义地图缩放 */
Zoom?: number;
}
/** 产品设备位置信息 */
declare interface ProductDevicesPositionItem {
/** 设备位置列表 */
Items?: DevicePositionItem[];
/** 产品标识 */
ProductId?: string;
/** 设备位置数量 */
Total?: number;
}
/** 产品详情 */
declare interface ProductEntry {
/** 产品ID */
ProductId?: string;
/** 产品名称 */
ProductName?: string;
/** 产品分组模板ID */
CategoryId?: number;
/** 加密类型。1表示证书认证,2表示密钥认证,21表示TID认证-SE方式,22表示TID认证-软加固方式 */
EncryptionType?: string;
/** 连接类型。如:wifi、wifi-ble、cellular、5g、lorawan、ble、ethernet、wifi-ethernet、else、sub_zigbee、sub_ble、sub_433mhz、sub_else、sub_blemesh */
NetType?: string;
/** 数据协议 (1 使用物模型 2 为自定义类型) */
DataProtocol?: number;
/** 产品描述 */
ProductDesc?: string;
/** 状态 如:all 全部, dev 开发中, audit 审核中 released 已发布 */
DevStatus?: string;
/** 创建时间 */
CreateTime?: number;
/** 更新时间 */
UpdateTime?: number;
/** 区域 */
Region?: string;
/** 产品类型。如: 0 普通产品 , 5 网关产品 */
ProductType?: number;
/** 项目ID */
ProjectId?: string;
/** 产品ModuleId */
ModuleId?: number;
/** 是否使用脚本进行二进制转json功能 可以取值 true / false */
EnableProductScript?: string;
/** 创建人 UinId */
CreateUserId?: number;
/** 创建者昵称 */
CreatorNickName?: string;
/** 绑定策略(1:强踢;2:非强踢;0:表示无意义) */
BindStrategy?: number;
/** 设备数量 */
DeviceCount?: number;
/** 平均传输速率 */
Rate?: string;
/** 有效期 */
Period?: string;
/** 互联互通标识 */
IsInterconnection?: number;
}
/** 产品模型定义 */
declare interface ProductModelDefinition {
/** 产品ID */
ProductId?: string;
/** 模型定义 */
ModelDefine?: string;
/** 更新时间,秒级时间戳 */
UpdateTime?: number;
/** 创建时间,秒级时间戳 */
CreateTime?: number;
/** 产品所属分类的模型快照(产品创建时刻的) */
CategoryModel?: string;
/** 产品的连接类型的模型 */
NetTypeModel?: string;
}
/** 项目详情 */
declare interface ProjectEntry {
/** 项目ID */
ProjectId?: string;
/** 项目名称 */
ProjectName?: string;
/** 项目描述 */
ProjectDesc?: string;
/** 创建时间,unix时间戳 */
CreateTime?: number;
/** 更新时间,unix时间戳 */
UpdateTime?: number;
}
/** 项目详情 */
declare interface ProjectEntryEx {
/** 项目ID */
ProjectId?: string;
/** 项目名称 */
ProjectName?: string;
/** 项目描述 */
ProjectDesc?: string;
/** 项目创建时间,unix时间戳 */
CreateTime?: number;
/** 项目更新时间,unix时间戳 */
UpdateTime?: number;
/** 产品数量 */
ProductCount?: number;
/** NativeApp数量 */
NativeAppCount?: number;
/** WebApp数量 */
WebAppCount?: number;
/** 实例ID */
InstanceId?: string;
/** 应用数量 */
ApplicationCount?: number;
/** 设备注册总数 */
DeviceCount?: number;
/** 是否开通物联使能 */
EnableOpenState?: number;
}
/** 已注册通信类型信息 */
declare interface RegisteredDeviceNetTypeInfo {
/** 普通设备数 */
NormalDeviceNum: number;
/** 蓝牙设备数 */
BluetoothDeviceNum: number;
}
/** 已注册设备类型信息 */
declare interface RegisteredDeviceTypeInfo {
/** 已注册设备数 */
NormalDeviceNum?: number;
/** 已注册网关数 */
GatewayDeviceNum?: number;
/** 已注册子设备数 */
SubDeviceNum?: number;
/** 已注册视频设备数 */
VideoDeviceNum?: number;
}
/** 搜索关键词 */
declare interface SearchKeyword {
/** 搜索条件的Key */
Key: string;
/** 搜索条件的值 */
Value?: string;
}
/** TRTC 的参数 可以用来加入房间 */
declare interface TRTCParams {
/** TRTC入参: TRTC的实例ID */
SdkAppId?: number;
/** TRTC入参: 用户加入房间的ID */
UserId?: string;
/** TRTC入参: 用户的签名用来鉴权 */
UserSig?: string;
/** TRTC入参: 加入的TRTC房间名称 */
StrRoomId?: string;
/** TRTC入参: 校验TRTC的KEY */
PrivateKey?: string;
}
/** TWeCall设备激活信息 */
declare interface TWeCallActiveInfo {
/** 小程序ID */
ModelId?: string | null;
/** Sn信息 */
Sn?: string;
/** 过期时间 */
ExpireTime?: number;
/** 类型 */
PkgType?: number;
}
/** TWeCall信息 */
declare interface TWeCallInfo {
/** Sn信息,SN格式:产品ID_设备名 */
Sn: string;
/** 小程序ID,参数已弃用,不用传参 */
ModelId?: string | null;
/** 激活数 */
ActiveNum?: number | null;
}
/** TWeCall信息 */
declare interface TWeCallLicenseInfo {
/** voip类型 */
TWeCallType?: string;
/** 总数 */
TotalNum?: number;
/** 已使用 */
UsedNum?: number;
}
/** 视频语义搜索结果 */
declare interface TargetInfo {
/** 视频唯一ID */
Id?: string;
/** 产品ID */
ProductId?: string;
/** 设备名称 */
DeviceName?: string;
/** 视频起始时间(毫秒级Unix时间戳) */
StartTimeMs?: number;
/** 视频结束时间(毫秒级Unix时间戳) */
EndTimeMs?: number;
/** 用户自定义事件ID,后续扩展使用 */
EventId?: string;
/** 视频内容摘要 */
Summary?: string;
/** 通道ID */
ChannelId?: number;
/** 缩略图路径 */
Thumbnail?: string;
}
/** 缩略图信息 */
declare interface ThumbnailURLInfoList {
/** 缩略图访问地址 */
ThumbnailURL?: string;
/** 缩略图访问地址的过期时间 */
ExpireTime?: number;
}
/** Topic信息, 包括Topic名字和权限 */
declare interface TopicItem {
/** Topic名称 */
TopicName?: string;
/** Topic权限 , 1上报 2下发 */
Privilege?: number;
}
/** TopicRule结构 */
declare interface TopicRule {
/** 规则名称。 */
RuleName?: string;
/** 规则的SQL语句,如: SELECT * FROM 'pid/dname/event',然后对其进行base64编码,得:U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw== */
Sql?: string;
/** 规则描述。 */
Description?: string;
/** 行为的JSON字符串。 */
Actions?: string;
/** 是否禁用规则 */
RuleDisabled?: boolean;
}
/** 规则信息 */
declare interface TopicRuleInfo {
/** 规则名称 */
RuleName?: string;
/** 规则描述 */
Description?: string;
/** 创建时间 */
CreatedAt?: number;
/** 规则是否禁用 */
RuleDisabled?: boolean;
}
/** TopicRulePayload结构 */
declare interface TopicRulePayload {
/** 规则的SQL语句,如: SELECT * FROM 'pid/dname/event',然后对其进行base64编码,得:U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw== */
Sql: string;
/** 行为的JSON字符串,大部分种类举例如下:[{"republish": {"topic": "TEST/test"}},{"forward": {"api": "http://test.com:8080"}},{"ckafka": {"instance": {"id": "ckafka-test","name": ""},"topic": {"id": "topic-test","name": "test"},"region": "gz"}},{"cmqqueue": {"queuename": "queue-test-TEST","region": "gz"}},{"mysql": {"instanceid": "cdb-test","region": "gz","username": "test","userpwd": "*****","dbname": "d_mqtt","tablename": "t_test","fieldpairs": [{"field": "test","value": "test"}],"devicetype": "CUSTOM"}}] */
Actions?: string;
/** 规则描述 */
Description?: string;
/** 是否禁用规则 */
RuleDisabled?: boolean;
}
/** 视频设备激活码统计 */
declare interface VideoLicenseEntity {
/** 激活码类型,取值范围如下:0_5_mbps、1_mbps、1_5_mbps、2_mbps */
Type?: string;
/** 有效激活码总数 */
TotalCount?: number;
/** 待使用的激活码数量 */
UsedCount?: number;
/** 即将过期的激活码数量 */
ExpiresSoonCount?: number;
}
/** TWeSee 语义理解结果 */
declare interface VisionRecognitionResult {
/** 任务状态(1:分析失败;2:下载/读取视频/图片失败;3:成功) */
Status?: number;
/** 识别到的目标类型。可能取值:- `person`:人- `vehicle`:车辆- `dog`:狗- `cat`:猫- `fire`:火焰- `smoke`:烟雾- `package`:快递包裹- `license_plate`:车牌 */
DetectedClassifications?: string[];
/** 摘要文本 */
Summary?: string;
/** 摘要文本(次选语言) */
AlternativeSummary?: string;
}
/** 微信硬件设备信息 */
declare interface WXDeviceInfo {
/** 设备ID */
DeviceId?: string;
/** 设备信息 */
WXIoTDeviceInfo?: WXIoTDeviceInfo;
}
/** 微信物联网硬件信息 */
declare interface WXIoTDeviceInfo {
/** sn信息 */
SN?: string;
/** 票据 */
SNTicket?: string;
/** 模板ID */
ModelId?: string;
}
/** wifi定位信息 */
declare interface WifiInfo {
/** mac地址 */
MAC: string;
/** 信号强度 */
RSSI: number;
}
declare interface ActivateTWeCallLicenseRequest {
/** TWecall类型:0-体验套餐;1-基础版;3-高级版; */
PkgType: number;
/** 参数已弃用,不用传参 */
MiniProgramAppId?: string;
/** 设备列表 */
DeviceList?: TWeCallInfo[];
}
declare interface ActivateTWeCallLicenseResponse {
/** 设备激活返回数据 */
DeviceList?: DeviceActiveResult[];
/** 设备激活失败返回数据 */
FailureList?: DeviceActiveResult[];
/** 设备激活成功返回数据 */
SuccessList?: DeviceActiveResult[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BindCloudStorageUserRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 用户ID */
UserId: string;
}
declare interface BindCloudStorageUserResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BindDevicesRequest {
/** 网关设备的产品ID。 */
GatewayProductId: string;
/** 网关设备的设备名。 */
GatewayDeviceName: string;
/** 被绑定设备的产品ID。 */
ProductId: string;
/** 被绑定的多个设备名。 */
DeviceNames: string[];
}
declare interface BindDevicesResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BindProductsRequest {
/** 网关产品ID。 */
GatewayProductId: string;
/** 待绑定的子产品ID数组。 */
ProductIds: string[];
}
declare interface BindProductsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CallDeviceActionAsyncRequest {
/** 产品Id */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 产品数据模板中行为功能的标识符,由开发者自行根据设备的应用场景定义 */
ActionId: string;
/** 输入参数 */
InputParams?: string;
}
declare interface CallDeviceActionAsyncResponse {
/** 调用Id */
ClientToken?: string;
/** 异步调用状态 */
Status?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CallDeviceActionSyncRequest {
/** 产品Id */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 产品数据模板中行为功能的标识符,由开发者自行根据设备的应用场景定义 */
ActionId: string;
/** 输入参数 */
InputParams?: string;
}
declare interface CallDeviceActionSyncResponse {
/** 调用Id */
ClientToken?: string;
/** 输出参数,取值设备端上报$thing/up/action method为action_reply 的 response字段,物模型协议参考https://cloud.tencent.com/document/product/1081/34916 */
OutputParams?: string;
/** 返回状态,取值设备端上报$thing/up/action method为action_reply 的 status字段,如果不包含status字段,则取默认值,空字符串,物模型协议参考https://cloud.tencent.com/document/product/1081/34916 */
Status?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CancelAssignTWeCallLicenseRequest {
/** 订单号 */
PkgId: string;
}
declare interface CancelAssignTWeCallLicenseResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ChangeP2PRouteRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** P2P线路 */
RouteId: number;
}
declare interface ChangeP2PRouteResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CheckFirmwareUpdateRequest {
/** 产品ID。 */
ProductId: string;
/** 设备名称。 */
DeviceName: string;
}
declare interface CheckFirmwareUpdateResponse {
/** 设备当前固件版本。 */
CurrentVersion?: string;
/** 固件可升级版本。 */
DstVersion?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ControlDeviceDataRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义 */
Data: string;
/** 请求类型 , 不填该参数或者 desired 表示下发属性给设备, reported 表示模拟设备上报属性 */
Method?: string;
/** 设备ID,该字段有值将代替 ProductId/DeviceName , 通常情况不需要填写 */
DeviceId?: string;
/** 上报数据UNIX时间戳(毫秒), 仅对Method:reported有效 */
DataTimestamp?: number;
}
declare interface ControlDeviceDataResponse {
/** 返回信息 */
Data?: string;
/** JSON字符串, 返回下发控制的结果信息, Sent = 1 表示设备已经在线并且订阅了控制下发的mqtt topic.pushResult 是表示发送结果,其中 0 表示成功, 23101 表示设备未在线或没有订阅相关的 MQTT Topic。 */
Result?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAISearchTaskAsyncRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 自然语言查询 */
Query: string;
/** 搜索结果总结的语言类型,支持的类型有:en-US、zh-CN、id-ID、th-TH */
SummaryLang?: string;
/** 通道ID */
ChannelId?: number;
}
declare interface CreateAISearchTaskAsyncResponse {
/** 任务ID */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateBatchProductionRequest {
/** 项目ID */
ProjectId: string;
/** 产品ID */
ProductId: string;
/** 烧录方式,0为直接烧录,1为动态注册。 */
BurnMethod: number;
/** 生成方式,0为系统生成,1为文件上传。 */
GenerationMethod: number;
/** 文件上传URL,用于文件上传时填写。 */
UploadUrl?: string;
/** 量产数量,用于系统生成时填写。 */
BatchCnt?: number;
/** 是否生成二维码,0为不生成,1为生成。 */
GenerationQRCode?: number;
}
declare interface CreateBatchProductionResponse {
/** 项目Id */
ProjectId: string;
/** 产品Id */
ProductId: string;
/** 量产id */
BatchProductionId: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudStorageAIServiceRequest {
/** 产品 ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 云存 AI 套餐 ID。可选值:- `1m_low_od`:低功耗目标检测月套餐- `1y_low_od`:低功耗目标检测年套餐- `1m_ev_od`:事件目标检测月套餐- `1y_ev_od`:事件目标检测年套餐- `1m_ft_od`:全时目标检测月套餐- `1y_ft_od`:全时目标检测年套餐- `1m_low_hl`:低功耗视频浓缩月套餐- `1y_low_hl`:低功耗视频浓缩年套餐- `1m_ev_hl`:事件视频浓缩月套餐- `1y_ev_hl`:事件视频浓缩年套餐- `1m_ft_hl`:全时视频浓缩月套餐- `1y_ft_hl`:全时视频浓缩年套餐 */
PackageId: string;
/** 通道 ID */
ChannelId?: number;
/** 订单 ID */
OrderId?: string;
}
declare interface CreateCloudStorageAIServiceResponse {
/** 订单 ID */
OrderId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudStorageAIServiceTaskRequest {
/** 产品 ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 云存 AI 服务类型。可选值:- `RealtimeObjectDetect`:目标检测- `Highlight`:视频浓缩- `VideoToText`:视频语义理解 */
ServiceType: string;
/** 待分析云存的起始时间 */
StartTime: number;
/** 待分析云存的结束时间 */
EndTime: number;
/** 通道 ID */
ChannelId?: number;
/** 视频分析配置参数 */
Config?: string;
/** 视频分析识别区域 */
ROI?: string;
/** 分析外部传入的视频 URL 列表,支持 HLS 点播(m3u8)及常见视频格式(mp4 等) */
VideoURLs?: string[];
/** 自定义任务 ID */
CustomId?: string;
}
declare interface CreateCloudStorageAIServiceTaskResponse {
/** 任务 ID */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDeviceChannelRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 通道ID */
ChannelId: number;
}
declare interface CreateDeviceChannelResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDeviceRequest {
/** 产品ID。 */
ProductId: string;
/** 设备名称。命名规则:[a-zA-Z0-9:_-]{1,48}。 */
DeviceName: string;
/** LoRaWAN 设备地址 */
DevAddr?: string;
/** LoRaWAN 应用密钥 */
AppKey?: string;
/** LoRaWAN 设备唯一标识 */
DevEUI?: string;
/** LoRaWAN 应用会话密钥 */
AppSKey?: string;
/** LoRaWAN 网络会话密钥 */
NwkSKey?: string;
/** 手动指定设备的PSK密钥 */
DefinedPsk?: string;
}
declare interface CreateDeviceResponse {
/** 设备参数描述。 */
Data?: DeviceData;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateExternalSourceAIServiceTaskRequest {
/** 产品 ID */
ProductId: string;
/** 云存 AI 服务类型。可选值:- `RealtimeObjectDetect`:目标检测- `Highlight`:视频浓缩- `VideoToText`:视频语义理解 */
ServiceType: string;
/** 分析外部传入的视频 URL 列表,支持 HLS 点播(m3u8)及常见视频格式(mp4 等) */
VideoURLs: string[];
/** 自定义任务 ID */
CustomId?: string;
/** 视频分析配置参数 */
Config?: string;
/** 视频分析识别区域 */
ROI?: string;
}
declare interface CreateExternalSourceAIServiceTaskResponse {
/** 任务 ID */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateFenceBindRequest {
/** 围栏Id */
FenceId: number;
/** 围栏绑定的产品列表 */
Items: FenceBindProductItem[];
}
declare interface CreateFenceBindResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateFreeCloudStorageRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 云存套餐ID:lye1w3d:低功耗事件3天周套餐。ye1w3d:事件3天周套餐 */
PackageId: string;
/** 如果当前设备已开启云存套餐,Override=1会使用新套餐覆盖原有套餐。不传此参数则默认为0。 */
Override?: number;
/** 套餐列表顺序:PackageQueue=front会立即使用新购买的套餐,新购套餐结束后,列表中下一个未过期的套餐继续生效;PackageQueue=end会等设备当前所有已购买套餐过期后才会生效新购套餐。与Override参数不能同时使用。 */
PackageQueue?: string;
/** 订单id */
OrderId?: string;
/** 通道ID */
ChannelId?: number;
/** 云存视频存储区域,国内默认为ap-guangzhou。海外默认为东南亚ap-singapore,可选美东na-ashburn、欧洲eu-frankfurt。 */
StorageRegion?: string;
}
declare interface CreateFreeCloudStorageResponse {
/** 订单金额,单位为分 */
Price?: number;
/** 支付金额,单位为分 */
Amount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateIotVideoCloudStorageRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 云存套餐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天存储年套餐。yc1w7d : 全时7天存储周套餐。ye1w7d : 事件7天存储周套餐。lye1m3d:低功耗事件3天月套餐。lye1m7d:低功耗事件7天月套餐。lye1m30d:低功耗事件30天月套餐。lye1y3d:低功耗事件3天年套餐。lye1y7d:低功耗事件7天年套餐。lye1y30d:低功耗事件30天年套餐。 */
PackageId: string;
/** 如果当前设备已开启云存套餐,Override=1会使用新套餐覆盖原有套餐。不传此参数则默认为0。 */
Override?: number;
/** 套餐列表顺序:PackageQueue=front会立即使用新购买的套餐,新购套餐结束后,列表中下一个未过期的套餐继续生效;PackageQueue=end会等设备当前所有已购买套餐过期后才会生效新购套餐。与Override参数不能同时使用。 */
PackageQueue?: string;
/** 订单id */
OrderId?: string;
/** 通道ID */
ChannelId?: number;
/** 云存视频存储区域,国内默认为ap-guangzhou。海外默认为东南亚ap-singapore,可选美东na-ashburn、欧洲eu-frankfurt。 */
StorageRegion?: string;
}
declare interface CreateIotVideoCloudStorageResponse {
/** 订单金额,单位为分 */
Price?: number;
/** 支付金额,单位为分 */
Amount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateLoRaFrequencyRequest {
/** 频点配置名称 */
FreqName?: string;
/** 数据上行信道 */
ChannelsDataUp?: number[];
/** 数据下行RX1信道 */
ChannelsDataRX1?: number[];
/** 数据下行RX2信道 */
ChannelsDataRX2?: number[];
/** 入网上行信道 */
ChannelsJoinUp?: number[];
/** 入网下行RX1信道 */
ChannelsJoinRX1?: number[];
/** 入网下行RX2信道 */
ChannelsJoinRX2?: number[];
/** 频点配置描述 */
Description?: string;
}
declare interface CreateLoRaFrequencyResponse {
/** LoRa频点信息 */
Data?: LoRaFrequencyEntry;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateLoRaGatewayRequest {
/** LoRa 网关Id */
GatewayId: string;
/** 网关名称 */
Name: string;
/** 详情描述 */
Description: string;
/** 位置坐标 */
Location: LoRaGatewayLocation;
/** 位置信息 */
Position?: string;
/** 位置详情 */
PositionDetails?: string;
/** 是否公开 */
IsPublic?: boolean;
/** 频点ID */
FrequencyId?: string;
}
declare interface CreateLoRaGatewayResponse {
/** LoRa 网关信息 */
Gateway?: LoRaGatewayItem;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreatePositionFenceRequest {
/** 位置空间Id */
SpaceId: string;
/** 围栏名称 */
FenceName: string;
/** 围栏区域信息,采用 GeoJSON 格式 */
FenceArea: string;
/** 围栏描述 */
FenceDesc?: string;
}
declare interface CreatePositionFenceResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreatePositionSpaceRequest {
/** 项目ID */
ProjectId: string;
/** 空间名称 */
SpaceName: string;
/** 授权类型,0:只读 1:读写 */
AuthorizeType: number;
/** 产品列表 */
ProductIdList: string[];
/** 描述 */
Description?: string;
/** 缩略图 */
Icon?: string;
}
declare interface CreatePositionSpaceResponse {
/** 空间Id */
SpaceId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateProjectRequest {
/** 项目名称 */
ProjectName: string;
/** 项目描述 */
ProjectDesc: string;
/** 实例ID,不带实例ID,默认为公共实例 */
InstanceId?: string;
}
declare interface CreateProjectResponse {
/** 返回信息 */
Project: ProjectEntry;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateStudioProductRequest {
/** 产品名称,名称不能和已经存在的产品名称重复。命名规则:[a-zA-Z0-9:_-]{1,32} */
ProductName: string;
/** 产品分组模板ID , ( 自定义模板填写1 , 控制台调用会使用预置的其他ID) */
CategoryId: number;
/** 产品类型 填写 ( 0 普通产品 , 5 网关产品) */
ProductType: number;
/** 加密类型 ,1表示证书认证,2表示密钥认证,21表示TID认证-SE方式,22表示TID认证-软加固方式 */
EncryptionType: string;
/** 连接类型 可以填写 wifi、wifi-ble、cellular、5g、lorawan、ble、ethernet、wifi-ethernet、else、sub_zigbee、sub_ble、sub_433mhz、sub_else、sub_blemesh */
NetType: string;
/** 数据协议 (1 使用物模型 2 为自定义) */
DataProtocol: number;
/** 产品描述 */
ProductDesc: string;
/** 产品的项目ID */
ProjectId: string;
/** 平均传输速率 */
Rate?: string;
/** 期限 */
Period?: string;
}
declare interface CreateStudioProductResponse {
/** 产品描述 */
Product?: ProductEntry;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateTRTCSignaturesWithRoomIdRequest {
/** TRTC进房间的用户名称数组,数组元素不可重复,最长不超过 10 个。 */
TRTCUserIds: string[];
/** 房间id */
RoomId: string;
}
declare interface CreateTRTCSignaturesWithRoomIdResponse {
/** 返回参数数组 */
TRTCParamList?: TRTCParams[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateTWeSeeRecognitionTaskRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 输入视频 / 图片的 URL */
InputURL: string;
/** 自定义事件 ID */
CustomId?: string;
/** 是否保存该事件使其可被搜索 */
EnableSearch?: boolean;
/** 事件起始时间事件起始时间(毫秒级 UNIX 时间戳,若不传则默认为接口调用时间) */
StartTimeMs?: number;
/** 事件结束时间事件起始时间(毫秒级 UNIX 时间戳,若不传则默认为接口调用时间) */
EndTimeMs?: number;
/** 算法配置 */
Config?: string;
/** 是否自定义设备,为 true 时不检查设备存在性,默认为 false */
IsCustomDevice?: boolean;
/** 输入类型。可选值:- `video`:视频(默认值)- `image`:图片 */
InputType?: string;
/** 摘要服务质量。可选值:- `minutely`:分钟级(默认值)- `immediate`:立即 */
SummaryQOS?: string;
}
declare interface CreateTWeSeeRecognitionTaskResponse {
/** 任务 ID */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateTopicPolicyRequest {
/** 产品ID */
ProductId: string;
/** Topic名称 */
TopicName: string;
/** Topic权限,1发布,2订阅,3订阅和发布 */
Privilege: number;
}
declare interface CreateTopicPolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateTopicRuleRequest {
/** 规则名称 */
RuleName: string;
/** 规则内容 */
TopicRulePayload: TopicRulePayload;
}
declare interface CreateTopicRuleResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteCloudStorageEventRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 事件id */
EventId: string;
/** 开始时间,unix时间 */
StartTime: number;
/** 结束时间,unix时间 */
EndTime: number;
/** 用户ID */
UserId?: string;
/** 通道ID */
ChannelId?: number;
}
declare interface DeleteCloudStorageEventResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteDeviceRequest {
/** 产品ID。 */
ProductId: string;
/** 设备名称。 */
DeviceName: string;
/** 是否删除绑定设备 */
ForceDelete?: boolean;
}
declare interface DeleteDeviceResponse {
/** 删除的结果代码 */
ResultCode?: string;
/** 删除的结果信息 */
ResultMessage?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteDevicesRequest {
/** 多个设备标识 */
DevicesItems: DevicesItem[];
}
declare interface DeleteDevicesResponse {
/** 删除的结果代码 */
ResultCode?: string;
/** 删除的结果信息 */
ResultMessage?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteFenceBindRequest {
/** 围栏Id */
FenceId: number;
/** 围栏绑定的产品信息 */
Items: FenceBindProductItem[];
}
declare interface DeleteFenceBindResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteLoRaFrequencyRequest {
/** 频点唯一ID */
FreqId?: string;
}
declare interface DeleteLoRaFrequencyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteLoRaGatewayRequest {
/** LoRa 网关 Id */
GatewayId: string;
}
declare interface DeleteLoRaGatewayResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeletePositionFenceRequest {
/** 位置空间Id */
SpaceId: string;
/** 围栏Id */
FenceId: number;
}
declare interface DeletePositionFenceResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeletePositionSpaceRequest {
/** 位置空间Id */
SpaceId: string;
}
declare interface DeletePositionSpaceResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteProjectRequest {
/** 项目ID */
ProjectId: string;
}
declare interface DeleteProjectResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteStudioProductRequest {
/** 产品ID */
ProductId: string;
}
declare interface DeleteStudioProductResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteTopicPolicyRequest {
/** 产品ID */
ProductId: string;
/** Topic名称 */
TopicName: string;
}
declare interface DeleteTopicPolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteTopicRuleRequest {
/** 规则名 */
RuleName: string;
}
declare interface DeleteTopicRuleResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAISearchTaskAsyncRequest {
/** 任务ID */
TaskId: string;
}
declare interface DescribeAISearchTaskAsyncResponse {
/** 状态。0-初始状态;1-正在处理;2-处理失败;3-成功 */
Status?: number;
/** 任务处理结果数据 */
Data?: AISearchInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeActivateDeviceRequest {
/** 实例ID */
InstanceId: string;
}
declare interface DescribeActivateDeviceResponse {
/** 设备激活详情信息 */
Data?: ActivateDeviceInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeActivateLicenseServiceRequest {
/** 实例ID */
InstanceId: string;
/** 激活码类型 */
LicenseType?: string;
}
declare interface DescribeActivateLicenseServiceResponse {
/** 增值服务激活码信息 */
Data?: LicenseServiceNumInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBatchProductionRequest {
/** 产品ID */
ProductId: string;
/** 量产ID */
BatchProductionId: string;
}
declare interface DescribeBatchProductionResponse {
/** 量产数量。 */
BatchCnt?: number;
/** 烧录方式。 */
BurnMethod?: number;
/** 创建时间。 */
CreateTime?: number;
/** 下载URL。 */
DownloadUrl?: string;
/** 生成方式。 */
GenerationMethod?: number;
/** 上传URL。 */
UploadUrl?: string;
/** 成功数 */
SuccessCount?: number;
/** 量产最后失败原因 */
LastFailedReason?: string;
/** 量产状态 0:任务创建,未量产;1:处理中;2:量产结束上传结果中;3:任务完成 */
Status?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBindedProductsRequest {
/** 网关产品ID */
GatewayProductId: string;
/** 分页偏移量 */
Offset: number;
/** 分页大小 */
Limit: number;
/** 是否跨账号绑定产品 */
ProductSource?: number;
}
declare interface DescribeBindedProductsResponse {
/** 当前分页的子产品数组 */
Products?: BindProductInfo[];
/** 绑定的子产品总数量 */
Total?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageAIServiceCallbackRequest {
/** 产品 ID */
ProductId: string;
}
declare interface DescribeCloudStorageAIServiceCallbackResponse {
/** 推送类型。http:HTTP 回调 */
Type?: string;
/** HTTP 回调 URL */
CallbackUrl?: string;
/** HTTP 回调鉴权 Token */
CallbackToken?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageAIServiceRequest {
/** 产品 ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 云存 AI 服务类型。可选值:- `RealtimeObjectDetect`:目标检测- `Highlight`:视频浓缩 */
ServiceType: string;
}
declare interface DescribeCloudStorageAIServiceResponse {
/** 云存 AI 套餐类型。可能取值:- `1`:全时套餐- `2`:事件套餐- `3`:低功耗套餐 */
Type?: number;
/** 云存 AI 套餐生效状态。可能取值:- `0`:未开通或已过期- `1`:生效中 */
Status?: number;
/** 云存 AI 套餐过期时间 UNIX 时间戳 */
ExpireTime?: number;
/** 用户 ID */
UserId?: string;
/** 视频分析启用状态 */
Enabled?: boolean;
/** 视频分析配置参数 */
Config?: string;
/** 视频分析识别区域 */
ROI?: string;
/** 云存 AI 套餐 ID */
PackageId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageAIServiceTaskRequest {
/** 任务 ID */
TaskId: string;
/** 下载 URL 的过期时间。若传入该参数,则响应中将包含所有文件的下载 URL */
FileURLExpireTime?: number;
}
declare interface DescribeCloudStorageAIServiceTaskResponse {
/** 任务信息 */
TaskInfo?: CloudStorageAIServiceTask;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageAIServiceTasksRequest {
/** 产品 ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 云存 AI 服务类型。可选值:- `RealtimeObjectDetect`:目标检测- `Highlight`:视频浓缩- `VideoToText`:视频语义理解 */
ServiceType: string;
/** 分页拉取数量 */
Limit: number;
/** 分页拉取偏移 */
Offset?: number;
/** 任务状态。可选值:- (不传):查询全部状态的任务- `1`:失败- `2`:成功但结果为空- `3`:成功且结果非空- `4`:执行中 */
Status?: number;
/** 用户 ID */
UserId?: string;
/** 通道 ID */
ChannelId?: number;
/** 设备名称列表。当需要同时查询多台设备的任务列表时传入,优先级高于参数 `DeviceName` */
DeviceNames?: string[];
/** 查询任务时间范围的起始时间(秒级 UNIX 时间戳) */
StartTime?: number;
/** 查询任务时间范围的结束时间(秒级 UNIX 时间戳) */
EndTime?: number;
/** 下载 URL 的过期时间。若传入该参数,则响应中将包含所有文件的下载 URL */
FileURLExpireTime?: number;
}
declare interface DescribeCloudStorageAIServiceTasksResponse {
/** 任务列表 */
Tasks?: CloudStorageAIServiceTask[];
/** 任务数量 */
Total?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageDateRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 用户ID */
UserId?: string;
/** 通道ID */
ChannelId?: number;
}
declare interface DescribeCloudStorageDateResponse {
/** 云存日期数组,["2021-01-05","2021-01-06"] */
Data?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageEventsRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 起始时间(Unix 时间戳,秒级), 为0 表示 当前时间 - 24h */
StartTime?: number;
/** 结束时间(Unix 时间戳,秒级), 为0 表示当前时间 */
EndTime?: number;
/** 请求上下文, 用作查询游标 */
Context?: string;
/** 查询数据项目的最大数量, 默认为10。假设传Size=10,返回的实际事件数量为N,则 5 <= N <= 10。 */
Size?: number;
/** 事件标识符,可以用来指定查询特定的事件,如果不指定,则查询所有事件。 */
EventId?: string;
/** 用户ID */
UserId?: string;
/** 通道ID 非NVR设备则不填 NVR设备则必填 默认为无 */
ChannelId?: number;
}
declare interface DescribeCloudStorageEventsResponse {
/** 云存事件列表 */
Events?: CloudStorageEvent[];
/** 请求上下文, 用作查询游标 */
Context?: string;
/** 拉取结果是否已经结束 */
Listover?: boolean;
/** 内部结果数量,并不等同于事件总数。 */
Total?: number;
/** 视频播放URL */
VideoURL?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageEventsWithAITasksRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 事件关联的视频 AI 分析服务类型(支持多选)。可选值:- `RealtimeObjectDetect`:目标检测- `Highlight`:视频浓缩- `VideoToText`:视频语义理解 */
ServiceTypes: string[];
/** 起始时间(Unix 时间戳,秒级), 为0 表示 当前时间 - 24h */
StartTime?: number;
/** 结束时间(Unix 时间戳,秒级), 为0 表示当前时间 */
EndTime?: number;
/** 请求上下文, 用作查询游标 */
Context?: string;
/** 查询数据项目的最大数量, 默认为10。假设传Size=10,返回的实际事件数量为N,则 5 <= N <= 10。 */
Size?: number;
/** 事件标识符,可以用来指定查询特定的事件,如果不指定,则查询所有事件。 */
EventId?: string;
/** 用户ID */
UserId?: string;
/** 通道ID 非NVR设备则不填 NVR设备则必填 默认为无 */
ChannelId?: number;
}
declare interface DescribeCloudStorageEventsWithAITasksResponse {
/** 云存事件列表 */
Events?: CloudStorageEventWithAITasks[];
/** 请求上下文, 用作查询游标 */
Context?: string;
/** 拉取结果是否已经结束 */
Listover?: boolean;
/** 内部结果数量,并不等同于事件总数。 */
Total?: number;
/** 视频播放URL */
VideoURL?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageMultiThumbnailRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 多个缩略图文件名根据 | 分割 */
MultiThumbnail: string;
}
declare interface DescribeCloudStorageMultiThumbnailResponse {
/** 缩略图访问地址 */
ThumbnailURLInfoList?: ThumbnailURLInfoList[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageOrderRequest {
/** 订单id */
OrderId: string;
}
declare interface DescribeCloudStorageOrderResponse {
/** 云存套餐开始时间 */
StartTime?: number;
/** 云存套餐过期时间 */
ExpireTime?: number;
/** 套餐id */
PackageId?: string;
/** 套餐状态0:等待生效1: 已过期2:生效 */
Status?: number;
/** 通道id */
ChannelId?: number;
/** 订单金额,单位为分 */
Price?: number;
/** 支付金额,单位为分 */
Amount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStoragePackageConsumeDetailsRequest {
/** 开始日期 */
StartDate: string;
/** 结束日期 */
EndDate: string;
}
declare interface DescribeCloudStoragePackageConsumeDetailsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStoragePackageConsumeStatsRequest {
/** 开始日期 */
StartDate: string;
/** 结束日期,开始与结束日期间隔不可超过一年 */
EndDate: string;
}
declare interface DescribeCloudStoragePackageConsumeStatsResponse {
/** 统计列表详情 */
Stats?: PackageConsumeStat[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 云存用户ID */
UserId?: string;
/** 通道ID 非NVR设备不填 NVR设备必填 默认为无 */
ChannelId?: number;
}
declare interface DescribeCloudStorageResponse {
/** 云存开启状态,1为开启,0为未开启或已过期 */
Status?: number;
/** 云存类型,1为全时云存,2为事件云存 */
Type?: number;
/** 云存套餐过期时间 */
ExpireTime?: number;
/** 云存回看时长 */
ShiftDuration?: number;
/** 云存用户ID */
UserId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageStreamDataRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 图片流事件开始时间 */
StartTime: number;
}
declare interface DescribeCloudStorageStreamDataResponse {
/** 图片流视频地址 */
VideoStream?: string;
/** 图片流音频