tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,399 lines (2,167 loc) • 237 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** AI模型申请信息 */
declare interface AIModelApplication {
/** 产品ID */
ProductId: string;
/** 产品名称 */
ProductName: string;
/** 申请状态:1-已申请;2-已取消;3-已拒绝;4-已通过 */
Status: number;
}
/** AI模型信息 */
declare interface AIModelInfo {
/** 产品ID */
ProductId: string;
/** 产品名称 */
ProductName: string;
/** 申请状态:1-已申请;2-已取消;3-已拒绝;4-已通过 */
Status: number;
/** 可调用数量 */
Total: number;
/** 已调用数量 */
Used: number;
/** 申请时间 */
ApplyTime: number;
/** 审批通过时间 */
ApprovalTime: number;
}
/** AI模型资源使用信息 */
declare interface AIModelUsageInfo {
/** 开通时间 */
CreateTime: number;
/** 资源总量 */
Total: number;
/** 已使用资源数量 */
Used: number;
}
/** 查询设备历史 */
declare interface ActionHistory {
/** 设备名称 */
DeviceName?: string;
/** 动作Id */
ActionId?: string;
/** 动作名称 */
ActionName?: string;
/** 请求时间 */
ReqTime?: number;
/** 响应时间 */
RspTime?: number;
/** 输入参数 */
InputParams?: string | null;
/** 输出参数 */
OutputParams?: string | null;
/** 调用方式 */
Calling?: string;
/** 调用Id */
ClientToken?: string;
/** 调用状态 */
Status?: string;
}
/** 账户流水 */
declare interface BalanceTransaction {
/** 账户类型:1-设备接入 2-云存。 */
AccountType: number;
/** 账户变更类型:Rechareg-充值;CreateOrder-新购。 */
Operation: string;
/** 流水ID。 */
DealId: string;
/** 变更金额,单位:分(人民币)。 */
Amount: number;
/** 变更后账户余额,单位:分(人民币)。 */
Balance: number;
/** 变更时间。 */
OperationTime: number;
}
/** 运营活动资源包信息 */
declare interface BonusInfo {
/** 资源包ID */
BonusId: number;
/** 用户ID */
UserId: string;
/** 资源包配置ID */
PackageId: string;
/** 资源总数 */
Total: number;
/** 资源消耗总数 */
Used: number;
/** 资源包过期时间 */
ExpireTime: number;
/** 资源包创建时间 */
CreateTime: number;
/** 资源包状态 0.未使用 1.使用中 2.已退款 3.已过期 */
Status?: number | null;
}
/** 云存事件 */
declare interface CloudStorageEvent {
/** 事件起始时间(Unix 时间戳,秒级 */
StartTime: number;
/** 事件结束时间(Unix 时间戳,秒级 */
EndTime: number;
/** 事件缩略图 */
Thumbnail: string;
/** 事件ID */
EventId: string;
/** 事件录像上传状态,Finished: 全部上传成功 Partial: 部分上传成功 Failed: 上传失败 */
UploadStatus?: string | null;
/** 事件自定义数据 */
Data?: string | null;
}
/** 云存套餐包信息 */
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 DataForward {
/** 产品ID。 */
ProductId: string;
/** 转发地址。 */
ForwardAddr: string;
/** 转发状态。 */
Status: number;
/** 创建时间。 */
CreateTime: number;
/** 更新时间。 */
UpdateTime: number;
/** 1-数据信息转发 2-设备上下线状态转发 3-数据信息转发&设备上下线状态转发 */
DataChose: number | null;
}
/** 设备数量统计 */
declare interface DeviceCntStats {
/** 统计日期 */
Date: string;
/** 新增注册设备数 */
NewRegisterCnt: number | null;
/** 新增激活设备数 */
NewActivateCnt: number | null;
/** 活跃设备数 */
ActiveCnt: number | null;
}
/** 设备通讯日志查询返回条目 */
declare interface DeviceCommLogItem {
/** 时间 */
Time?: string;
/** 日志类型,device 设备上行,shadow 服务端下行。 */
Type?: string;
/** 通讯数据。 */
Data?: string;
}
/** 设备历史数据结构 */
declare interface DeviceDataHistoryItem {
/** 时间点,毫秒时间戳 */
Time?: string;
/** 字段取值 */
Value?: string;
}
/** 设备详细信息 */
declare interface DeviceInfo {
/** 设备名 */
DeviceName: string;
/** 设备是否在线,0不在线,1在线,2获取失败,3未激活 */
Online: number;
/** 设备最后上线时间 */
LoginTime: number;
/** 设备密钥 */
DevicePsk: string;
/** 设备启用状态 0为停用 1为可用 */
EnableState: number;
/** 设备过期时间 */
ExpireTime: number;
/** 设备的sdk日志等级,0:关闭,1:错误,2:告警,3:信息,4:调试 */
LogLevel?: number | null;
}
/** 设备签名信息 */
declare interface DeviceSignatureInfo {
/** 设备名称 */
DeviceName: string;
/** 设备签名 */
DeviceSignature: string;
}
/** 设备上下线日志记录 */
declare interface DeviceStatusLogItem {
/** 时间 */
Time?: string;
/** 状态类型: Online 上线,Offline 下线 */
Type?: string;
/** 日志信息 */
Data?: string;
}
/** 设备固件更新状态 */
declare interface DeviceUpdateStatus {
/** 设备名 */
DeviceName?: string;
/** 最后处理时间 */
LastProcessTime?: number;
/** 状态 */
Status?: number;
/** 错误消息 */
ErrMsg?: string;
/** 返回码 */
Retcode?: number;
/** 目标更新版本 */
DstVersion?: string;
/** 下载中状态时的下载进度 */
Percent?: number | null;
/** 原版本号 */
OriVersion?: string | null;
/** 任务ID */
TaskId?: number | null;
}
/** 设备事件的搜索结果项 */
declare interface EventHistoryItem {
/** 事件的时间戳 */
TimeStamp?: number | null;
/** 事件的产品ID */
ProductId?: string | null;
/** 事件的设备名称 */
DeviceName?: string | null;
/** 事件的标识符ID */
EventId?: string | null;
/** 事件的类型 */
Type?: string | null;
/** 事件的数据 */
Data?: string | null;
}
/** 设备固件详细信息 */
declare interface FirmwareInfo {
/** 固件版本 */
Version?: string;
/** 固件MD5值 */
Md5sum?: string;
/** 固件创建时间 */
CreateTime?: number;
/** 产品名称 */
ProductName?: string;
/** 固件名称 */
Name?: string;
/** 固件描述 */
Description?: string;
/** 产品ID */
ProductId?: string;
/** 固件升级模块 */
FwType?: string | null;
}
/** 固件升级任务信息 */
declare interface FirmwareTaskInfo {
/** 任务ID */
TaskId?: number | null;
/** 任务状态 */
Status?: number | null;
/** 任务类型 */
Type?: number | null;
/** 任务创建时间 */
CreateTime?: number | null;
}
/** 消息数量统计 */
declare interface MessageCntStats {
/** 统计日期 */
Date?: string;
/** 物模型上行消息数 */
UpMsgCnt?: number | null;
/** 物模型下行消息数 */
DownMsgCnt?: number | null;
/** ntp消息数 */
NtpMsgCnt?: number | null;
}
/** 云存套餐包消耗统计 */
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 | null;
/** 云存套餐更新时间 */
UpdatedAt?: number | null;
/** 套餐id */
PackageId?: string | null;
/** 订单id */
OrderId?: string | null;
/** 通道id */
ChannelId?: number;
/** 用户id */
CSUserId?: string | null;
}
/** 产品模型定义 */
declare interface ProductModelDefinition {
/** 产品ID */
ProductId?: string;
/** 模型定义 */
ModelDefine?: string;
/** 更新时间,秒级时间戳 */
UpdateTime?: number;
/** 创建时间,秒级时间戳 */
CreateTime?: number;
/** 产品所属分类的模型快照(产品创建时刻的) */
CategoryModel?: string | null;
/** 产品的连接类型的模型 */
NetTypeModel?: string | null;
}
/** 产品分类实体 */
declare interface ProductTemplate {
/** 实体ID */
Id?: number;
/** 分类字段 */
CategoryKey?: string;
/** 分类名称 */
CategoryName?: string;
/** 上层实体ID */
ParentId?: number;
/** 物模型 */
ModelTemplate?: string;
/** 排列顺序 */
ListOrder?: number | null;
/** 分类图标地址 */
IconUrl?: string | null;
/** 九宫格图片地址 */
IconUrlGrid?: string | null;
}
/** SDK日志项 */
declare interface SDKLogItem {
/** 产品ID */
ProductID?: string;
/** 设备名称 */
DeviceName?: string;
/** 日志等级 */
Level?: string;
/** 日志时间 */
DateTime?: string;
/** 日志内容 */
Content?: string;
}
/** 搜索关键词 */
declare interface SearchKeyword {
/** 搜索条件的Key */
Key: string;
/** 搜索条件的值 */
Value?: string;
}
/** 状态统计信息 */
declare interface StatusStatistic {
/** 任务状态 */
Status?: number | null;
/** 统计总数 */
Total?: number | null;
}
/** TRTC调用参数 */
declare interface TRTCParams {
/** 应用id,供TRTC SDK使用 */
SDKAppId?: number | null;
/** 用户id,供TRTC SDK使用 */
UserId?: string | null;
/** 用户id签名,供TRTC SDK使用 */
UserSig?: string | null;
/** 房间id,供TRTC SDK使用 */
StrRoomId?: string | null;
/** 权限票据,供TRTC SDK使用 */
PrivateMapKey?: string | null;
}
/** 缩略图信息 */
declare interface ThumbnailURLInfoList {
/** 缩略图访问地址 */
ThumbnailURL?: string | null;
/** 缩略图访问地址的过期时间 */
ExpireTime?: number | null;
}
/** 批次元数据 */
declare interface VideoBatch {
/** 批次ID */
Id?: number;
/** 用户ID */
UserId?: string;
/** 产品ID */
ProductId?: string;
/** 状态:1:待创建设备 2:创建中 3:已完成 */
Status?: number;
/** 设备前缀 */
DevPre?: string;
/** 设备数量 */
DevNum?: number;
/** 已创建设备数量 */
DevNumCreated?: number;
/** 批次下载地址 */
BatchURL?: string;
/** 创建时间。unix时间戳 */
CreateTime?: number;
/** 修改时间。unix时间戳 */
UpdateTime?: number;
}
/** video产品元数据 */
declare interface VideoProduct {
/** 产品ID */
ProductId?: string;
/** 产品名称 */
ProductName?: string;
/** 产品设备类型(普通设备) 1.普通设备 */
DeviceType?: number;
/** 认证方式:2:PSK */
EncryptionType?: number;
/** 设备功能码 */
Features?: string[];
/** 操作系统 */
ChipOs?: string;
/** 芯片厂商id */
ChipManufactureId?: string;
/** 芯片id */
ChipId?: string;
/** 产品描述信息 */
ProductDescription?: string;
/** 创建时间unix时间戳 */
CreateTime?: number;
/** 修改时间unix时间戳 */
UpdateTime?: number;
/** 连接类型,wifi表示WIFI连接,cellular表示4G连接 */
NetType?: string | null;
/** 产品品类,113:摄像头,567:儿童手表,595:可视对讲门锁 */
CategoryId?: number | null;
/** 产品有效年限 */
ProductVaildYears?: number | null;
}
declare interface ApplyAIModelRequest {
/** AI模型ID */
ModelId: string;
/** 产品ID */
ProductId: string;
}
declare interface ApplyAIModelResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BatchUpdateFirmwareRequest {
/** 产品ID */
ProductID: string;
/** 固件新版本号 */
FirmwareVersion: string;
/** 固件原版本号,根据文件列表升级固件不需要填写此参数 */
FirmwareOriVersion?: string;
/** 升级方式,0 静默升级 1 用户确认升级。 不填默认为静默升级方式 */
UpgradeMethod?: number;
/** 设备列表文件名称,根据文件列表升级固件需要填写此参数 */
FileName?: string;
/** 设备列表的文件md5值 */
FileMd5?: string;
/** 设备列表的文件大小值 */
FileSize?: number;
/** 需要升级的设备名称列表 */
DeviceNames?: string[];
/** 固件升级任务默认超时时间。 最小取值60秒,最大为3600秒 */
TimeoutInterval?: number;
}
declare interface BatchUpdateFirmwareResponse {
/** 任务ID */
TaskId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BindCloudStorageUserRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 用户ID */
UserId: string;
}
declare interface BindCloudStorageUserResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CallDeviceActionAsyncRequest {
/** 产品Id */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 产品数据模板中行为功能的标识符,由开发者自行根据设备的应用场景定义 */
ActionId: string;
/** 输入参数 */
InputParams?: string;
}
declare interface CallDeviceActionAsyncResponse {
/** 调用Id */
ClientToken?: string | null;
/** 异步调用状态 */
Status?: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CallDeviceActionSyncRequest {
/** 产品Id */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 产品数据模板中行为功能的标识符,由开发者自行根据设备的应用场景定义 */
ActionId: string;
/** 输入参数 */
InputParams?: string;
}
declare interface CallDeviceActionSyncResponse {
/** 调用Id */
ClientToken: string | null;
/** 输出参数 */
OutputParams: string | null;
/** 返回状态,当设备不在线等部分情况,会通过该 Status 返回。 */
Status: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CallTRTCDeviceRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
}
declare interface CallTRTCDeviceResponse {
/** TRTC SDK房间参数 */
TRTCParams?: TRTCParams;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CancelAIModelApplicationRequest {
/** AI模型ID */
ModelId: string;
/** 产品ID */
ProductId: string;
}
declare interface CancelAIModelApplicationResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CancelDeviceFirmwareTaskRequest {
/** 产品ID */
ProductID: string;
/** 设备名称 */
DeviceName: string;
/** 固件版本号 */
FirmwareVersion: string;
/** 固件升级任务ID */
TaskId: number;
}
declare interface CancelDeviceFirmwareTaskResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ChangeP2PRouteRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** P2P线路 */
RouteId: number;
}
declare interface ChangeP2PRouteResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CheckForwardAuthRequest {
/** 控制台Skey */
Skey: string;
/** 队列类型 0.CMQ 1.Ckafka */
QueueType: number;
}
declare interface CheckForwardAuthResponse {
/** 腾讯云账号 */
Endpoint?: string;
/** 结果 */
Result?: number;
/** 产品ID */
Productid?: string;
/** 错误消息 */
ErrMsg?: string;
/** 队列类型 0.CMQ 1.Ckafka */
QueueType?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ControlDeviceDataRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义 */
Data: string;
/** 请求类型 , 不填该参数或者 desired 表示下发属性给设备, reported 表示模拟设备上报属性 */
Method?: string;
/** 上报数据UNIX时间戳(毫秒), 仅对Method:reported有效 */
DataTimestamp?: number;
}
declare interface ControlDeviceDataResponse {
/** 返回信息 */
Data: string;
/** JSON字符串, 返回下发控制的结果信息, Sent = 1 表示设备已经在线并且订阅了控制下发的mqtt topic */
Result: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAIDetectionRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** AI模型ID */
ModelId: string;
/** 图片上传的开始时间 */
StartTime: number;
/** 图片上传的结束时间 */
EndTime: number;
}
declare interface CreateAIDetectionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateBatchRequest {
/** 产品ID */
ProductId: string;
/** 批次创建的设备数量 */
DevNum: number;
/** 批次创建的设备前缀。不超过24个字符 */
DevPre: string;
}
declare interface CreateBatchResponse {
/** 批次ID */
BatchId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCOSCredentialsRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
}
declare interface CreateCOSCredentialsResponse {
/** COS存储桶名称 */
StorageBucket?: string;
/** COS存储桶区域 */
StorageRegion?: string;
/** COS存储桶路径 */
StoragePath?: string;
/** COS上传用的SecretID */
SecretID?: string;
/** COS上传用的SecretKey */
SecretKey?: string;
/** COS上传用的Token */
Token?: string;
/** 密钥信息过期时间 */
ExpiredTime?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudStorageRequest {
/** 产品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 CreateCloudStorageResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDataForwardRequest {
/** 产品ID。 */
ProductId: string;
/** 转发地址。如果有鉴权Token,则需要自行传入,例如 [{\"forward\":{\"api\":\"http://123.207.117.108:1080/sub.php\",\"token\":\"testtoken\"}}] */
ForwardAddr: string;
/** 1-数据信息转发 2-设备上下线状态转发 3-数据信息转发&设备上下线状态转发 */
DataChose?: number;
}
declare interface CreateDataForwardResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDeviceChannelRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 通道ID */
ChannelId: number;
}
declare interface CreateDeviceChannelResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateForwardRuleRequest {
/** 产品ID */
ProductID: string;
/** 消息类型 */
MsgType: number;
/** 控制台Skey */
Skey: string;
/** 队列区域 */
QueueRegion: string;
/** 队列类型 0.CMQ 1.Ckafka */
QueueType: number;
/** 临时密钥 */
Consecretid?: string;
/** 实例ID */
InstanceId?: string;
/** 实例名称 */
InstanceName?: string;
/** 队列或主题ID */
QueueID?: string;
/** 队列或主题名称 */
QueueName?: string;
}
declare interface CreateForwardRuleResponse {
/** 腾讯云账号 */
Endpoint?: string;
/** 队列名 */
QueueName?: string;
/** 产品ID */
ProductID?: string;
/** 消息类型 */
MsgType?: number;
/** 结果 */
Result?: number;
/** 角色名称 */
RoleName?: string;
/** 角色ID */
RoleID?: number;
/** 队列区 */
QueueRegion?: string;
/** 消息队列的类型。 0:CMQ,1:Ckafka */
QueueType?: number;
/** 实例id, 目前只有Ckafka会用到 */
InstanceId?: string;
/** 实例名称,目前只有Ckafka会用到 */
InstanceName?: string;
/** 错误消息 */
ErrMsg?: string;
/** 唯一请求 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 | null;
/** 支付金额,单位为分 */
Amount?: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateProductRequest {
/** 产品名称 */
ProductName: string;
/** 产品设备类型 1.普通设备 2.NVR设备 */
DeviceType: number;
/** 产品有效期 */
ProductVaildYears: number;
/** 设备功能码 ypsxth音频双向通话 spdxth视频单向通话 sxysp双向音视频注意:此字段只支持创建'摄像头'和'儿童手表',摄像头传["ypsxth","spdxth"],儿童手表传["ypsxth","spdxth","sxysp"],创建其它品类的产品需要传递CategoryId字段,通过云api调用此接口时,如果传了CategoryId字段,将忽略Features字段,但Features仍需传值(可传任意字符串数组) */
Features: string[];
/** 芯片厂商id,通用设备填default */
ChipManufactureId: string;
/** 芯片id,通用设备填default */
ChipId: string;
/** 产品描述信息 */
ProductDescription: string;
/** 设备操作系统,通用设备填default */
ChipOs: string;
/** 认证方式 只支持取值为2 psk认证 */
EncryptionType?: number;
/** 产品品类id,113:摄像头,567:儿童手表,595:可视对讲门锁注意:通过云api调用此接口时,如果传了CategoryId字段,将忽略Features字段,但Features仍需传值(可传任意字符串数组) */
CategoryId?: number;
/** 连接类型,wifi表示WIFI连接,cellular表示4G连接 */
NetType?: string;
}
declare interface CreateProductResponse {
/** 产品详情 */
Data?: VideoProduct;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateTaskFileUrlRequest {
/** 产品ID */
ProductId: string;
}
declare interface CreateTaskFileUrlResponse {
/** 任务文件上传链接 */
Url?: string;
/** 任务文件名 */
FileName?: string;
/** 唯一请求 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;
}
declare interface DeleteDeviceResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteFirmwareRequest {
/** 产品ID */
ProductID: string;
/** 固件版本 */
FirmwareVersion: string;
}
declare interface DeleteFirmwareResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteForwardRuleRequest {
/** 产品ID */
ProductID: string;
/** 控制台Skey */
Skey: string;
/** 队列类型 */
QueueType: number;
/** 队列名称 */
QueueName: string;
}
declare interface DeleteForwardRuleResponse {
/** 腾讯云账号 */
Endpoint: string;
/** 队列名称 */
QueueName: string;
/** 产品ID */
ProductID: string;
/** 删除结果 0成功 其他不成功 */
Result: number;
/** 错误消息 */
ErrMsg: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteProductRequest {
/** 产品ID */
ProductId: string;
}
declare interface DeleteProductResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAIModelApplicationsRequest {
/** 模型ID */
ModelId: string;
/** 分页的大小,最大100 */
Limit: number;
/** 偏移量,Offset从0开始 */
Offset: number;
/** 产品ID */
ProductId?: string;
}
declare interface DescribeAIModelApplicationsResponse {
/** 申请记录数量 */
TotalCount?: number;
/** 申请记录数组 */
Applications?: AIModelApplication[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAIModelChannelRequest {
/** 模型ID */
ModelId: string;
/** 产品ID */
ProductId: string;
}
declare interface DescribeAIModelChannelResponse {
/** 推送类型。ckafka:消息队列;forward:http/https推送 */
Type?: string;
/** 第三方推送地址 */
ForwardAddress?: string | null;
/** 第三方推送密钥 */
ForwardKey?: string | null;
/** ckafka地域 */
CKafkaRegion?: string | null;
/** ckafka实例 */
CKafkaInstance?: string | null;
/** ckafka订阅主题 */
CKafkaTopic?: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAIModelUsageRequest {
/** 模型ID */
ModelId: string;
/** 产品ID */
ProductId: string;
/** 偏移量,从0开始 */
Offset: number;
/** 分页的大小,最大100 */
Limit: number;
}
declare interface DescribeAIModelUsageResponse {
/** AI模型资源包总量 */
TotalCount?: number;
/** AI模型资源包信息数组 */
UsageInfo?: AIModelUsageInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAIModelsRequest {
/** 模型ID */
ModelId: string;
/** 申请状态:1-已申请;2-已取消;3-已拒绝;4-已通过 */
Status: number;
/** 偏移量,Offset从0开始 */
Offset: number;
/** 分页的大小,最大100 */
Limit: number;
}
declare interface DescribeAIModelsResponse {
/** AI模型数量 */
TotalCount?: number;
/** AI模型信息数组 */
Models?: AIModelInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAccountRequest {
/** 1设备,2云存,3ai */
AccountType: number;
}
declare interface DescribeAccountResponse {
/** 查询的账号id */
Uin: string;
/** 1线上计费,2线下计费 */
BillType: number;
/** 0未定义,1按套餐预付费,2按量后付费 */
BillMode: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBalanceRequest {
/** 账户类型:1-设备接入;2-云存。 */
AccountType: number;
}
declare interface DescribeBalanceResponse {
/** 账户余额,单位:分(人民币)。 */
Balance: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBalanceTransactionsRequest {
/** 账户类型:1-设备接入;2-云存。 */
AccountType: number;
/** 分页游标开始,默认为0开始拉取第一条。 */
Offset: number;
/** 分页每页数量。 */
Limit: number;
/** 流水类型:All-全部类型;Recharge-充值;CreateOrder-新购。默认为All */
Operation?: string;
}
declare interface DescribeBalanceTransactionsResponse {
/** 账户流水总数。 */
TotalCount: number;
/** 账户流水详情数组。 */
Transactions: BalanceTransaction[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBatchRequest {
/** 批次ID */
BatchId: number;
}
declare interface DescribeBatchResponse {
/** 批次详情 */
Data?: VideoBatch;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBatchsRequest {
/** 产品ID */
ProductId: string;
/** 分页的大小,最大100 */
Limit: number;
/** 偏移量,Offset从0开始 */
Offset: number;
}
declare interface DescribeBatchsResponse {
/** 批次数量 */
TotalCount?: number;
/** 批次列表详情 */
Data?: VideoBatch[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBonusesRequest {
/** 分页拉取偏移 */
Offset: number;
/** 分页拉取数量 */
Limit: number;
}
declare interface DescribeBonusesResponse {
/** 资源包总数 */
TotalCount: number;
/** 资源包信息 */
Bonuses: BonusInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCategoryRequest {
/** Category ID。 */
Id: number;
}
declare interface DescribeCategoryResponse {
/** Category详情 */
Data: ProductTemplate;
/** 唯一请求 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 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 | null;
/** 云存套餐过期时间 */
ExpireTime?: number | null;
/** 套餐id */
PackageId?: string | null;
/** 套餐状态0:等待生效1: 已过期2:生效 */
Status?: number;
/** 通道id */
ChannelId?: number;
/** 订单金额,单位为分 */
Price?: number | null;
/** 支付金额,单位为分 */
Amount?: number | null;
/** 唯一请求 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 | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageStreamDataRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 图片流事件开始时间 */
StartTime: number;
}
declare interface DescribeCloudStorageStreamDataResponse {
/** 图片流视频地址 */
VideoStream: string;
/** 图片流音频地址 */
AudioStream: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageThumbnailListRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 缩略图文件名列表 */
ThumbnailList: string[];
}
declare interface DescribeCloudStorageThumbnailListResponse {
/** 缩略图访问地址 */
ThumbnailURLInfoList?: ThumbnailURLInfoList[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageThumbnailRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 缩略图文件名 */
Thumbnail: string;
}
declare interface DescribeCloudStorageThumbnailResponse {
/** 缩略图访问地址 */
ThumbnailURL?: string;
/** 缩略图访问地址的过期时间 */
ExpireTime?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageTimeRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 云存日期,例如"2020-01-05" */
Date: string;
/** 开始时间,unix时间 */
StartTime?: number;
/** 结束时间,unix时间 */
EndTime?: number;
/** 用户ID */
UserId?: string;
/** 通道ID */
ChannelId?: number;
}
declare interface DescribeCloudStorageTimeResponse {
/** 接口返回数据 */
Data?: CloudStorageTimeData;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudStorageUsersRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 分页拉取数量 */
Limit: number;
/** 分页拉取偏移 */
Offset: number;
}
declare interface DescribeCloudStorageUsersResponse {
/** 用户总数 */
TotalCount?: number;
/** 用户信息 */
Users?: CloudStorageUserInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCsReportCountDataInfoRequest {
/** 产品id */
ProductId: string;
/** 设备名 */
DeviceName: string;
/** 统计开始时间戳 */
StartTime: number;
/** 统计结束时间戳 */
EndTime: number;
/** 设备通道 */
ChannelId?: number;
}
declare interface DescribeCsReportCountDataInfoResponse {
/** 云存上报统计信息 */
Data?: CountDataInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDataForwardListRequest {
/** 产品ID列表 */
ProductIds: string;
}
declare interface DescribeDataForwardListResponse {
/** 数据转发列表。 */
DataForwardList: DataForward[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceActionHistoryRequest {
/** 产品Id */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 开始范围的 unix 毫秒时间戳 */
MinTime: number;
/** 结束范围的 unix 毫秒时间戳 */
MaxTime: number;
/** 动作Id */
ActionId?: string;
/** 查询条数 默认为0 最大不超过500 */
Limit?: number;
/** 游标,标识查询位置。 */
Context?: string;
}
declare interface DescribeDeviceActionHistoryResponse {
/** 总条数 */
TotalCounts: number;
/** 动作历史 */
ActionHistories: ActionHistory[] | null;
/** 用于标识查询结果的上下文,翻页用。 */
Context: string | null;
/** 搜索结果是否已经结束。 */
Listover: boolean | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceCommLogRequest {
/** 开始时间 13位时间戳 单位毫秒 */
MinTime: number;
/** 结束时间 13位时间戳 单位毫秒 */
MaxTime: number;
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 返回条数 默认为50 */
Limit?: number;
/** 检索上下文 */
Context?: string;
/** 类型:shadow 下行,device 上行 默认为空则全部查询 */
Type?: string;
}
declare interface DescribeDeviceCommLogResponse {
/** 数据是否已全部返回,true 表示数据全部返回,false 表示还有数据待返回,可将 Context 作为入参,继续查询返回结果。 */
Listover: boolean;
/** 检索上下文,当 ListOver 为false时,可以用此上下文,继续读取后续数据 */
Context: string;
/** 日志数据结果数组,返回对应时间点及取值。 */
Results: DeviceCommLogItem[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceDataHistoryRequest {
/** 区间开始时间(Unix 时间戳,毫秒级) */
MinTime: number;
/** 区间结束时间(Unix 时间戳,毫秒级) */
MaxTime: number;
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 属性字段名称,对应数据模板中功能属性的标识符 */
FieldName: string;
/** 返回条数 */
Limit?: number[];
/** 检索上下文 */
Context?: string;
}
declare interface DescribeDeviceDataHistoryResponse {
/** 属性字段名称,对应数据模板中功能属性的标识符 */
FieldName: string | null;
/** 数据是否已全部返回,true 表示数据全部返回,false 表示还有数据待返回,可将 Context 作为入参,继续查询返回结果。 */
Listover: boolean | null;
/** 检索上下文,当 ListOver 为false时,可以用此上下文,继续读取后续数据 */
Context: string | null;
/** 历史数据结果数组,返回对应时间点及取值。 */
Results: DeviceDataHistoryItem[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceDataRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
}
declare interface DescribeDeviceDataResponse {
/** 设备数据 */
Data?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceDataStatsRequest {
/** 开始日期 */
StartDate: string;
/** 结束日期 */
EndDate: string;
/** 产品id */
ProductId?: string;
}
declare interface DescribeDeviceDataStatsResponse {
/** 累计注册设备数 */
RegisterCnt?: number | null;
/** 设备数量列表 */
Data?: DeviceCntStats[] | null;
/** 总数 */
Total?: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceEventHistoryRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 搜索的事件类型:alert 表示告警,fault 表示故障,info 表示信息,为空则表示查询上述所有类型事件 */
Type?: string;
/** 起始时间(Unix 时间戳,秒级), 为0 表示 当前时间 - 24h */
StartTime?: number;
/** 结束时间(Unix 时间戳,秒级), 为0 表示当前时间 */
EndTime?: number;
/** 搜索上下文, 用作查询游标 */
Context?: string;
/** 单次获取的历史数据项目的最大数量, 缺省10 */
Size?: number;
/** 事件标识符,可以用来指定查询特定的事件,如果不指定,则查询所有事件。 */
EventId?: string;
}
declare interface DescribeDeviceEventHistoryResponse {
/** 搜索上下文, 用作查询游标 */
Context: string | null;
/** 搜索结果数量 */
Total: number | null;
/** 搜索结果是否已经结束 */
Listover: boolean | null;
/** 搜集结果集 */
EventHistory: EventHistoryItem[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDevicePackagesRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 分页拉取数量 */
Limit: number;
/** 分页拉取偏移 */
Offset: number;
/** 用户id */
CSUserId?: string;
/** 通道id */
ChannelId?: number;
}
declare interface DescribeDevicePackagesResponse {
/** 有效云存套餐数量 */
TotalCount?: number;
/** 有效云存套餐列表 */
Packages?: PackageInfo[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceRequest {
/** 产品ID */
ProductId: string;
/** 设备名 */
DeviceName: string;
}
declare interface DescribeDeviceResponse {
/** 设备名 */
DeviceName: string;
/** 设备是否在线,0不在线,1在线,2获取失败,3未激活 */
Online: number;
/** 设备最后上线时间 */
LoginTime: number;
/** 设备密钥 */
DevicePsk: string;
/** 设备启用状态 */
EnableState: number;
/** 设备过期时间 */
ExpireTime: number;
/** 设备的sdk日志等级,0:关闭,1:错误,2:告警,3:信息,4:调试 */
LogLevel: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceStatusLogRequest {
/** 开始时间(毫秒) */
MinTime: number;
/** 结束时间(毫秒) */
MaxTime: number;
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 返回条数 */
Limit?: number;
/** 检索上下文 */
Context?: string;
}
declare interface DescribeDeviceStatusLogResponse {
/** 数据是否已全部返回,true 表示数据全部返回,false 表示还有数据待返回,可将 Context 作为入参,继续查询返回结果。 */
Listover?: boolean | null;
/** 检索上下文,当 ListOver 为false时,可以用此上下文,继续读取后续数据 */
Context?: string | null;
/** 日志数据结果数组,返回对应时间点及取值。 */
Results?: DeviceStatusLogItem[] | null;
/** 日志数据结果总条数 */
TotalCount?: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDevicesRequest {
/** 需要查看设备列表的产品 ID */
ProductId: string;
/** 偏移量,Offset从0开始 */
Offset: number;
/** 分页的大小,最大100 */
Limit: number;
/** 需要过滤的设备名称 */
DeviceName?: string;
}
declare interface DescribeDevicesResponse {
/** 设备总数 */
TotalCount: number;
/** 设备详细信息列表 */
Devices: DeviceInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeFirmwareRequest {
/** 产品ID */
ProductID: string;
/** 固件版本号 */
FirmwareVersion: string;
}
declare interface DescribeFirmwareResponse {
/** 固件版本号 */
Version?: string;
/** 产品ID */
ProductId?: string;
/** 固件名称 */
Name?: string | null;
/** 固件描述 */
Description?: string | null;
/** 固件Md5值 */
Md5sum?: string | null;
/** 固件上传的秒级时间戳 */
Createtime?: number | null;
/** 产品名称 */
ProductName?: string;
/** 固件升级模块 */
FwType?: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeFirmwareTaskDevicesRequest {
/** 产品ID */
ProductID: string;
/** 固件版本 */
FirmwareVersion?: string;
/** 筛选条件 */
Filters?: SearchKeyword[];
/** 查询偏移量 默认为0 */
Offset?: number;
/** 查询的数量 默认为50 */
Limit?: number;
}
declare interface DescribeFirmwareTaskDevicesResponse {
/** 固件升级任务的设备总数 */
Total?: number | null;
/** 固件升级任务的设备列表 */
Devices?: DeviceUpdateStatus[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeFirmwareTaskDistributionRequest {
/** 产品ID */
ProductID: string;
/** 固件版本号 */
FirmwareVersion: string;
/** 固件升级任务ID */
TaskId: number;
}
declare interface DescribeFirmwareTaskDistributionResponse {
/** 固件升级任务状态分布信息 */
StatusInfos?: StatusStatistic[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeFirmwareTaskRequest {
/** 产品ID */
ProductID: string;
/** 固件版本号 */
FirmwareVersion: string;
/** 固件任务ID */
TaskId: number;
}
declare interface DescribeFirmwareTaskResponse {
/** 固件任务ID */
TaskId?: number | null;
/** 固件任务状态 */
Status?: number | null;
/** 固件任务创建时间,单位:秒 */
CreateTime?: number | null;
/** 固件任务升级类型 */
Type?: number | null;
/** 产品名称 */
ProductName?: string | null;
/** 固件任务升级模式。originalVersion(按版本号升级)、filename(提交文件升级)、devicenames(按设备名称升级) */
UpgradeMode?: string | null;
/** 产品ID */
ProductId?: string | null;
/** 原始固件版本号,在UpgradeMode是originalVersion升级模式下会返回 */
OriginalVersion?: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeFirmwareTaskStatisticsRequest {
/** 产品ID */
ProductID: string;
/** 固件版本号 */
FirmwareVersion: string;
}
declare interface DescribeFirmwareTaskStatisticsResponse {
/** 升级成功的设备总数 */
SuccessTotal?: number | null;
/** 升级失败的设备总数 */
FailureTotal?: number | null;
/** 正在升级的设备总数 */
UpgradingTotal?: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeFirmwareTasksRequest {
/** 产品ID */
ProductID: string;
/** 固件版本号 */
FirmwareVersion: string;
/** 查询偏移量 */
Offset: number;
/** 返回查询结果条数 */
Limit: number;
/** 搜索过滤条件 */
Filters?: SearchKeyword[];
}
declare interface DescribeFirmwareTasksResponse {
/** 固件升级任务列表 */
TaskInfos?: FirmwareTaskInfo[] | null;
/** 固件升级任务总数 */
Total?: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeForwardRuleRequest {
/** 产品ID */
ProductID: string;
/** 控制台Skey */
Skey: string;
/** 队列类型,0:CMQ,1:Ckafka */
QueueType: number;
/** 临时密钥 */
Consecretid?: string;
}
declare interface DescribeForwardRuleResponse {
/** 腾讯云账号 */
Endpoint?: string;
/** 队列名称 */
QueueName?: string;
/** 产品ID */
ProductID?: string;
/** 消息类型 1设备上报信息 2设备状态变化通知 3为全选 */
MsgType?: number;
/** 结果 2表示禁用 其他为成功 */
Result?: number;
/** 角色名 */
RoleName?: string;
/** 角色ID */
RoleID?: number;
/** 队列区域 */
QueueRegion?: string;
/** 队列类型,0:CMQ,1:Ckafka */
QueueType?: number;
/** 实例id, 目前只有Ckafka会用到 */
InstanceId?: string;
/** 实例名称,目前只有Ckafka会用到 */
InstanceName?: string;
/** 错误消息 */
ErrMsg?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeFreeCloudStorageNumRequest {
}
declare interface DescribeFreeCloudStorageNumResponse {
/** 套餐包信息 */
PackageInfos?: CloudStoragePackageInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeMessageDataStatsRequest {
/** 统计开始日期 */
StartDate: string;
/** 统计结束日期 */
EndDate: string;
/** 产品id */
ProductId?: string;
}
declare interface DescribeMessageDataStatsResponse {
/** 消息数量列表 */
Data: MessageCntStats[] | null;
/** 总数 */
Total: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeModelDefinitionRequest {
/** 产品ID */
ProductId: string;
}
declare interface DescribeModelDefinitionResponse {
/** 产品数据模板 */
Model: ProductModelDefinition;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeP2PInfoRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
}
declare interface DescribeP2PInfoResponse {
/** xp2pinfo信息 */
P2PInfo?: string;
/** 上报时间 */
ReportTime?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeP2PRouteRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
}
declare interface DescribeP2PRouteResponse {
/** 当前p2p线路 */
RouteId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribePackageConsumeTaskRequest {
/** 任务id */
TaskId: number;
}
declare interface DescribePackageConsumeTaskResponse {
/** 文件下载的url,文件详情是套餐包消耗详情 */
URL?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribePackageConsumeTasksRequest {
/** 分页单页量 */
Limit: number;
/** 分页的偏移量,第一页为0 */
Offset: number;
}
declare interface DescribePackageConsumeTasksResponse {
/** 总数 */
TotalCount: number;
/** 任务列表 */
List: PackageConsumeTask[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeProductDynamicRegisterRequest {
/** 产品ID */
ProductId: string;
}
declare interface DescribeProductDynamicRegisterResponse {
/** 动态注册类型,0-关闭 1-预创建设备 2-自动创建设备 */
RegisterType: number;
/** 动态注册产品密钥 */
ProductSecret: string;
/** 动态注册设备上限 */
RegisterLimit: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeProductRequest {
/** 产品id */
ProductId: string;
}
declare interface DescribeProductResponse {
/** 产品详情 */
Data?: VideoProduct;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeProductsRequest {
/** 分页的大小,最大100 */
Limit: number;
/** 偏移量,Offset从0开始 */
Offset: number;
}
declare interface DescribeProductsResponse {
/** 总数 */
TotalCount?: number;
/** 产品详情列表 */
Data?: VideoProduct[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribePushChannelRequest {
/** 产品ID */
ProductId: string;
}
declare interface DescribePushChannelResponse {
/** 推送类型。ckafka:消息队列;forward:http/https推送 */
Type?: string;
/** 第三方推送地址 */
ForwardAddress?: string | null;
/** 第三方推送密钥,为空表示不使用鉴权token。 */
ForwardKey?: string | null;
/** ckafka地域 */
CKafkaRegion?: string | null;
/** ckafka实例 */
CKafkaInstance?: string | null;
/** ckafka订阅主题 */
CKafkaTopic?: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSDKLogRequest {
/** 日志开始时间 */
MinTime: number;
/** 日志结束时间 */
MaxTime: number;
/** 查询关键字,可以同时支持键值查询和文本查询,例如,查询某key的值为value,并且包含某word的日志,该参数为:key:value word。键值或文本可以包含多个,以空格隔开。其中可以索引的key包括:productid、devicename、loglevel一个典型的查询示例:productid:7JK1G72JNE devicename:name publish loglevel:WARN一个典型的查询示例:productid:ABCDE12345 devicename:test scene:SHADOW publish */
Keywords: string;
/** 日志检索上下文 */
Context?: string;
/** 查询条数 */
MaxNum?: number;
}
declare interface DescribeSDKLogResponse {
/** 日志检索上下文 */
Context?: string;
/** 是否还有日志,如有仍有日志,下次查询的请求带上当前请求返回的Context */
Listover?: boolean;
/** 日志列表 */
Results?: SDKLogItem[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeUserRequest {
}
declare interface DescribeUserResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface EditFirmwareRequest {
/** 产品ID。 */
ProductID: string;
/** 固件版本号。 */
FirmwareVersion: string;
/** 固件名称。 */
FirmwareName: string;
/** 固件描述。 */
FirmwareDescription?: string;
}
declare interface EditFirmwareResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GenSingleDeviceSignatureOfPublicRequest {
/** 设备所属的产品ID */
ProductId: string;
/** 需要绑定的设备 */
DeviceName: string;
/** 设备绑定签名的有效时间,以秒为单位。取值范围:0 < Expire <= 86400,Expire == -1(十年) */
Expire: number;
}
declare interface GenSingleDeviceSignatureOfPublicResponse {
/** 设备签名信息 */
DeviceSignature: DeviceSignatureInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GenerateSignedVideoURLRequest {
/** 视频播放原始URL地址 */
VideoURL: string;
/** 播放链接过期时间(时间戳,单位秒) */
ExpireTime: number;
/** 通道ID 非NVR设备不填 NVR设备必填 默认为无 */
ChannelId?: number;
}
declare interface GenerateSignedVideoURLResponse {
/** 视频防盗链播放URL */
SignedVideoURL?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetAllFirmwareVersionRequest {
/** 产品ID */
ProductID: string;
}
declare interface GetAllFirmwareVersionResponse {
/** 固件可用版本列表 */
Version?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetFirmwareURLRequest {
/** 产品ID */
ProductID: string;
/** 固件版本 */
FirmwareVersion: string;
}
declare interface GetFirmwareURLResponse {
/** 固件URL */
Url?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ImportModelDefinitionRequest {
/** 产品ID */
ProductId: string;
/** 数据模板定义 */
ModelSchema: string;
}
declare interface ImportModelDefinitionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface InheritCloudStorageUserRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 原始用户ID */
UserId: string;
/** 目标用户ID */
ToUserId: string;
}
declare interface InheritCloudStorageUserResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListFirmwaresRequest {
/** 获取的页数 */
PageNum: number;
/** 分页的大小 */
PageSize: number;
/** 产品ID */
ProductID?: string;
/** 搜索过滤条件 */
Filters?: SearchKeyword[];
}
declare interface ListFirmwaresResponse {
/** 固件总数 */
TotalCount?: number;
/** 固件列表 */
Firmwares?: FirmwareInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDataForwardRequest {
/** 产品ID。 */
ProductId: string;
/** 转发地址。如果有鉴权Token,则需要自行传入,例如 [{\"forward\":{\"api\":\"http://123.207.117.108:1080/sub.php\",\"token\":\"testtoken\"}}] */
ForwardAddr: string;
/** 1-数据信息转发 2-设备上下线状态转发 3-数据信息转发&设备上下线状态转发 */
DataChose?: number;
}
declare interface ModifyDataForwardResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDataForwardStatusRequest {
/** 产品ID。 */
ProductId: string;
/** 转发状态,1启用,0禁用。 */
Status: number;
}
declare interface ModifyDataForwardStatusResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDeviceLogLevelRequest {
/** 产品ID */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 日志级别,0:关闭,1:错误,2:告警,3:信息,4:调试 */
LogLevel: number;
}
declare interface ModifyDeviceLogLevelResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDeviceRequest {
/** 设备所属产品id */
ProductId: string;
/** 设备名称 */
DeviceName: string;
/** 要设置的设备状态,1为启用,0为禁用 */
EnableState?: number;
}
declare interface ModifyDeviceResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyForwardRuleRequest {
/** 产品ID */
ProductID: string;
/** 消息类型 */
MsgType: number;
/** 控制台Skey */
Skey: string;
/** 队列区域 */
QueueRegion: string;
/** 队列类型 0.CMQ 1.CKafka */
QueueType: number;
/** 临时密钥 */
Consecretid?: string;
/** 实例ID */
InstanceId?: string;
/** 实例名称 */
InstanceName?: string;
/** 队列或主题ID */
QueueID?: string;
/** 队列或主题名称 */
QueueName?: string;
}
declare interface ModifyForwardRuleResponse {
/** 腾讯云账号 */
Endpoint: string;
/** 产品ID */
ProductID: string;
/** 结果 */
Result: number;
/** 错误信息 */
ErrMsg: string;
/** 队列类型 0.CMQ 1.CKafka */
QueueType: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyModelDefinitionRequest {
/** 产品ID */
ProductId: string;
/** 数据模板定义 */
ModelSchema: string;
}
declare interface ModifyModelDefinitionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyProductDynamicRegisterRequest {
/** 产品ID */
ProductId: string;
/** 动态注册类型,0-关闭 1-预创建设备 2-自动创建设备 */
RegisterType: number;
/** 动态注册设备上限 */
RegisterLimit: number;
}
declare interface ModifyProductDynamicRegisterResponse {
/** 动态注册类型,0-关闭 1-预创建设备 2-自动创建设备 */
RegisterType: number;
/** 动态注册产品密钥 */
ProductSecret: string;
/** 动态注册设备上限 */
RegisterLimit: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyProductRequest {
/** 产品id */
ProductId: string;
/** 修改的产品名称 (支持中文、英文、数字、下划线组合,最多不超过20个字符) */
ProductName?: string;
/** 修改的产品描述 (最多不超过128个字符) */
ProductDescription?: string;
}
declare interface ModifyProductResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyPushChannelRequest {
/** 产品ID */
ProductId: string;
/** 推送类型。ckafka:消息队列;forward:http/https推送 */
Type: string;
/** 第三方推送地址 */
ForwardAddress?: string;
/** 第三方推送密钥,不填写则不生成签名。 */
ForwardKey?: string;
/** ckafka地域 */
CKafkaRegio