tencentcloud-sdk-nodejs
Version:
2,860 lines (2,859 loc) • 120 kB
TypeScript
/**
* DescribeCloudStorageDate请求参数结构体
*/
export interface DescribeCloudStorageDateRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 用户ID
*/
UserId?: string;
/**
* 通道ID
*/
ChannelId?: number;
}
/**
* 云存时间轴接口返回数据
*/
export interface CloudStorageTimeData {
/**
* 云存时间轴信息列表
*/
TimeList: Array<CloudStorageTimeInfo>;
/**
* 播放地址
*/
VideoURL: string;
}
/**
* 云存套餐包消耗统计
*/
export interface PackageConsumeStat {
/**
* 云存套餐包id
*/
PackageId: string;
/**
* 云存套餐包名称
*/
PackageName: string;
/**
* 消耗个数
*/
Cnt: number;
/**
* 套餐包单价,单位分
*/
Price: number;
/**
* 消耗来源,1预付费
*/
Source: number;
}
/**
* DescribeCloudStoragePackageConsumeDetails返回参数结构体
*/
export interface DescribeCloudStoragePackageConsumeDetailsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCloudStorage请求参数结构体
*/
export 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;
}
/**
* 云存套餐包信息
*/
export interface CloudStoragePackageInfo {
/**
* 套餐包id
*/
PackageId?: string;
/**
* 套餐包名字
*/
PackageName?: string;
/**
* 套餐包数量
*/
Num?: number;
/**
* 已使用数量
*/
UsedNum?: number;
}
/**
* 消息数量统计
*/
export interface MessageCntStats {
/**
* 统计日期
*/
Date?: string;
/**
* 物模型上行消息数
注意:此字段可能返回 null,表示取不到有效值。
*/
UpMsgCnt?: number;
/**
* 物模型下行消息数
注意:此字段可能返回 null,表示取不到有效值。
*/
DownMsgCnt?: number;
/**
* ntp消息数
注意:此字段可能返回 null,表示取不到有效值。
*/
NtpMsgCnt?: number;
}
/**
* DescribeDeviceDataStats请求参数结构体
*/
export interface DescribeDeviceDataStatsRequest {
/**
* 开始日期
*/
StartDate: string;
/**
* 结束日期
*/
EndDate: string;
/**
* 产品id
*/
ProductId?: string;
}
/**
* 缩略图信息
*/
export interface ThumbnailURLInfoList {
/**
* 缩略图访问地址
注意:此字段可能返回 null,表示取不到有效值。
*/
ThumbnailURL?: string;
/**
* 缩略图访问地址的过期时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpireTime?: number;
}
/**
* ImportModelDefinition返回参数结构体
*/
export interface ImportModelDefinitionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ApplyAIModel请求参数结构体
*/
export interface ApplyAIModelRequest {
/**
* AI模型ID
*/
ModelId: string;
/**
* 产品ID
*/
ProductId: string;
}
/**
* CreateBatch请求参数结构体
*/
export interface CreateBatchRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 批次创建的设备数量
*/
DevNum: number;
/**
* 批次创建的设备前缀。不超过24个字符
*/
DevPre: string;
}
/**
* DeleteCloudStorageEvent返回参数结构体
*/
export interface DeleteCloudStorageEventResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyProductDynamicRegister返回参数结构体
*/
export interface ModifyProductDynamicRegisterResponse {
/**
* 动态注册类型,0-关闭 1-预创建设备 2-自动创建设备
*/
RegisterType: number;
/**
* 动态注册产品密钥
*/
ProductSecret: string;
/**
* 动态注册设备上限
*/
RegisterLimit: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyProduct返回参数结构体
*/
export interface ModifyProductResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelAIModelApplication返回参数结构体
*/
export interface CancelAIModelApplicationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageTime返回参数结构体
*/
export interface DescribeCloudStorageTimeResponse {
/**
* 接口返回数据
*/
Data?: CloudStorageTimeData;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageThumbnailList请求参数结构体
*/
export interface DescribeCloudStorageThumbnailListRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 缩略图文件名列表
*/
ThumbnailList: Array<string>;
}
/**
* DescribeDevicePackages请求参数结构体
*/
export interface DescribeDevicePackagesRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 分页拉取数量
*/
Limit: number;
/**
* 分页拉取偏移
*/
Offset: number;
/**
* 用户id
*/
CSUserId?: string;
/**
* 通道id
*/
ChannelId?: number;
}
/**
* ReportAliveDevice请求参数结构体
*/
export interface ReportAliveDeviceRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
}
/**
* DescribeProducts请求参数结构体
*/
export interface DescribeProductsRequest {
/**
* 分页的大小,最大100
*/
Limit: number;
/**
* 偏移量,Offset从0开始
*/
Offset: number;
}
/**
* DescribeAIModelChannel返回参数结构体
*/
export interface DescribeAIModelChannelResponse {
/**
* 推送类型。ckafka:消息队列;forward:http/https推送
*/
Type?: string;
/**
* 第三方推送地址
注意:此字段可能返回 null,表示取不到有效值。
*/
ForwardAddress?: string;
/**
* 第三方推送密钥
注意:此字段可能返回 null,表示取不到有效值。
*/
ForwardKey?: string;
/**
* ckafka地域
注意:此字段可能返回 null,表示取不到有效值。
*/
CKafkaRegion?: string;
/**
* ckafka实例
注意:此字段可能返回 null,表示取不到有效值。
*/
CKafkaInstance?: string;
/**
* ckafka订阅主题
注意:此字段可能返回 null,表示取不到有效值。
*/
CKafkaTopic?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMessageDataStats返回参数结构体
*/
export interface DescribeMessageDataStatsResponse {
/**
* 消息数量列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Data: Array<MessageCntStats>;
/**
* 总数
注意:此字段可能返回 null,表示取不到有效值。
*/
Total: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDeviceActionHistory请求参数结构体
*/
export interface DescribeDeviceActionHistoryRequest {
/**
* 产品Id
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 开始范围的 unix 毫秒时间戳
*/
MinTime: number;
/**
* 结束范围的 unix 毫秒时间戳
*/
MaxTime: number;
/**
* 动作Id
*/
ActionId?: string;
/**
* 查询条数 默认为0 最大不超过500
*/
Limit?: number;
/**
* 游标,标识查询位置。
*/
Context?: string;
}
/**
* DescribeCloudStorageMultiThumbnail返回参数结构体
*/
export interface DescribeCloudStorageMultiThumbnailResponse {
/**
* 缩略图访问地址
*/
ThumbnailURLInfoList?: Array<ThumbnailURLInfoList>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDataForward请求参数结构体
*/
export 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;
}
/**
* DescribeCloudStorageThumbnail请求参数结构体
*/
export interface DescribeCloudStorageThumbnailRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 缩略图文件名
*/
Thumbnail: string;
}
/**
* DescribeDevices返回参数结构体
*/
export interface DescribeDevicesResponse {
/**
* 设备总数
*/
TotalCount: number;
/**
* 设备详细信息列表
*/
Devices: Array<DeviceInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFreeCloudStorage返回参数结构体
*/
export interface CreateFreeCloudStorageResponse {
/**
* 订单金额,单位为分
注意:此字段可能返回 null,表示取不到有效值。
*/
Price?: number;
/**
* 支付金额,单位为分
注意:此字段可能返回 null,表示取不到有效值。
*/
Amount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyProduct请求参数结构体
*/
export interface ModifyProductRequest {
/**
* 产品id
*/
ProductId: string;
/**
* 修改的产品名称 (支持中文、英文、数字、下划线组合,最多不超过20个字符)
*/
ProductName?: string;
/**
* 修改的产品描述 (最多不超过128个字符)
*/
ProductDescription?: string;
}
/**
* ModifyModelDefinition请求参数结构体
*/
export interface ModifyModelDefinitionRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 数据模板定义
*/
ModelSchema: string;
}
/**
* DescribeBatchs返回参数结构体
*/
export interface DescribeBatchsResponse {
/**
* 批次数量
*/
TotalCount?: number;
/**
* 批次列表详情
*/
Data?: Array<VideoBatch>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelAIModelApplication请求参数结构体
*/
export interface CancelAIModelApplicationRequest {
/**
* AI模型ID
*/
ModelId: string;
/**
* 产品ID
*/
ProductId: string;
}
/**
* SDK日志项
*/
export interface SDKLogItem {
/**
* 产品ID
*/
ProductID?: string;
/**
* 设备名称
*/
DeviceName?: string;
/**
* 日志等级
*/
Level?: string;
/**
* 日志时间
*/
DateTime?: string;
/**
* 日志内容
*/
Content?: string;
}
/**
* DescribeUser请求参数结构体
*/
export declare type DescribeUserRequest = null;
/**
* DescribeForwardRule返回参数结构体
*/
export 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)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CallDeviceActionSync请求参数结构体
*/
export interface CallDeviceActionSyncRequest {
/**
* 产品Id
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 产品数据模板中行为功能的标识符,由开发者自行根据设备的应用场景定义
*/
ActionId: string;
/**
* 输入参数
*/
InputParams?: string;
}
/**
* ModifyDeviceLogLevel请求参数结构体
*/
export interface ModifyDeviceLogLevelRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 日志级别,0:关闭,1:错误,2:告警,3:信息,4:调试
*/
LogLevel: number;
}
/**
* DescribeBatch请求参数结构体
*/
export interface DescribeBatchRequest {
/**
* 批次ID
*/
BatchId: number;
}
/**
* DescribeForwardRule请求参数结构体
*/
export interface DescribeForwardRuleRequest {
/**
* 产品ID
*/
ProductID: string;
/**
* 控制台Skey
*/
Skey: string;
/**
* 队列类型,0:CMQ,1:Ckafka
*/
QueueType: number;
/**
* 临时密钥
*/
Consecretid?: string;
}
/**
* ModifyDevice请求参数结构体
*/
export interface ModifyDeviceRequest {
/**
* 设备所属产品id
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 要设置的设备状态,1为启用,0为禁用
*/
EnableState?: number;
}
/**
* 批次元数据
*/
export 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;
}
/**
* CreateCOSCredentials返回参数结构体
*/
export 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)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 产品模型定义
*/
export interface ProductModelDefinition {
/**
* 产品ID
*/
ProductId?: string;
/**
* 模型定义
*/
ModelDefine?: string;
/**
* 更新时间,秒级时间戳
*/
UpdateTime?: number;
/**
* 创建时间,秒级时间戳
*/
CreateTime?: number;
/**
* 产品所属分类的模型快照(产品创建时刻的)
注意:此字段可能返回 null,表示取不到有效值。
*/
CategoryModel?: string;
/**
* 产品的连接类型的模型
注意:此字段可能返回 null,表示取不到有效值。
*/
NetTypeModel?: string;
}
/**
* 查询设备历史
*/
export interface ActionHistory {
/**
* 设备名称
*/
DeviceName?: string;
/**
* 动作Id
*/
ActionId?: string;
/**
* 动作名称
*/
ActionName?: string;
/**
* 请求时间
*/
ReqTime?: number;
/**
* 响应时间
*/
RspTime?: number;
/**
* 输入参数
注意:此字段可能返回 null,表示取不到有效值。
*/
InputParams?: string;
/**
* 输出参数
注意:此字段可能返回 null,表示取不到有效值。
*/
OutputParams?: string;
/**
* 调用方式
*/
Calling?: string;
/**
* 调用Id
*/
ClientToken?: string;
/**
* 调用状态
*/
Status?: string;
}
/**
* RetryDeviceFirmwareTask请求参数结构体
*/
export interface RetryDeviceFirmwareTaskRequest {
/**
* 产品ID
*/
ProductID: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 固件版本号
*/
FirmwareVersion: string;
/**
* 固件升级任务ID
*/
TaskId: number;
}
/**
* CreateDataForward返回参数结构体
*/
export interface CreateDataForwardResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UploadFirmware请求参数结构体
*/
export interface UploadFirmwareRequest {
/**
* 产品ID
*/
ProductID: string;
/**
* 固件版本号
*/
FirmwareVersion: string;
/**
* 固件的MD5值
*/
Md5sum: string;
/**
* 固件的大小
*/
FileSize: number;
/**
* 固件名称
*/
FirmwareName?: string;
/**
* 固件描述
*/
FirmwareDescription?: string;
/**
* 固件升级模块;可选值 mcu|moudule
*/
FwType?: string;
}
/**
* DescribeCloudStoragePackageConsumeStats返回参数结构体
*/
export interface DescribeCloudStoragePackageConsumeStatsResponse {
/**
* 统计列表详情
*/
Stats: Array<PackageConsumeStat>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeP2PRoute返回参数结构体
*/
export interface DescribeP2PRouteResponse {
/**
* 当前p2p线路
*/
RouteId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFirmware请求参数结构体
*/
export interface DescribeFirmwareRequest {
/**
* 产品ID
*/
ProductID: string;
/**
* 固件版本号
*/
FirmwareVersion: string;
}
/**
* DescribeCloudStorageUsers返回参数结构体
*/
export interface DescribeCloudStorageUsersResponse {
/**
* 用户总数
*/
TotalCount?: number;
/**
* 用户信息
*/
Users?: Array<CloudStorageUserInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProduct请求参数结构体
*/
export interface DescribeProductRequest {
/**
* 产品id
*/
ProductId: string;
}
/**
* DescribeProducts返回参数结构体
*/
export interface DescribeProductsResponse {
/**
* 总数
*/
TotalCount?: number;
/**
* 产品详情列表
*/
Data?: Array<VideoProduct>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CheckForwardAuth请求参数结构体
*/
export interface CheckForwardAuthRequest {
/**
* 控制台Skey
*/
Skey: string;
/**
* 队列类型 0.CMQ 1.Ckafka
*/
QueueType: number;
}
/**
* DescribeDeviceData请求参数结构体
*/
export interface DescribeDeviceDataRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
}
/**
* CreateBatch返回参数结构体
*/
export interface CreateBatchResponse {
/**
* 批次ID
*/
BatchId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePackageConsumeTasks返回参数结构体
*/
export interface DescribePackageConsumeTasksResponse {
/**
* 总数
*/
TotalCount: number;
/**
* 任务列表
*/
List: Array<PackageConsumeTask>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDeviceActionHistory返回参数结构体
*/
export interface DescribeDeviceActionHistoryResponse {
/**
* 总条数
*/
TotalCounts: number;
/**
* 动作历史
注意:此字段可能返回 null,表示取不到有效值。
*/
ActionHistories: Array<ActionHistory>;
/**
* 用于标识查询结果的上下文,翻页用。
注意:此字段可能返回 null,表示取不到有效值。
*/
Context: string;
/**
* 搜索结果是否已经结束。
注意:此字段可能返回 null,表示取不到有效值。
*/
Listover: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCategory请求参数结构体
*/
export interface DescribeCategoryRequest {
/**
* Category ID。
*/
Id: number;
}
/**
* CreateCOSCredentials请求参数结构体
*/
export interface CreateCOSCredentialsRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
}
/**
* 设备通讯日志查询返回条目
*/
export interface DeviceCommLogItem {
/**
* 时间
*/
Time?: string;
/**
* 日志类型,device 设备上行,shadow 服务端下行。
*/
Type?: string;
/**
* 通讯数据。
*/
Data?: string;
}
/**
* DescribeBonuses返回参数结构体
*/
export interface DescribeBonusesResponse {
/**
* 资源包总数
*/
TotalCount: number;
/**
* 资源包信息
*/
Bonuses: Array<BonusInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageMultiThumbnail请求参数结构体
*/
export interface DescribeCloudStorageMultiThumbnailRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 多个缩略图文件名根据 | 分割
*/
MultiThumbnail: string;
}
/**
* GenSingleDeviceSignatureOfPublic返回参数结构体
*/
export interface GenSingleDeviceSignatureOfPublicResponse {
/**
* 设备签名信息
*/
DeviceSignature: DeviceSignatureInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDataForwardList返回参数结构体
*/
export interface DescribeDataForwardListResponse {
/**
* 数据转发列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
DataForwardList: Array<DataForward>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteFirmware返回参数结构体
*/
export interface DeleteFirmwareResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 套餐包消耗任务列表
*/
export interface PackageConsumeTask {
/**
* 任务id
*/
TaskId: number;
/**
* 任务创始时间
*/
CreateTime: string;
/**
* 任务状态,1待处理,2处理中,3已完成
*/
State: number;
}
/**
* CreateForwardRule返回参数结构体
*/
export 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)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BatchUpdateFirmware返回参数结构体
*/
export interface BatchUpdateFirmwareResponse {
/**
* 任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeModelDefinition返回参数结构体
*/
export interface DescribeModelDefinitionResponse {
/**
* 产品数据模板
*/
Model: ProductModelDefinition;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteProduct请求参数结构体
*/
export interface DeleteProductRequest {
/**
* 产品ID
*/
ProductId: string;
}
/**
* 状态统计信息
*/
export interface StatusStatistic {
/**
* 任务状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* 统计总数
注意:此字段可能返回 null,表示取不到有效值。
*/
Total?: number;
}
/**
* PublishMessage返回参数结构体
*/
export interface PublishMessageResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SetForwardAuth返回参数结构体
*/
export interface SetForwardAuthResponse {
/**
* 腾讯云账号
*/
Endpoint: string;
/**
* 结果
*/
Result: number;
/**
* 角色名
*/
RoleName: string;
/**
* 角色ID
*/
RoleID: number;
/**
* 消息队列类型 0.CMQ 1.CKafka
*/
QueueType: number;
/**
* 错误消息
*/
ErrMsg: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EditFirmware请求参数结构体
*/
export interface EditFirmwareRequest {
/**
* 产品ID。
*/
ProductID: string;
/**
* 固件版本号。
*/
FirmwareVersion: string;
/**
* 固件名称。
*/
FirmwareName: string;
/**
* 固件描述。
*/
FirmwareDescription?: string;
}
/**
* DescribePushChannel返回参数结构体
*/
export interface DescribePushChannelResponse {
/**
* 推送类型。ckafka:消息队列;forward:http/https推送
*/
Type?: string;
/**
* 第三方推送地址
注意:此字段可能返回 null,表示取不到有效值。
*/
ForwardAddress?: string;
/**
* 第三方推送密钥,为空表示不使用鉴权token。
注意:此字段可能返回 null,表示取不到有效值。
*/
ForwardKey?: string;
/**
* ckafka地域
注意:此字段可能返回 null,表示取不到有效值。
*/
CKafkaRegion?: string;
/**
* ckafka实例
注意:此字段可能返回 null,表示取不到有效值。
*/
CKafkaInstance?: string;
/**
* ckafka订阅主题
注意:此字段可能返回 null,表示取不到有效值。
*/
CKafkaTopic?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReportAliveDevice返回参数结构体
*/
export interface ReportAliveDeviceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDeviceEventHistory请求参数结构体
*/
export 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;
}
/**
* DescribeCategory返回参数结构体
*/
export interface DescribeCategoryResponse {
/**
* Category详情
*/
Data: ProductTemplate;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSDKLog请求参数结构体
*/
export 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;
}
/**
* DescribeBalance请求参数结构体
*/
export interface DescribeBalanceRequest {
/**
* 账户类型:1-设备接入;2-云存。
*/
AccountType: number;
}
/**
* 运营活动资源包信息
*/
export interface BonusInfo {
/**
* 资源包ID
*/
BonusId: number;
/**
* 用户ID
*/
UserId: string;
/**
* 资源包配置ID
*/
PackageId: string;
/**
* 资源总数
*/
Total: number;
/**
* 资源消耗总数
*/
Used: number;
/**
* 资源包过期时间
*/
ExpireTime: number;
/**
* 资源包创建时间
*/
CreateTime: number;
/**
* 资源包状态 0.未使用 1.使用中 2.已退款 3.已过期
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
}
/**
* DescribeDataForwardList请求参数结构体
*/
export interface DescribeDataForwardListRequest {
/**
* 产品ID列表
*/
ProductIds: string;
}
/**
* DescribeDeviceCommLog返回参数结构体
*/
export interface DescribeDeviceCommLogResponse {
/**
* 数据是否已全部返回,true 表示数据全部返回,false 表示还有数据待返回,可将 Context 作为入参,继续查询返回结果。
*/
Listover: boolean;
/**
* 检索上下文,当 ListOver 为false时,可以用此上下文,继续读取后续数据
*/
Context: string;
/**
* 日志数据结果数组,返回对应时间点及取值。
*/
Results: Array<DeviceCommLogItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDevice请求参数结构体
*/
export interface DeleteDeviceRequest {
/**
* 产品ID。
*/
ProductId: string;
/**
* 设备名称。
*/
DeviceName: string;
}
/**
* GenerateSignedVideoURL返回参数结构体
*/
export interface GenerateSignedVideoURLResponse {
/**
* 视频防盗链播放URL
*/
SignedVideoURL?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ControlDeviceData请求参数结构体
*/
export interface ControlDeviceDataRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义
*/
Data: string;
/**
* 请求类型 , 不填该参数或者 desired 表示下发属性给设备, reported 表示模拟设备上报属性
*/
Method?: string;
/**
* 上报数据UNIX时间戳(毫秒), 仅对Method:reported有效
*/
DataTimestamp?: number;
}
/**
* AI模型资源使用信息
*/
export interface AIModelUsageInfo {
/**
* 开通时间
*/
CreateTime: number;
/**
* 资源总量
*/
Total: number;
/**
* 已使用资源数量
*/
Used: number;
}
/**
* GetAllFirmwareVersion请求参数结构体
*/
export interface GetAllFirmwareVersionRequest {
/**
* 产品ID
*/
ProductID: string;
}
/**
* 结构体(PackageInfo)记录了设备拥有的有效套餐信息,包括云存开启状态、云存类型、云存回看时长、云存套餐过期时间
*/
export interface PackageInfo {
/**
* 云存开启状态,0为未开启,2为正在生效,1为已过期
注:这里只返回状态为0的数据
*/
Status?: number;
/**
* 云存类型,1为全时云存,2为事件云存
*/
CSType?: number;
/**
* 云存回看时长
*/
CSShiftDuration?: number;
/**
* 云存套餐过期时间
*/
CSExpiredTime?: number;
/**
* 云存套餐创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreatedAt?: number;
/**
* 云存套餐更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdatedAt?: number;
/**
* 套餐id
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageId?: string;
/**
* 订单id
注意:此字段可能返回 null,表示取不到有效值。
*/
OrderId?: string;
/**
* 通道id
*/
ChannelId?: number;
/**
* 用户id
注意:此字段可能返回 null,表示取不到有效值。
*/
CSUserId?: string;
}
/**
* DescribeFirmwareTaskDevices请求参数结构体
*/
export interface DescribeFirmwareTaskDevicesRequest {
/**
* 产品ID
*/
ProductID: string;
/**
* 固件版本
*/
FirmwareVersion?: string;
/**
* 筛选条件
*/
Filters?: Array<SearchKeyword>;
/**
* 查询偏移量 默认为0
*/
Offset?: number;
/**
* 查询的数量 默认为50
*/
Limit?: number;
}
/**
* DescribeFirmware返回参数结构体
*/
export interface DescribeFirmwareResponse {
/**
* 固件版本号
*/
Version?: string;
/**
* 产品ID
*/
ProductId?: string;
/**
* 固件名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
/**
* 固件描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* 固件Md5值
注意:此字段可能返回 null,表示取不到有效值。
*/
Md5sum?: string;
/**
* 固件上传的秒级时间戳
注意:此字段可能返回 null,表示取不到有效值。
*/
Createtime?: number;
/**
* 产品名称
*/
ProductName?: string;
/**
* 固件升级模块
注意:此字段可能返回 null,表示取不到有效值。
*/
FwType?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDeviceStatusLog返回参数结构体
*/
export interface DescribeDeviceStatusLogResponse {
/**
* 数据是否已全部返回,true 表示数据全部返回,false 表示还有数据待返回,可将 Context 作为入参,继续查询返回结果。
注意:此字段可能返回 null,表示取不到有效值。
*/
Listover?: boolean;
/**
* 检索上下文,当 ListOver 为false时,可以用此上下文,继续读取后续数据
注意:此字段可能返回 null,表示取不到有效值。
*/
Context?: string;
/**
* 日志数据结果数组,返回对应时间点及取值。
注意:此字段可能返回 null,表示取不到有效值。
*/
Results?: Array<DeviceStatusLogItem>;
/**
* 日志数据结果总条数
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDeviceCommLog请求参数结构体
*/
export interface DescribeDeviceCommLogRequest {
/**
* 开始时间 13位时间戳 单位毫秒
*/
MinTime: number;
/**
* 结束时间 13位时间戳 单位毫秒
*/
MaxTime: number;
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 返回条数 默认为50
*/
Limit?: number;
/**
* 检索上下文
*/
Context?: string;
/**
* 类型:shadow 下行,device 上行 默认为空则全部查询
*/
Type?: string;
}
/**
* UpdateAIModelChannel请求参数结构体
*/
export interface UpdateAIModelChannelRequest {
/**
* 模型ID
*/
ModelId: string;
/**
* 产品ID
*/
ProductId: string;
/**
* 推送类型。ckafka:消息队列;forward:http/https推送
*/
Type: string;
/**
* 第三方推送地址
*/
ForwardAddress?: string;
/**
* 第三方推送密钥,不填写则腾讯云自动生成。
*/
ForwardKey?: string;
/**
* ckafka地域
*/
CKafkaRegion?: string;
/**
* ckafka实例
*/
CKafkaInstance?: string;
/**
* ckafka订阅主题
*/
CKafkaTopic?: string;
}
/**
* WakeUpDevice返回参数结构体
*/
export interface WakeUpDeviceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteForwardRule请求参数结构体
*/
export interface DeleteForwardRuleRequest {
/**
* 产品ID
*/
ProductID: string;
/**
* 控制台Skey
*/
Skey: string;
/**
* 队列类型
*/
QueueType: number;
/**
* 队列名称
*/
QueueName: string;
}
/**
* DescribeCloudStorageStreamData返回参数结构体
*/
export interface DescribeCloudStorageStreamDataResponse {
/**
* 图片流视频地址
*/
VideoStream: string;
/**
* 图片流音频地址
*/
AudioStream: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateAIModelChannel返回参数结构体
*/
export interface UpdateAIModelChannelResponse {
/**
* 第三方推送密钥,如果选择自动生成则会返回此字段
注意:此字段可能返回 null,表示取不到有效值。
*/
ForwardKey?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 设备固件更新状态
*/
export interface DeviceUpdateStatus {
/**
* 设备名
*/
DeviceName?: string;
/**
* 最后处理时间
*/
LastProcessTime?: number;
/**
* 状态
*/
Status?: number;
/**
* 错误消息
*/
ErrMsg?: string;
/**
* 返回码
*/
Retcode?: number;
/**
* 目标更新版本
*/
DstVersion?: string;
/**
* 下载中状态时的下载进度
注意:此字段可能返回 null,表示取不到有效值。
*/
Percent?: number;
/**
* 原版本号
注意:此字段可能返回 null,表示取不到有效值。
*/
OriVersion?: string;
/**
* 任务ID
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskId?: number;
}
/**
* DescribeAIModelUsage返回参数结构体
*/
export interface DescribeAIModelUsageResponse {
/**
* AI模型资源包总量
*/
TotalCount?: number;
/**
* AI模型资源包信息数组
*/
UsageInfo?: Array<AIModelUsageInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePackageConsumeTask请求参数结构体
*/
export interface DescribePackageConsumeTaskRequest {
/**
* 任务id
*/
TaskId: number;
}
/**
* AI模型申请信息
*/
export interface AIModelApplication {
/**
* 产品ID
*/
ProductId: string;
/**
* 产品名称
*/
ProductName: string;
/**
* 申请状态:1-已申请;2-已取消;3-已拒绝;4-已通过
*/
Status: number;
}
/**
* BindCloudStorageUser请求参数结构体
*/
export interface BindCloudStorageUserRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 用户ID
*/
UserId: string;
}
/**
* ModifyPushChannel返回参数结构体
*/
export interface ModifyPushChannelResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CallDeviceActionSync返回参数结构体
*/
export interface CallDeviceActionSyncResponse {
/**
* 调用Id
注意:此字段可能返回 null,表示取不到有效值。
*/
ClientToken: string;
/**
* 输出参数
注意:此字段可能返回 null,表示取不到有效值。
*/
OutputParams: string;
/**
* 返回状态,当设备不在线等部分情况,会通过该 Status 返回。
注意:此字段可能返回 null,表示取不到有效值。
*/
Status: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateProduct返回参数结构体
*/
export interface CreateProductResponse {
/**
* 产品详情
*/
Data?: VideoProduct;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ChangeP2PRoute返回参数结构体
*/
export interface ChangeP2PRouteResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TRTC调用参数
*/
export interface TRTCParams {
/**
* 应用id,供TRTC SDK使用
注意:此字段可能返回 null,表示取不到有效值。
*/
SDKAppId?: number;
/**
* 用户id,供TRTC SDK使用
注意:此字段可能返回 null,表示取不到有效值。
*/
UserId?: string;
/**
* 用户id签名,供TRTC SDK使用
注意:此字段可能返回 null,表示取不到有效值。
*/
UserSig?: string;
/**
* 房间id,供TRTC SDK使用
注意:此字段可能返回 null,表示取不到有效值。
*/
StrRoomId?: string;
/**
* 权限票据,供TRTC SDK使用
注意:此字段可能返回 null,表示取不到有效值。
*/
PrivateMapKey?: string;
}
/**
* DescribeDeviceDataHistory返回参数结构体
*/
export interface DescribeDeviceDataHistoryResponse {
/**
* 属性字段名称,对应数据模板中功能属性的标识符
注意:此字段可能返回 null,表示取不到有效值。
*/
FieldName: string;
/**
* 数据是否已全部返回,true 表示数据全部返回,false 表示还有数据待返回,可将 Context 作为入参,继续查询返回结果。
注意:此字段可能返回 null,表示取不到有效值。
*/
Listover: boolean;
/**
* 检索上下文,当 ListOver 为false时,可以用此上下文,继续读取后续数据
注意:此字段可能返回 null,表示取不到有效值。
*/
Context: string;
/**
* 历史数据结果数组,返回对应时间点及取值。
注意:此字段可能返回 null,表示取不到有效值。
*/
Results: Array<DeviceDataHistoryItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CallTRTCDevice请求参数结构体
*/
export interface CallTRTCDeviceRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
}
/**
* CallDeviceActionAsync请求参数结构体
*/
export interface CallDeviceActionAsyncRequest {
/**
* 产品Id
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 产品数据模板中行为功能的标识符,由开发者自行根据设备的应用场景定义
*/
ActionId: string;
/**
* 输入参数
*/
InputParams?: string;
}
/**
* DescribeAIModels请求参数结构体
*/
export interface DescribeAIModelsRequest {
/**
* 模型ID
*/
ModelId: string;
/**
* 申请状态:1-已申请;2-已取消;3-已拒绝;4-已通过
*/
Status: number;
/**
* 偏移量,Offset从0开始
*/
Offset: number;
/**
* 分页的大小,最大100
*/
Limit: number;
}
/**
* RetryDeviceFirmwareTask返回参数结构体
*/
export interface RetryDeviceFirmwareTaskResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GenSingleDeviceSignatureOfPublic请求参数结构体
*/
export interface GenSingleDeviceSignatureOfPublicRequest {
/**
* 设备所属的产品ID
*/
ProductId: string;
/**
* 需要绑定的设备
*/
DeviceName: string;
/**
* 设备绑定签名的有效时间,以秒为单位。取值范围:0 < Expire <= 86400,Expire == -1(十年)
*/
Expire: number;
}
/**
* DescribeP2PInfo返回参数结构体
*/
export interface DescribeP2PInfoResponse {
/**
* xp2pinfo信息
*/
P2PInfo?: string;
/**
* 上报时间
*/
ReportTime?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ResetCloudStorage返回参数结构体
*/
export interface ResetCloudStorageResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InheritCloudStorageUser返回参数结构体
*/
export interface InheritCloudStorageUserResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDeviceEventHistory返回参数结构体
*/
export interface DescribeDeviceEventHistoryResponse {
/**
* 搜索上下文, 用作查询游标
注意:此字段可能返回 null,表示取不到有效值。
*/
Context: string;
/**
* 搜索结果数量
注意:此字段可能返回 null,表示取不到有效值。
*/
Total: number;
/**
* 搜索结果是否已经结束
注意:此字段可能返回 null,表示取不到有效值。
*/
Listover: boolean;
/**
* 搜集结果集
注意:此字段可能返回 null,表示取不到有效值。
*/
EventHistory: Array<EventHistoryItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFirmwareTask返回参数结构体
*/
export interface DescribeFirmwareTaskResponse {
/**
* 固件任务ID
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskId?: number;
/**
* 固件任务状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* 固件任务创建时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: number;
/**
* 固件任务升级类型
注意:此字段可能返回 null,表示取不到有效值。
*/
Type?: number;
/**
* 产品名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ProductName?: string;
/**
* 固件任务升级模式。originalVersion(按版本号升级)、filename(提交文件升级)、devicenames(按设备名称升级)
注意:此字段可能返回 null,表示取不到有效值。
*/
UpgradeMode?: string;
/**
* 产品ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ProductId?: string;
/**
* 原始固件版本号,在UpgradeMode是originalVersion升级模式下会返回
注意:此字段可能返回 null,表示取不到有效值。
*/
OriginalVersion?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 设备固件详细信息
*/
export interface FirmwareInfo {
/**
* 固件版本
*/
Version?: string;
/**
* 固件MD5值
*/
Md5sum?: string;
/**
* 固件创建时间
*/
CreateTime?: number;
/**
* 产品名称
*/
ProductName?: string;
/**
* 固件名称
*/
Name?: string;
/**
* 固件描述
*/
Description?: string;
/**
* 产品ID
*/
ProductId?: string;
/**
* 固件升级模块
注意:此字段可能返回 null,表示取不到有效值。
*/
FwType?: string;
}
/**
* CreateProduct请求参数结构体
*/
export 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: Array<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;
}
/**
* ChangeP2PRoute请求参数结构体
*/
export interface ChangeP2PRouteRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* P2P线路
*/
RouteId: number;
}
/**
* GetFirmwareURL返回参数结构体
*/
export interface GetFirmwareURLResponse {
/**
* 固件URL
*/
Url?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUser返回参数结构体
*/
export interface DescribeUserResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePackageConsumeTask返回参数结构体
*/
export interface DescribePackageConsumeTaskResponse {
/**
* 文件下载的url,文件详情是套餐包消耗详情
*/
URL?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAIModelApplications请求参数结构体
*/
export interface DescribeAIModelApplicationsRequest {
/**
* 模型ID
*/
ModelId: string;
/**
* 分页的大小,最大100
*/
Limit: number;
/**
* 偏移量,Offset从0开始
*/
Offset: number;
/**
* 产品ID
*/
ProductId?: string;
}
/**
* DescribeCloudStorageEvents请求参数结构体
*/
export 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;
}
/**
* ListFirmwares请求参数结构体
*/
export interface ListFirmwaresRequest {
/**
* 获取的页数
*/
PageNum: number;
/**
* 分页的大小
*/
PageSize: number;
/**
* 产品ID
*/
ProductID?: string;
/**
* 搜索过滤条件
*/
Filters?: Array<SearchKeyword>;
}
/**
* PublishMessage请求参数结构体
*/
export interface PublishMessageRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 消息发往的主题
*/
Topic: string;
/**
* 云端下发到设备的控制报文
*/
Payload: string;
/**
* 消息服务质量等级,取值为0或1
*/
Qos?: number;
/**
* Payload的内容编码格式,取值为base64或空。base64表示云端将接收到的base64编码后的报文再转换成二进制报文下发至设备,为空表示不作转换,透传下发至设备
*/
PayloadEncoding?: string;
}
/**
* DescribeDeviceStatusLog请求参数结构体
*/
export interface DescribeDeviceStatusLogRequest {
/**
* 开始时间(毫秒)
*/
MinTime: number;
/**
* 结束时间(毫秒)
*/
MaxTime: number;
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 返回条数
*/
Limit?: number;
/**
* 检索上下文
*/
Context?: string;
}
/**
* DescribeSDKLog返回参数结构体
*/
export interface DescribeSDKLogResponse {
/**
* 日志检索上下文
*/
Context?: string;
/**
* 是否还有日志,如有仍有日志,下次查询的请求带上当前请求返回的Context
*/
Listover?: boolean;
/**
* 日志列表
*/
Results?: Array<SDKLogItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBalance返回参数结构体
*/
export interface DescribeBalanceResponse {
/**
* 账户余额,单位:分(人民币)。
*/
Balance: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFirmwareTaskDevices返回参数结构体
*/
export interface DescribeFirmwareTaskDevicesResponse {
/**
* 固件升级任务的设备总数
注意:此字段可能返回 null,表示取不到有效值。
*/
Total?: number;
/**
* 固件升级任务的设备列表
*/
Devices?: Array<DeviceUpdateStatus>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFirmwareTasks返回参数结构体
*/
export interface DescribeFirmwareTasksResponse {
/**
* 固件升级任务列表
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskInfos?: Array<FirmwareTaskInfo>;
/**
* 固件升级任务总数
注意:此字段可能返回 null,表示取不到有效值。
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云存用户信息
*/
export interface CloudStorageUserInfo {
/**
* 用户ID
*/
UserId: string;
}
/**
* DescribeP2PInfo请求参数结构体
*/
export interface DescribeP2PInfoRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
}
/**
* DescribePackageConsumeTasks请求参数结构体
*/
export interface DescribePackageConsumeTasksRequest {
/**
* 分页单页量
*/
Limit: number;
/**
* 分页的偏移量,第一页为0
*/
Offset: number;
}
/**
* DescribeAccount请求参数结构体
*/
export interface DescribeAccountRequest {
/**
* 1设备,2云存,3ai
*/
AccountType: number;
}
/**
* EditFirmware返回参数结构体
*/
export interface EditFirmwareResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFirmwareTaskDistribution请求参数结构体
*/
export interface DescribeFirmwareTaskDistributionRequest {
/**
* 产品ID
*/
ProductID: string;
/**
* 固件版本号
*/
FirmwareVersion: string;
/**
* 固件升级任务ID
*/
TaskId: number;