tencentcloud-sdk-nodejs
Version:
2,861 lines (2,856 loc) • 187 kB
TypeScript
/**
* UpdateDevicesEnableState返回参数结构体
*/
export interface UpdateDevicesEnableStateResponse {
/**
* 删除的结果代码
*/
ResultCode?: string;
/**
* 删除的结果信息
*/
ResultMessage?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
}
/**
* TWeCall设备激活信息
*/
export interface TWeCallActiveInfo {
/**
* 小程序ID
注意：此字段可能返回 null，表示取不到有效值。
* @deprecated
*/
ModelId?: string;
/**
* Sn信息
*/
Sn?: string;
/**
* 过期时间
*/
ExpireTime?: number;
/**
* 类型
*/
PkgType?: number;
}
/**
* GetWechatDeviceTicket请求参数结构体
*/
export interface GetWechatDeviceTicketRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 产品名称
*/
DeviceName: string;
/**
* 是否第三方小程序
*/
IsThirdApp?: number;
/**
* 模板ID
*/
ModelId?: string;
/**
* 小程序APPID
*/
MiniProgramAppId?: string;
}
/**
* DeleteFenceBind请求参数结构体
*/
export interface DeleteFenceBindRequest {
/**
* 围栏Id
*/
FenceId: number;
/**
* 围栏绑定的产品信息
*/
Items: Array<FenceBindProductItem>;
}
/**
* DescribeModelDefinition返回参数结构体
*/
export interface DescribeModelDefinitionResponse {
/**
* 产品数据模板
*/
Model?: ProductModelDefinition;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetGatewaySubDeviceList返回参数结构体
*/
export interface GetGatewaySubDeviceListResponse {
/**
* 设备的总数
*/
Total?: number;
/**
* 设备列表
*/
DeviceList?: FamilySubDevice;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteStudioProduct返回参数结构体
*/
export interface DeleteStudioProductResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDevicePackages请求参数结构体
*/
export interface DescribeDevicePackagesRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 分页拉取数量
*/
Limit: number;
/**
* 分页拉取偏移
*/
Offset: number;
/**
* 用户id
*/
CSUserId?: string;
/**
* 通道id
*/
ChannelId?: number;
}
/**
* ControlDeviceData请求参数结构体
*/
export interface ControlDeviceDataRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义
*/
Data: string;
/**
* 请求类型 , 不填该参数或者 desired 表示下发属性给设备, reported 表示模拟设备上报属性
*/
Method?: string;
/**
* 设备ID，该字段有值将代替 ProductId/DeviceName , 通常情况不需要填写
*/
DeviceId?: string;
/**
* 上报数据UNIX时间戳(毫秒), 仅对Method:reported有效
*/
DataTimestamp?: number;
}
/**
* 设备激活结果数据
*/
export interface DeviceActiveResult {
/**
* 模板ID
注意：此字段可能返回 null，表示取不到有效值。
* @deprecated
*/
ModelId?: string;
/**
* SN信息
*/
Sn?: string;
/**
* 设备激活状态，0：激活成功；50011：系统错误；50012：产品不存在；50013：设备不存在；50014：产品无权限；50015：不是音视频产品；50016：SN格式错误；50017：激活码类型错误；50018：激活次数限频；50019：激活码不足；50020：SN已暂停；
*/
ErrCode?: number;
/**
* 过期时间
*/
ExpireTime?: number;
}
/**
* DeleteLoRaFrequency返回参数结构体
*/
export interface DeleteLoRaFrequencyResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyApplication返回参数结构体
*/
export interface ModifyApplicationResponse {
/**
* 应用信息
*/
Application?: IotApplication;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCsReportCountDataInfo请求参数结构体
*/
export interface DescribeCsReportCountDataInfoRequest {
/**
* 产品id
*/
ProductId: string;
/**
* 设备名
*/
DeviceName: string;
/**
* 统计开始时间戳
*/
StartTime: number;
/**
* 统计结束时间戳
*/
EndTime: number;
/**
* 设备通道
*/
ChannelId?: number;
}
/**
* CreateFreeCloudStorage返回参数结构体
*/
export interface CreateFreeCloudStorageResponse {
/**
* 订单金额，单位为分
*/
Price?: number;
/**
* 支付金额，单位为分
*/
Amount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyPositionFence返回参数结构体
*/
export interface ModifyPositionFenceResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageAIServiceTask请求参数结构体
*/
export interface DescribeCloudStorageAIServiceTaskRequest {
/**
* 任务 ID
*/
TaskId: string;
/**
* 下载 URL 的过期时间。
若传入该参数，则响应中将包含所有文件的下载 URL
*/
FileURLExpireTime?: number;
}
/**
* DescribeCloudStorageThumbnailList请求参数结构体
*/
export interface DescribeCloudStorageThumbnailListRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 缩略图文件名列表
*/
ThumbnailList: Array<string>;
}
/**
* CheckFirmwareUpdate返回参数结构体
*/
export interface CheckFirmwareUpdateResponse {
/**
* 设备当前固件版本。
*/
CurrentVersion?: string;
/**
* 固件可升级版本。
*/
DstVersion?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageUsers返回参数结构体
*/
export interface DescribeCloudStorageUsersResponse {
/**
* 用户总数
*/
TotalCount?: number;
/**
* 用户信息
*/
Users?: Array<CloudStorageUserInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云存上报统计信息
*/
export interface CountDataInfo {
/**
* 视频上报异常次数
*/
VideoExceptionNum?: number;
/**
* 视频上报成功次数
*/
VideoSuccessNum?: number;
/**
* 视频上报成功率
*/
VideoSuccessRate?: string;
/**
* 事件上报异常次数
*/
EventExceptionNum?: number;
/**
* 事件上报成功次数
*/
EventSuccessNum?: number;
/**
* 事件上报成功率
*/
EventSuccessRate?: string;
}
/**
* DescribeCloudStoragePackageConsumeDetails请求参数结构体
*/
export interface DescribeCloudStoragePackageConsumeDetailsRequest {
/**
* 开始日期
*/
StartDate: string;
/**
* 结束日期
*/
EndDate: string;
}
/**
* DescribeActivateLicenseService返回参数结构体
*/
export interface DescribeActivateLicenseServiceResponse {
/**
* 增值服务激活码信息
*/
Data?: Array<LicenseServiceNumInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* wifi定位信息
*/
export interface WifiInfo {
/**
* mac地址
*/
MAC: string;
/**
* 信号强度
*/
RSSI: number;
}
/**
* CreateCloudStorageAIServiceTask请求参数结构体
*/
export 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?: Array<string>;
/**
* 自定义任务 ID
*/
CustomId?: string;
}
/**
* DescribeCloudStorageOrder请求参数结构体
*/
export interface DescribeCloudStorageOrderRequest {
/**
* 订单id
*/
OrderId: string;
}
/**
* DescribeSpaceFenceEventList返回参数结构体
*/
export interface DescribeSpaceFenceEventListResponse {
/**
* 围栏告警事件列表
注意：此字段可能返回 null，表示取不到有效值。
*/
List: Array<FenceEventItem>;
/**
* 围栏告警事件总数
*/
Total: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageEventsWithAITasks返回参数结构体
*/
export interface DescribeCloudStorageEventsWithAITasksResponse {
/**
* 云存事件列表
*/
Events?: Array<CloudStorageEventWithAITasks>;
/**
* 请求上下文, 用作查询游标
*/
Context?: string;
/**
* 拉取结果是否已经结束
*/
Listover?: boolean;
/**
* 内部结果数量，并不等同于事件总数。
*/
Total?: number;
/**
* 视频播放URL
*/
VideoURL?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SearchTopicRule返回参数结构体
*/
export interface SearchTopicRuleResponse {
/**
* 搜索到的规则总数
*/
TotalCnt?: number;
/**
* 规则信息列表
*/
Rules?: Array<TopicRuleInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCloudStorageAIService返回参数结构体
*/
export interface ModifyCloudStorageAIServiceResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDeviceFirmWare请求参数结构体
*/
export interface DescribeDeviceFirmWareRequest {
/**
* 产品ID。
*/
ProductId: string;
/**
* 设备名称。
*/
DeviceName: string;
}
/**
* BindCloudStorageUser请求参数结构体
*/
export interface BindCloudStorageUserRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 用户ID
*/
UserId: string;
}
/**
* ChangeP2PRoute返回参数结构体
*/
export interface ChangeP2PRouteResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateDeviceTWeCallAuthorizeStatus请求参数结构体
*/
export interface UpdateDeviceTWeCallAuthorizeStatusRequest {
/**
* TweCall授权状态：0未授权，1已授权
*/
Status?: number;
/**
* 产品ID
*/
ProductId?: string;
/**
* 设备名
*/
DeviceName?: string;
/**
* 微信用户的openId
*/
WechatOpenId?: string;
}
/**
* CreateProject返回参数结构体
*/
export interface CreateProjectResponse {
/**
* 返回信息
*/
Project: ProjectEntry;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteProject返回参数结构体
*/
export interface DeleteProjectResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTopicPolicy返回参数结构体
*/
export interface CreateTopicPolicyResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDevice返回参数结构体
*/
export interface CreateDeviceResponse {
/**
* 设备参数描述。
*/
Data?: DeviceData;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDevice请求参数结构体
*/
export 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;
}
/**
* InheritCloudStorageUser返回参数结构体
*/
export interface InheritCloudStorageUserResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ChangeP2PRoute请求参数结构体
*/
export interface ChangeP2PRouteRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* P2P线路
*/
RouteId: number;
}
/**
* DescribeDevice返回参数结构体
*/
export interface DescribeDeviceResponse {
/**
* 设备信息
*/
Device?: DeviceInfo;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
}
/**
* GetStudioProductList返回参数结构体
*/
export interface GetStudioProductListResponse {
/**
* 产品列表
*/
Products?: Array<ProductEntry>;
/**
* 产品数量
*/
Total?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetTWeCallActiveStatus请求参数结构体
*/
export interface GetTWeCallActiveStatusRequest {
/**
* 参数已弃用，不用传参
* @deprecated
*/
MiniProgramAppId?: string;
/**
* 设备列表
*/
DeviceList?: Array<TWeCallInfo>;
}
/**
* GetAuthMiniProgramAppList请求参数结构体
*/
export interface GetAuthMiniProgramAppListRequest {
/**
* appId
*/
MiniProgramAppId?: string;
/**
* 页码
*/
Offset?: number;
/**
* 每页大小
*/
Limit?: number;
}
/**
* DescribeFenceEventList请求参数结构体
*/
export interface DescribeFenceEventListRequest {
/**
* 围栏告警信息的查询起始时间，Unix时间，单位为毫秒
*/
StartTime: number;
/**
* 围栏告警信息的查询结束时间，Unix时间，单位为毫秒
*/
EndTime: number;
/**
* 围栏Id
*/
FenceId?: number;
/**
* 翻页偏移量，0起始
*/
Offset?: number;
/**
* 最大返回结果数
*/
Limit?: number;
/**
* 告警对应的产品Id
*/
ProductId?: string;
/**
* 告警对应的设备名称
*/
DeviceName?: string;
}
/**
* ActivateTWeCallLicense返回参数结构体
*/
export interface ActivateTWeCallLicenseResponse {
/**
* 设备激活返回数据
* @deprecated
*/
DeviceList?: Array<DeviceActiveResult>;
/**
* 设备激活失败返回数据
*/
FailureList?: Array<DeviceActiveResult>;
/**
* 设备激活成功返回数据
*/
SuccessList?: Array<DeviceActiveResult>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteTopicPolicy请求参数结构体
*/
export interface DeleteTopicPolicyRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* Topic名称
*/
TopicName: string;
}
/**
* ResetCloudStorageEvent请求参数结构体
*/
export interface ResetCloudStorageEventRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 用户ID
*/
UserId?: string;
/**
* 通道ID
*/
ChannelId?: number;
}
/**
* Topic信息, 包括Topic名字和权限
*/
export interface TopicItem {
/**
* Topic名称
*/
TopicName?: string;
/**
* Topic权限 , 1上报 2下发
*/
Privilege?: number;
}
/**
* GetFamilyDeviceUserList请求参数结构体
*/
export interface GetFamilyDeviceUserListRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
}
/**
* CreateTRTCSignaturesWithRoomId请求参数结构体
*/
export interface CreateTRTCSignaturesWithRoomIdRequest {
/**
* TRTC进房间的用户名称数组，数组元素不可重复，最长不超过 10 个。
*/
TRTCUserIds: Array<string>;
/**
* 房间id
*/
RoomId: string;
}
/**
* DescribeSpaceFenceEventList请求参数结构体
*/
export interface DescribeSpaceFenceEventListRequest {
/**
* 位置空间Id
*/
SpaceId: string;
/**
* 围栏告警信息的查询起始时间，Unix时间，单位为毫秒
*/
StartTime: number;
/**
* 围栏告警信息的查询结束时间，Unix时间，单位为毫秒
*/
EndTime: number;
/**
* 翻页偏移量，0起始
*/
Offset?: number;
/**
* 最大返回结果数
*/
Limit?: number;
}
/**
* 围栏事件详情
*/
export interface FenceEventItem {
/**
* 围栏事件的产品Id
*/
ProductId?: string;
/**
* 围栏事件的设备名称
*/
DeviceName?: string;
/**
* 围栏Id
*/
FenceId?: number;
/**
* 围栏事件的告警类型（In，进围栏报警；Out，出围栏报警；InOrOut，进围栏或者出围栏均报警）
*/
AlertType?: string;
/**
* 围栏事件的设备位置信息
*/
Data?: FenceAlarmPoint;
}
/**
* DescribeUnbindedDevices请求参数结构体
*/
export interface DescribeUnbindedDevicesRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 分页偏移量
*/
Offset: number;
/**
* 分页的页大小
*/
Limit: number;
}
/**
* 已注册通信类型信息
*/
export interface RegisteredDeviceNetTypeInfo {
/**
* 普通设备数
*/
NormalDeviceNum: number;
/**
* 蓝牙设备数
*/
BluetoothDeviceNum: number;
}
/**
* InvokeAISearchService返回参数结构体
*/
export interface InvokeAISearchServiceResponse {
/**
* 基于搜索结果的总结
*/
Summary?: string;
/**
* 视频结果集
*/
Targets?: Array<TargetInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyTWeSeeConfig请求参数结构体
*/
export interface ModifyTWeSeeConfigRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 用户ID
*/
UserId?: string;
/**
* 通道ID
*/
ChannelId?: number;
/**
* 是否开启视频摘要，不传则不修改
*/
EnableSummary?: boolean;
/**
* 是否开启视频搜索，不传则不修改
*/
EnableSearch?: boolean;
/**
* 配置参数，不传则不修改
*/
Config?: string;
}
/**
* DescribeGatewaySubDeviceList请求参数结构体
*/
export interface DescribeGatewaySubDeviceListRequest {
/**
* 网关产品ID
*/
GatewayProductId: string;
/**
* 网关设备名称
*/
GatewayDeviceName: string;
/**
* 分页偏移
*/
Offset: number;
/**
* 分页的大小
*/
Limit: number;
}
/**
* GetDeviceList请求参数结构体
*/
export interface GetDeviceListRequest {
/**
* 需要查看设备列表的产品ID, -1代表ProjectId来筛选
*/
ProductId: string;
/**
* 分页偏移
*/
Offset?: number;
/**
* 分页的大小，数值范围 10-100
*/
Limit?: number;
/**
* 设备固件版本号，若不带此参数会返回所有固件版本的设备。传"None-FirmwareVersion"查询无版本号的设备
*/
FirmwareVersion?: string;
/**
* 需要过滤的设备名称
*/
DeviceName?: string;
/**
* 项目ID。产品 ID 为 -1 时，该参数必填
*/
ProjectId?: string;
/**
* 每次请求的Filters的上限为10，Filter.Values的上限为1。
*/
Filters?: Array<Filter>;
}
/**
* DescribeDeviceDataHistory请求参数结构体
*/
export interface DescribeDeviceDataHistoryRequest {
/**
* 区间开始时间（Unix 时间戳，毫秒级）
*/
MinTime: number;
/**
* 区间结束时间（Unix 时间戳，毫秒级）
*/
MaxTime: number;
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 属性字段名称，对应数据模板中功能属性的标识符
*/
FieldName: string;
/**
* 返回条数
*/
Limit?: number;
/**
* 检索上下文
*/
Context?: string;
}
/**
* DescribeStudioProduct请求参数结构体
*/
export interface DescribeStudioProductRequest {
/**
* 产品ID
*/
ProductId: string;
}
/**
* DescribeCloudStorageThumbnailList返回参数结构体
*/
export interface DescribeCloudStorageThumbnailListResponse {
/**
* 缩略图访问地址
*/
ThumbnailURLInfoList?: Array<ThumbnailURLInfoList>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeletePositionFence请求参数结构体
*/
export interface DeletePositionFenceRequest {
/**
* 位置空间Id
*/
SpaceId: string;
/**
* 围栏Id
*/
FenceId: number;
}
/**
* GetProjectList请求参数结构体
*/
export interface GetProjectListRequest {
/**
* 偏移量
*/
Offset?: number;
/**
* 个数限制
*/
Limit?: number;
/**
* 实例ID
*/
InstanceId?: string;
/**
* 按项目ID搜索
*/
ProjectId?: string;
/**
* 按产品ID搜索
*/
ProductId?: string;
/**
* 加载 ProductCount、DeviceCount、ApplicationCount，可选值：ProductCount、DeviceCount、ApplicationCount，可多选
*/
Includes?: Array<string>;
/**
* 按项目名称搜索
*/
ProjectName?: string;
}
/**
* ModifyPositionSpace请求参数结构体
*/
export interface ModifyPositionSpaceRequest {
/**
* 位置空间Id
*/
SpaceId: string;
/**
* 位置空间名称
*/
SpaceName: string;
/**
* 授权类型
*/
AuthorizeType: number;
/**
* 产品列表
*/
ProductIdList: Array<string>;
/**
* 位置空间描述
*/
Description?: string;
/**
* 缩略图
*/
Icon?: string;
}
/**
* DescribeDeviceBindGateway请求参数结构体
*/
export interface DescribeDeviceBindGatewayRequest {
/**
* 产品Id
*/
ProductId: string;
/**
* 设备名
*/
DeviceName: string;
}
/**
* 项目详情
*/
export interface ProjectEntry {
/**
* 项目ID
*/
ProjectId?: string;
/**
* 项目名称
*/
ProjectName?: string;
/**
* 项目描述
*/
ProjectDesc?: string;
/**
* 创建时间，unix时间戳
*/
CreateTime?: number;
/**
* 更新时间，unix时间戳
*/
UpdateTime?: number;
}
/**
* ModifyProject返回参数结构体
*/
export interface ModifyProjectResponse {
/**
* 项目详情
*/
Project: ProjectEntry;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageThumbnail请求参数结构体
*/
export interface DescribeCloudStorageThumbnailRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 缩略图文件名
*/
Thumbnail: string;
}
/**
* ModifyProductCloudStorageAIService请求参数结构体
*/
export interface ModifyProductCloudStorageAIServiceRequest {
/**
* 产品 ID
*/
ProductId: string;
/**
* 开通状态
*/
Enabled?: boolean;
}
/**
* CreateExternalSourceAIServiceTask请求参数结构体
*/
export interface CreateExternalSourceAIServiceTaskRequest {
/**
* 产品 ID
*/
ProductId: string;
/**
* 云存 AI 服务类型。可选值：
- `RealtimeObjectDetect`：目标检测
- `Highlight`：视频浓缩
- `VideoToText`：视频语义理解
*/
ServiceType: string;
/**
* 分析外部传入的视频 URL 列表，支持 HLS 点播（m3u8）及常见视频格式（mp4 等）
*/
VideoURLs: Array<string>;
/**
* 自定义任务 ID
*/
CustomId?: string;
/**
* 视频分析配置参数
*/
Config?: string;
/**
* 视频分析识别区域
*/
ROI?: string;
}
/**
* GetDeviceSumStatistics返回参数结构体
*/
export interface GetDeviceSumStatisticsResponse {
/**
* 激活设备总数
*/
ActivationCount?: number;
/**
* 在线设备总数
*/
OnlineCount?: number;
/**
* 前一天激活设备数
*/
ActivationBeforeDay?: number;
/**
* 前一天活跃设备数
*/
ActiveBeforeDay?: number;
/**
* 前一周激活设备数
*/
ActivationWeekDayCount?: number;
/**
* 前一周活跃设备数
*/
ActiveWeekDayCount?: number;
/**
* 上一周激活设备数
*/
ActivationBeforeWeekDayCount?: number;
/**
* 上一周活跃设备数
*/
ActiveBeforeWeekDayCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InheritCloudStorageUser请求参数结构体
*/
export interface InheritCloudStorageUserRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 原始用户ID
*/
UserId: string;
/**
* 目标用户ID
*/
ToUserId: string;
}
/**
* ModifyProject请求参数结构体
*/
export interface ModifyProjectRequest {
/**
* 项目ID
*/
ProjectId: string;
/**
* 项目名称
*/
ProjectName: string;
/**
* 项目描述
*/
ProjectDesc: string;
}
/**
* ModifySpaceProperty返回参数结构体
*/
export interface ModifySpacePropertyResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* PauseTWeCallDevice请求参数结构体
*/
export interface PauseTWeCallDeviceRequest {
/**
* 设备列表
*/
DeviceList?: Array<TWeCallInfo>;
}
/**
* DescribeDeviceDataHistory返回参数结构体
*/
export interface DescribeDeviceDataHistoryResponse {
/**
* 属性字段名称，对应数据模板中功能属性的标识符
*/
FieldName?: string;
/**
* 数据是否已全部返回，true 表示数据全部返回，false 表示还有数据待返回，可将 Context 作为入参，继续查询返回结果。
*/
Listover?: boolean;
/**
* 检索上下文，当 ListOver 为false时，可以用此上下文，继续读取后续数据
*/
Context?: string;
/**
* 历史数据结果数组，返回对应时间点及取值。
*/
Results?: Array<DeviceDataHistoryItem>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 设备的用户
*/
export interface DeviceUser {
/**
* 用户ID
*/
UserId?: string;
/**
* 用户角色 1所有者，0：其他分享者
*/
Role?: number;
/**
* 家庭ID，所有者带该参数
*/
FamilyId?: string;
/**
* 家庭名称，所有者带该参数
*/
FamilyName?: string;
}
/**
* 产品模型定义
*/
export interface ProductModelDefinition {
/**
* 产品ID
*/
ProductId?: string;
/**
* 模型定义
*/
ModelDefine?: string;
/**
* 更新时间，秒级时间戳
*/
UpdateTime?: number;
/**
* 创建时间，秒级时间戳
*/
CreateTime?: number;
/**
* 产品所属分类的模型快照（产品创建时刻的）
*/
CategoryModel?: string;
/**
* 产品的连接类型的模型
*/
NetTypeModel?: string;
}
/**
* 围栏详细信息(包含创建时间及更新时间)
*/
export interface PositionFenceInfo {
/**
* 围栏信息
*/
GeoFence?: PositionFenceItem;
/**
* 围栏创建时间
*/
CreateTime?: number;
/**
* 围栏更新时间
*/
UpdateTime?: number;
}
/**
* DeleteDevice返回参数结构体
*/
export interface DeleteDeviceResponse {
/**
* 删除的结果代码
*/
ResultCode?: string;
/**
* 删除的结果信息
*/
ResultMessage?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLoRaFrequency返回参数结构体
*/
export interface ModifyLoRaFrequencyResponse {
/**
* 频点信息
*/
Data?: LoRaFrequencyEntry;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例信息
公共实例过期时间 0001-01-01T00:00:00Z，公共实例是永久有效
*/
export 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;
}
/**
* ListEventHistory返回参数结构体
*/
export interface ListEventHistoryResponse {
/**
* 搜索上下文, 用作查询游标
*/
Context?: string;
/**
* 搜索结果数量
*/
Total?: number;
/**
* 搜索结果是否已经结束
*/
Listover?: boolean;
/**
* 搜集结果集
*/
EventHistory?: Array<EventHistoryItem>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetBatchProductionsList返回参数结构体
*/
export interface GetBatchProductionsListResponse {
/**
* 返回详情信息。
注意：此字段可能返回 null，表示取不到有效值。
*/
BatchProductions: Array<BatchProductionInfo>;
/**
* 返回数量。
*/
TotalCnt: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDeviceFirmwares返回参数结构体
*/
export interface DescribeDeviceFirmwaresResponse {
/**
* 固件信息列表
*/
Firmwares?: Array<DeviceFirmwareInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageUsers请求参数结构体
*/
export interface DescribeCloudStorageUsersRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 分页拉取数量
*/
Limit: number;
/**
* 分页拉取偏移
*/
Offset: number;
}
/**
* TWeCall信息
*/
export interface TWeCallLicenseInfo {
/**
* voip类型
*/
TWeCallType?: string;
/**
* 总数
*/
TotalNum?: number;
/**
* 已使用
*/
UsedNum?: number;
}
/**
* DescribeCloudStorageDate请求参数结构体
*/
export interface DescribeCloudStorageDateRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 用户ID
*/
UserId?: string;
/**
* 通道ID
*/
ChannelId?: number;
}
/**
* DescribeTopicPolicy请求参数结构体
*/
export interface DescribeTopicPolicyRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* Topic名字
*/
TopicName: string;
}
/**
* DescribeDeviceFirmwares请求参数结构体
*/
export interface DescribeDeviceFirmwaresRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名
*/
DeviceName: string;
}
/**
* DeleteDevices请求参数结构体
*/
export interface DeleteDevicesRequest {
/**
* 多个设备标识
*/
DevicesItems: Array<DevicesItem>;
}
/**
* UnbindDevices请求参数结构体
*/
export interface UnbindDevicesRequest {
/**
* 网关设备的产品ID
*/
GatewayProductId: string;
/**
* 网关设备的设备名
*/
GatewayDeviceName: string;
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名列表
*/
DeviceNames: Array<string>;
}
/**
* DeleteCloudStorageEvent返回参数结构体
*/
export interface DeleteCloudStorageEventResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageTime返回参数结构体
*/
export interface DescribeCloudStorageTimeResponse {
/**
* 接口返回数据
*/
Data?: CloudStorageTimeData;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetPositionSpaceList请求参数结构体
*/
export interface GetPositionSpaceListRequest {
/**
* 项目Id
*/
ProjectId: string;
/**
* 翻页偏移量，0起始
*/
Offset: number;
/**
* 最大返回结果数
*/
Limit: number;
}
/**
* DescribeGatewaySubProducts返回参数结构体
*/
export interface DescribeGatewaySubProductsResponse {
/**
* 当前分页的可绑定或解绑的产品信息。
*/
Products?: Array<BindProductInfo>;
/**
* 可绑定或解绑的产品总数
*/
Total?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetDeviceList返回参数结构体
*/
export interface GetDeviceListResponse {
/**
* 返回的设备列表, 注意列表设备的 DevicePsk 为空, 要获取设备的 DevicePsk 请使用 DescribeDevice
*/
Devices?: Array<DeviceInfo>;
/**
* 产品下的设备总数
*/
Total?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageMultiThumbnail返回参数结构体
*/
export interface DescribeCloudStorageMultiThumbnailResponse {
/**
* 缩略图访问地址
*/
ThumbnailURLInfoList?: Array<ThumbnailURLInfoList>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 绑定、未绑定产品详细信息
*/
export interface BindProductInfo {
/**
* 产品ID。
*/
ProductId?: string;
/**
* 产品名称。
*/
ProductName?: string;
/**
* 产品所属项目ID。
*/
ProjectId?: string;
/**
* 物模型类型。
*/
DataProtocol?: number;
/**
* 产品分组模板ID
*/
CategoryId?: number;
/**
* 产品类型
*/
ProductType?: number;
/**
* 连接类型
*/
NetType?: string;
/**
* 状态
*/
DevStatus?: string;
/**
* 产品拥有者名称
*/
ProductOwnerName?: string;
}
/**
* DescribeFreeCloudStorageNum请求参数结构体
*/
export declare type DescribeFreeCloudStorageNumRequest = null;
/**
* DescribeDevicePositionList请求参数结构体
*/
export interface DescribeDevicePositionListRequest {
/**
* 产品标识列表
*/
ProductIdList: Array<string>;
/**
* 坐标类型
*/
CoordinateType?: number;
/**
* 分页偏移
*/
Offset?: number;
/**
* 分页的大小
*/
Limit?: number;
}
/**
* InvokeExternalSourceAIServiceTask返回参数结构体
*/
export interface InvokeExternalSourceAIServiceTaskResponse {
/**
* 任务是否执行完成
*/
Completed?: boolean;
/**
* 任务 ID
*/
TaskId?: string;
/**
* 任务信息
*/
TaskInfo?: CloudStorageAIServiceTask;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateStudioProduct请求参数结构体
*/
export 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;
}
/**
* TransferCloudStorage请求参数结构体
*/
export interface TransferCloudStorageRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 已开通云存的设备名称
*/
DeviceName: string;
/**
* 未开通云存的设备名称
*/
ToDeviceName: string;
/**
* 未开通云存的设备产品ID
*/
ToProductId?: string;
}
/**
* 围栏告警位置点
*/
export interface FenceAlarmPoint {
/**
* 围栏告警时间
*/
AlarmTime?: number;
/**
* 围栏告警位置的经度
*/
Longitude?: number;
/**
* 围栏告警位置的纬度
*/
Latitude?: number;
}
/**
* DescribeFirmware请求参数结构体
*/
export interface DescribeFirmwareRequest {
/**
* 产品ID
*/
ProductID: string;
/**
* 固件版本号
*/
FirmwareVersion: string;
}
/**
* DescribeP2PRoute返回参数结构体
*/
export interface DescribeP2PRouteResponse {
/**
* 当前p2p线路
*/
RouteId?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListTopicPolicy返回参数结构体
*/
export interface ListTopicPolicyResponse {
/**
* Topic列表
*/
Topics?: Array<TopicItem>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GenSingleDeviceSignatureOfPublic返回参数结构体
*/
export interface GenSingleDeviceSignatureOfPublicResponse {
/**
* 设备签名
*/
DeviceSignature: DeviceSignatureInfo;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 围栏绑定的设备信息
*/
export interface FenceBindDeviceItem {
/**
* 设备名称
*/
DeviceName: string;
/**
* 告警条件(In，进围栏报警；Out，出围栏报警；InOrOut，进围栏或者出围栏均报警)
*/
AlertCondition: string;
/**
* 是否使能围栏(true，使能；false，禁用)
*/
FenceEnable: boolean;
/**
* 告警处理方法
*/
Method: string;
}
/**
* DescribeBatchProduction返回参数结构体
*/
export 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）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProductCloudStorageAIService返回参数结构体
*/
export interface DescribeProductCloudStorageAIServiceResponse {
/**
* 开通状态
*/
Enabled?: boolean;
/**
* 当前账号是否可开通
*/
Available?: boolean;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLoRaFrequency请求参数结构体
*/
export interface DescribeLoRaFrequencyRequest {
/**
* 频点唯一ID
*/
FreqId?: string;
}
/**
* DeleteCloudStorageEvent请求参数结构体
*/
export interface DeleteCloudStorageEventRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 事件id
*/
EventId: string;
/**
* 开始时间，unix时间
*/
StartTime: number;
/**
* 结束时间，unix时间
*/
EndTime: number;
/**
* 用户ID
*/
UserId?: string;
/**
* 通道ID
*/
ChannelId?: number;
}
/**
* SearchPositionSpace请求参数结构体
*/
export interface SearchPositionSpaceRequest {
/**
* 项目Id
*/
ProjectId: string;
/**
* 位置空间名字
*/
SpaceName: string;
/**
* 偏移量，从0开始
*/
Offset: number;
/**
* 最大获取数量
*/
Limit: number;
}
/**
* DescribeCloudStorageAIServiceCallback返回参数结构体
*/
export interface DescribeCloudStorageAIServiceCallbackResponse {
/**
* 推送类型。http：HTTP 回调
*/
Type?: string;
/**
* HTTP 回调 URL
*/
CallbackUrl?: string;
/**
* HTTP 回调鉴权 Token
*/
CallbackToken?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindDevices返回参数结构体
*/
export interface BindDevicesResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CallDeviceActionSync返回参数结构体
*/
export interface CallDeviceActionSyncResponse {
/**
* 调用Id
*/
ClientToken?: string;
/**
* 输出参数，取值设备端上报$thing/up/action method为action_reply 的 response字段，物模型协议参考https://cloud.tencent.com/document/product/1081/34916#.E8.AE.BE.E5.A4.87.E8.A1.8C.E4.B8.BA.E8.B0.83.E7.94.A8
*/
OutputParams?: string;
/**
* 返回状态，取值设备端上报$thing/up/action method为action_reply 的 status字段，如果不包含status字段，则取默认值，空字符串，物模型协议参考https://cloud.tencent.com/document/product/1081/34916#.E8.AE.BE.E5.A4.87.E8.A1.8C.E4.B8.BA.E8.B0.83.E7.94.A8
*/
Status?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLoRaGateway请求参数结构体
*/
export interface CreateLoRaGatewayRequest {
/**
* LoRa 网关Id
*/
GatewayId: string;
/**
* 网关名称
*/
Name: string;
/**
* 详情描述
*/
Description: string;
/**
* 位置坐标
*/
Location: LoRaGatewayLocation;
/**
* 位置信息
*/
Position?: string;
/**
* 位置详情
*/
PositionDetails?: string;
/**
* 是否公开
*/
IsPublic?: boolean;
/**
* 频点ID
*/
FrequencyId?: string;
}
/**
* ModifyTopicRule请求参数结构体
*/
export interface ModifyTopicRuleRequest {
/**
* 规则名称
*/
RuleName: string;
/**
* 替换的规则包体
*/
TopicRulePayload: TopicRulePayload;
}
/**
* DescribeFenceBindList返回参数结构体
*/
export interface DescribeFenceBindListResponse {
/**
* 围栏绑定的产品设备列表
*/
List: Array<FenceBindProductItem>;
/**
* 围栏绑定的设备总数
*/
Total: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TransferTWeCallDevice请求参数结构体
*/
export interface TransferTWeCallDeviceRequest {
/**
* sn信息，product_deviceName
*/
TransferInDevice?: string;
/**
* sn信息，product_deviceName
*/
TransferOutDevice?: string;
}
/**
* 套餐包消耗任务列表
*/
export interface PackageConsumeTask {
/**
* 任务id
*/
TaskId?: number;
/**
* 任务创始时间
*/
CreateTime?: string;
/**
* 任务状态，1待处理，2处理中，3已完成
*/
State?: number;
}
/**
* CreateTWeSeeRecognitionTask返回参数结构体
*/
export interface CreateTWeSeeRecognitionTaskResponse {
/**
* 任务 ID
*/
TaskId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UnbindProducts请求参数结构体
*/
export interface UnbindProductsRequest {
/**
* 网关产品ID
*/
GatewayProductId: string;
/**
* 待解绑的子产品ID数组
*/
ProductIds: Array<string>;
}
/**
* CreateCloudStorageAIService请求参数结构体
*/
export 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;
}
/**
* DescribeDeviceLocationSolve返回参数结构体
*/
export interface DescribeDeviceLocationSolveResponse {
/**
* 经度
*/
Longitude?: number;
/**
* 纬度
*/
Latitude?: number;
/**
* 类型
*/
LocationType?: string;
/**
* 误差精度预估，单位为米
*/
Accuracy?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeStudioProduct返回参数结构体
*/
export interface DescribeStudioProductResponse {
/**
* 产品详情
*/
Product?: ProductEntry;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TWeSee 语义理解结果
*/
export interface VisionRecognitionResult {
/**
* 任务状态（1：失败；2：成功但结果为空；3：成功且结果非空）
*/
Status?: number;
/**
* 识别到的目标类型。可能取值：
- `person`：人
- `vehicle`：车辆
- `dog`：狗
- `cat`：猫
- `fire`：火焰
- `smoke`：烟雾
- `package`：快递包裹
- `license_plate`：车牌
*/
DetectedClassifications?: Array<string>;
/**
* 视频摘要文本
*/
Summary?: string;
}
/**
* CreateIotVideoCloudStorage返回参数结构体
*/
export interface CreateIotVideoCloudStorageResponse {
/**
* 订单金额，单位为分
*/
Price?: number;
/**
* 支付金额，单位为分
*/
Amount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePackageConsumeTask返回参数结构体
*/
export interface DescribePackageConsumeTaskResponse {
/**
* 文件下载的url，文件详情是套餐包消耗详情
*/
URL?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CheckFirmwareUpdate请求参数结构体
*/
export interface CheckFirmwareUpdateRequest {
/**
* 产品ID。
*/
ProductId: string;
/**
* 设备名称。
*/
DeviceName: string;
}
/**
* RemoveUserByRoomIdFromTRTC请求参数结构体
*/
export interface RemoveUserByRoomIdFromTRTCRequest {
/**
* 房间id
*/
RoomId: string;
/**
* 用户名称数组，数组元素不可重复，最长不超过 10 个。
*/
TRTCUserIds: Array<string>;
}
/**
* 云存用户信息
*/
export interface CloudStorageUserInfo {
/**
* 用户ID
*/
UserId?: string;
}
/**
* ModifyPositionSpace返回参数结构体
*/
export interface ModifyPositionSpaceResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCloudStorageAIServiceCallback返回参数结构体
*/
export interface ModifyCloudStorageAIServiceCallbackResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 位置点
*/
export interface PositionItem {
/**
* 位置点的时间
*/
CreateTime?: number;
/**
* 位置点的经度
*/
Longitude?: number;
/**
* 位置点的纬度
*/
Latitude?: number;
/**
* 位置点的定位类型
*/
LocationType?: string;
/**
* 位置点的精度预估，单位为米
*/
Accuracy?: number;
}
/**
* CreateFenceBind返回参数结构体
*/
export interface CreateFenceBindResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBindedProducts返回参数结构体
*/
export interface DescribeBindedProductsResponse {
/**
* 当前分页的子产品数组
*/
Products?: Array<BindProductInfo>;
/**
* 绑定的子产品总数量
*/
Total?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 网关坐标
*/
export interface LoRaGatewayLocation {
/**
* 纬度
*/
Latitude: number;
/**
* 精度
*/
Longitude: number;
/**
* 准确度
*/
Accuracy?: number;
/**
* 海拔
*/
Altitude?: number;
}
/**
* ModifyTopicRule返回参数结构体
*/
export interface ModifyTopicRuleResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBatchProduction请求参数结构体
*/
export interface DescribeBatchProductionRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 量产ID
*/
BatchProductionId: string;
}
/**
* DescribeCloudStorageAIServiceTask返回参数结构体
*/
export interface DescribeCloudStorageAIServiceTaskResponse {
/**
* 任务信息
*/
TaskInfo?: CloudStorageAIServiceTask;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* PublishRRPCMessage返回参数结构体
*/
export interface PublishRRPCMessageResponse {
/**
* RRPC消息ID
注意：此字段可能返回 null，表示取不到有效值。
*/
MessageId: number;
/**
* 设备回复的消息内容，采用base64编码
注意：此字段可能返回 null，表示取不到有效值。
*/
PayloadBase64: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云存事件
*/
export interface CloudStorageEvent {
/**
* 事件起始时间（Unix 时间戳，秒级
*/
StartTime: number;
/**
* 事件结束时间（Unix 时间戳，秒级
*/
EndTime: number;
/**
* 事件缩略图
*/
Thumbnail: string;
/**
* 事件ID
*/
EventId: string;
/**
* 事件录像上传状态，Finished: 全部上传成功 Partial: 部分上传成功 Failed: 上传失败
*/
UploadStatus?: string;
/**
* 事件自定义数据
*/
Data?: string;
}
/**
* DescribeInstance返回参数结构体
*/
export interface DescribeInstanceResponse {
/**
* 实例信息
*/
Data?: InstanceDetail;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其