tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,580 lines (2,360 loc) • 85.8 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 动作信息 */
declare interface Action {
/** 动作id */
Id?: number;
/** 动作名 */
Name?: string;
}
/** 详细动作信息 */
declare interface ActionDetail {
/** 动作id */
Id?: number;
/** 动作名称 */
Name?: string;
/** 动作类型 */
ActionType?: string;
/** 动作说明 */
ActionDesc?: string;
/** 消息类型,orgin/custom/model */
MsgType?: string;
/** 消息内容,有效值为x-json:后的字段 */
MsgContent?: string;
/** 创建时间 */
CreateTime?: string;
/** 设备唯一标识 */
WID?: string;
/** 关联故障列表 */
LinkRuleSet?: LinkRule[];
/** 动作下沉配置,有效值为x-json:后的字段 */
SinkConfig?: string;
}
/** 动作对象 */
declare interface ActionObj {
/** 动作id */
Id?: number;
/** 动作名称 */
Name?: string;
/** 动作类型。(app/推送消息至应用-携带空间设备:无,appWithNearbyDevices/推送至应用-携带空间设备:携带,device/推送消息至设备-指定设备,nearbyDevices/推送消息至设备-事件所在范围内的设备,toAlarm/转换为告警,toNotification/转换为通知) */
Type?: string;
/** 动作说明 */
Desc?: string;
/** 消息类型,orgin/custom/model */
MsgType?: string;
/** 消息内容 */
MsgContent?: string;
/** 创建时间 */
CreateTime?: string;
/** 动作下沉配置 */
SinkConfig?: string;
/** 具体应用(appid)/具体设备(DIN/subID) */
ApplyDevice?: string;
}
/** 添加设备信息 */
declare interface AddDeviceInfo {
/** 产品id */
ProductId: number;
/** 设备sn序列号 */
SN: string;
/** 父设备wid,不为空表示导入子设备 */
ParentWID?: string;
/** 密钥来源:0-使用产品密钥 1-使用设备特有的密钥 */
KeySource?: number;
}
/** 行政区划数据结构 */
declare interface AdministrationData {
/** 行政区划编码 */
AdministrationCode?: string;
/** 行政区划名称 */
AdministrationName?: string;
}
/** 告警信息 */
declare interface AlarmInfo {
/** 工作空间id */
WorkspaceId?: number;
/** 告警ID */
Id?: string;
/** 告警状态 */
Status?: string;
/** 告警时间 */
Time?: number;
/** 告警业务类型 */
Type?: string;
/** 告警业务类型名称 */
TypeName?: string;
/** 子告警类型 */
SubType?: string;
/** 子告警类型名称 */
SubTypeName?: string;
/** 告警级别id */
Level?: number;
/** 告警级别名称 */
LevelName?: string;
/** 上报应用appid */
AppId?: number;
/** 设备wid */
WID?: string;
/** 设备名称 */
DeviceName?: string;
/** 空间位置 */
Position?: string;
/** 上报图片 */
ReportImg?: ReportImg;
/** 告警描述 */
Desc?: string;
/** 处理人 */
HandlePersonSet?: HandlerPersonInfo[];
/** 处理记录 */
HandleRecordSet?: HandleRecordInfo[];
/** 扩展信息 */
Extend?: string;
/** 应用扩展字段1 */
ExtendOne?: string;
/** 应用扩展字段2 */
ExtendTwo?: string;
/** 应用透传字段,有效字段为x-json后的字段 */
Echo?: string;
}
/** 告警级别详情 */
declare interface AlarmLevelInfo {
/** 级别id */
LevelId?: number;
/** 级别名称 */
LevelName?: string;
}
/** 告警状态返回结构体 */
declare interface AlarmStatusData {
/** 告警状态ID */
StatusID?: string;
/** 告警状态名称 */
StatusName?: string;
/** 告警状态类型 */
StatusType?: string;
}
/** 告警类型详情信息 */
declare interface AlarmTypeDetailInfo {
/** 告警类型id */
Id?: number;
/** 父节点id */
ParentId?: number;
/** 0-标准告警类型,1-自定义告警类型 */
Type?: number;
/** 告警名称类型 */
Name?: string;
/** 告警类型英文名称 */
EnglishName?: string;
}
/** 告警类型 */
declare interface AlarmTypeInfo {
/** 告警父类型 */
Type: string;
/** 告警子类型(如果传告警子类型,则必传父类型) */
SubType?: string;
}
/** API参数信息 */
declare interface ApiContent {
/** 所属API的id */
Id?: string;
/** 参数名称 */
Name?: string;
/** 参数类型 */
Type?: string;
/** 是否为动态值 */
Dynamic?: boolean;
/** 是否必填 */
Required?: boolean;
/** 参数值 */
Value?: string;
/** 默认值 */
DefaultValue?: string;
}
/** API描述 */
declare interface ApiInfo {
/** API的id */
ApiId?: string;
/** API名称 */
Name?: string;
/** API所属应用的id */
AppId?: string;
/** API所属的项目空间的id */
WorkspaceId?: string;
/** API所属目录的编码 */
PoiCode?: string;
/** 接口分类0. 其他服务 1. IOT服务 2. 空间服务 3.微应用服务 4.场景服务 5.AI算法服务 6.任务算法服务 7.第三方服务 */
Type?: number;
/** 数据授权 0:否 1:是 */
DataAudit?: number;
/** 是否需要申请 0:否 1:是 */
ApplyAudit?: number;
/** API详情 */
Description?: string;
/** API地址 */
Address?: string;
/** 请求方法类型 */
Method?: string;
/** API状态 */
Status?: number;
/** API预览地址 */
PreviewUrl?: string;
/** query参数 */
QueryParams?: ApiContent[];
/** 路径参数 */
PathParams?: ApiContent[];
/** 请求头 */
RequestHeaders?: ApiContent[];
/** 响应头 */
ResponseHeaders?: ApiContent[];
/** 是否为公共空间接口 */
IsCommonSpace?: boolean;
/** 请求体(base64编码) */
Body?: string;
/** 响应体(base64编码) */
ResponseBody?: string;
/** 接口方式 1.http 2消息通知服务 */
Style?: number;
}
/** API列表 */
declare interface ApiInfoList {
/** API列表 */
ApiInfo?: ApiInfo[];
/** 数据总条数 */
TotalCount?: number;
}
/** 应用描述 */
declare interface ApplicationInfo {
/** 应用分配的appId */
ApplicationId?: string;
/** 应用中文名 */
Name?: string;
/** 应用地址 */
Address?: string;
/** 应用logo */
ApplicationLogo?: ApplicationLogo;
/** 应用类型,0:saas应用 1:平台应用 */
Type?: number;
/** engine */
EnglishName?: string;
/** 能源管理应用 */
Description?: string;
}
/** 应用列表 */
declare interface ApplicationList {
/** 应用列表 */
ApplicationInfoList?: ApplicationInfo[];
/** 当前查询条件命中的数据总条数 */
TotalCount?: string;
}
/** 应用logo */
declare interface ApplicationLogo {
/** logo图片对应的fileId */
FileId?: string;
/** logo图片地址 */
Url?: string;
}
/** 应用Token令牌信息 */
declare interface ApplicationTokenInfo {
/** 应用申请调用API的令牌 */
Token?: string;
}
/** 批量新增设备接口返回结果 */
declare interface BatchCreateDeviceRes {
/** 新增成功的设备列表 */
SuccessSet?: CreateDeviceSucceeded[];
/** 新增失败的设备列表 */
FailSet?: CreateDeviceFailed[];
}
/** 批量消息上报结果 */
declare interface BatchReportAppMessageRes {
/** 上报数量 */
TotalElements?: number;
/** 提交数量(推送成功) */
Commit?: number;
/** 消息推送结果列表 */
SpanMap?: ReportMsgRes[];
}
/** 建筑列表响应体 */
declare interface BuildingListRes {
/** 建筑列表 */
BuildingProfileList?: BuildingProfile[];
}
/** 建筑模型信息 */
declare interface BuildingModel {
/** 构件ID */
ElementId?: string;
/** 构件名称 */
ElementName?: string;
/** 模型类型 */
ModelType?: string;
/** 模型URL */
ModelUrl?: string;
}
/** 建模模型信息响应体 */
declare interface BuildingModelRes {
/** 建模模型信息出参 */
Models?: BuildingModel[];
}
/** 建筑概要信息 */
declare interface BuildingProfile {
/** 建筑id */
BuildingId?: string;
/** 建筑名称 */
BuildingName?: string;
/** 空间编码 */
SpaceCode?: string;
/** 经度 */
Longitude?: number;
/** 纬度 */
Latitude?: number;
/** 地址 */
Address?: string;
}
/** 查询建筑信息响应体 */
declare interface BuildingProfileRes {
/** 建筑概要信息 */
BuildingProfile?: BuildingProfile;
}
/** 视频扩展信息结果 */
declare interface CameraExtendInfoRes {
/** 存储方式 (nvr或cosmtav) */
SaveType?: string;
/** 云存储天数(save_type是cosmtav时这个参数才有效) */
SaveDay?: number;
/** 实时分辨率 */
LiveResolution?: number;
/** 历史分辨率 */
HistoryResolution?: number;
}
/** 设备控制结果 */
declare interface ControlDeviceRes {
/** 设备Id */
WID?: string;
/** 指令接受, 0表示成功 */
Code?: number;
/** 控制结果 */
Result?: string;
/** 批量大于1时,可用此seq进行链路追踪 */
Seq?: string;
}
/** 设备控制后返回结果集合 */
declare interface ControlDeviceSet {
/** 设备控制后返回结果集合 */
Set?: ControlDeviceRes[];
}
/** 导入失败设备信息 */
declare interface CreateDeviceFailed {
/** 产品id */
ProductId?: number;
/** 父设备wid,不为空表示导入自设备 */
ParentWID?: string;
/** 失败原因 */
Reason?: string;
/** 设备sn序列号 */
SN?: string;
}
/** 导入成功设备信息 */
declare interface CreateDeviceSucceeded {
/** 产品id */
ProductId?: number;
/** 父设备wid,不为空表示导入自设备 */
ParentWID?: string;
/** 设备编码 */
WID?: string;
/** 设备sn序列号 */
SN?: string;
}
/** 自定义字段 */
declare interface CustomField {
/** 字段id */
Id?: number;
/** 字段内容 */
Val?: string;
}
/** 自定义字段 */
declare interface CustomFieldInfo {
/** 字段id */
Id?: number;
/** 字段key */
Key?: string;
/** 字段名 */
Name?: string;
/** 字段值 */
Val?: string;
}
/** 动作列表查询结果 */
declare interface DescribeActionListRes {
/** 第几页 */
PageNumber?: number;
/** 每页条数 */
PageSize?: number;
/** 总页数 */
TotalPage?: number;
/** 总条数 */
TotalRow?: number;
/** 动作列表查询集合 */
ActionDetailSet?: ActionDetail[];
}
/** 根据Tag获取行政区划列表返回结构 */
declare interface DescribeAdministrationByTagRes {
/** 行政区划列表 */
List?: AdministrationData[];
}
/** 告警级别枚举获取 */
declare interface DescribeAlarmLevelListRes {
/** 告警级别枚举获取数组 */
AlarmLevelSet?: AlarmLevelInfo[];
}
/** 告警列表回包 */
declare interface DescribeAlarmListRes {
/** 第几页 */
PageNumber?: number;
/** 每页条数 */
PageSize?: number;
/** 总页数 */
TotalPage?: number;
/** 总条数 */
TotalRow?: number;
/** 告警列表集合 */
AlarmInfoSet?: AlarmInfo[];
}
/** 告警状态列表返回 */
declare interface DescribeAlarmStatusListRes {
/** 告警状态返回结构 */
List?: AlarmStatusData[];
}
/** 告警类型列表回包 */
declare interface DescribeAlarmTypeListRes {
/** 告警类型查询列表 */
AlarmTypeSet?: AlarmTypeDetailInfo[];
}
/** 设备分组信息 */
declare interface DescribeDeviceGroupListRes {
/** 设备分组list */
List?: DescribeGroupInfo[];
}
/** 设备列表查询结果 */
declare interface DescribeDeviceListRes {
/** 第几页 */
PageNumber?: number;
/** 每页条数 */
PageSize?: number;
/** 总页数 */
TotalPage?: number;
/** 总条数 */
TotalRow?: number;
/** 设备信息集合 */
DeviceDataSet?: DeviceDataInfo[];
}
/** 事件列表查询结果 */
declare interface DescribeEventListRes {
/** 第几页 */
PageNumber?: number;
/** 每页条数 */
PageSize?: number;
/** 总页数 */
TotalPage?: number;
/** 总条数 */
TotalRow?: number;
/** 事件信息列表 */
EventDetailSet?: EventDetail[];
}
/** 分组信息实体类 */
declare interface DescribeGroupInfo {
/** 分组 */
Id?: number;
/** 设备分组名称 */
Name?: string;
/** 分组描述 */
Description?: string;
/** 分组父级ID */
ParentId?: number;
}
/** 联动规则列表查询结果 */
declare interface DescribeLinkRuleListRes {
/** 第几页 */
PageNumber?: number;
/** 每页条数 */
PageSize?: number;
/** 总页数 */
TotalPage?: number;
/** 总条数 */
TotalRow?: number;
/** 联动规则列表 */
LinkRuleSet?: LinkRuleInfo[];
}
/** 设备数据信息 */
declare interface DeviceDataInfo {
/** 设备ID, wid */
WID?: string;
/** 设备名称 */
DeviceName?: string;
/** 设备类型Id */
DeviceTypeCode?: string;
/** 设备类型名称 */
DeviceTypeName?: string;
/** 产品Id */
ProductId?: number;
/** 产品名称 */
ProductName?: string;
/** 产品能力:信令数据、音视频。二进制数值中第0位表示信令数据、第1位表示音视频 。1(信令数据),3(具有信令数据以及音视频能力)。 */
ProductAbility?: number;
/** 设备位置信息 */
SpaceInfoSet?: DeviceSpaceInfo[];
/** 模型id */
ModelId?: string;
/** 模型名称 */
ModelName?: string;
/** 设备标签名,非必填 */
DeviceTagSet?: string[];
/** 激活状态(1激活、0未激活) */
IsActive?: number;
/** 激活时间 */
ActiveTime?: string;
/** 推流状态(推流中、未推流) 仅摄像机有的状态 */
IsLive?: boolean;
/** 设备所属父设备id(子设备才有) */
ParentWID?: string;
/** 设备所有父设备名称(子设备才有) */
ParentWIDName?: string;
/** 序列号 */
SN?: string;
/** 设备点位坐标值 */
Location?: DeviceLocation;
/** 自定义字段 */
FieldList?: CustomFieldInfo[];
/** 分组信息 */
GroupInfo?: string;
/** 通信在/离线状态(online=normal+fault,offline) */
DeviceStatus?: string;
/** 设备业务状态(normal、fault、offline) */
Status?: string;
}
/** 设备点位坐标值 */
declare interface DeviceLocation {
/** 点位X坐标值 */
X?: number;
/** 点位Y坐标值 */
Y?: number;
/** 点位Z坐标值 */
Z?: number;
}
/** 设备修改信息入参 */
declare interface DeviceModifyInfo {
/** 设备id */
WID: string;
/** 修改后的设备名字 */
DeviceName: string;
}
/** 设备影子信息 */
declare interface DeviceShadowInfo {
/** 设备ID */
WID?: string;
/** 设备影子数据,返回有效数据为"x-json:"后字段 */
DeviceShadow?: string;
/** 设备影子更新时间 */
DeviceShadowUpdateTime?: string;
}
/** 设备影子查询列表 */
declare interface DeviceShadowRes {
/** 第几页 */
PageNumber?: number;
/** 每页条数 */
PageSize?: number;
/** 总页数 */
TotalPage?: number;
/** 总条数 */
TotalRow?: number;
/** 设备影子列表 */
Set?: DeviceShadowInfo[];
}
/** 设备位置信息 */
declare interface DeviceSpaceInfo {
/** 空间Id */
Id?: string;
/** 空间名字 */
Name?: string;
/** 空间级别 */
Level?: number;
/** 空间编码 */
Code?: string;
}
/** 设备挂接的空间信息 */
declare interface DeviceSpaceInfoRes {
/** 建筑id */
BuildingId?: string;
/** 构件id */
ElementId?: string;
/** 构件类型 */
EntityType?: string;
/** 构件名称 */
ElementName?: string;
/** 构件级别 */
Level?: number;
/** 底部标高(单位mm) */
BottomHeight?: number;
/** 空间编码 */
SpaceCode?: string;
}
/** 设备状态信息 */
declare interface DeviceStatusInfo {
/** 设备ID */
WID?: string;
/** 设备状态(online=normal+fault、offline) */
DeviceStatus?: string;
/** 设备状态更新时间 */
DeviceStatusUpdateTime?: string;
/** 设备业务状态(normal、fault、offline) */
Status?: string;
/** 推流状态。推流中-true,未推流-false */
IsAlive?: boolean;
}
/** 设备状态获取接口结果 */
declare interface DeviceStatusRes {
/** 第几页 */
PageNumber?: number;
/** 每页条数 */
PageSize?: number;
/** 总页数 */
TotalPage?: number;
/** 总条数 */
TotalRow?: number;
/** 设备状态信息列表 */
DeviceStatusSet?: DeviceStatusInfo[];
}
/** 设备状态统计结果 */
declare interface DeviceStatusStatRes {
/** 工作空间Id */
WorkspaceId?: number;
/** 汇总数。在线(正常+故障) + 离线 */
Total?: number;
/** 正常数 */
NormalSum?: number;
/** 离线数 */
OfflineSum?: number;
/** 故障数 */
FaultSum?: number;
/** 设备类型概览列表 */
DeviceTypeOverviewSet?: DeviceTypeOverview[];
/** 设备类型统计列表 */
StatLevelSet?: StatLevel[];
}
/** 设备标签信息 */
declare interface DeviceTagInfo {
/** 标签Id */
TagId?: number;
/** 标签名字 */
TagName?: string;
}
/** 设备标签列表查询结果 */
declare interface DeviceTagRes {
/** 第几页 */
PageNumber?: number;
/** 每页条数 */
PageSize?: number;
/** 总页数 */
TotalPage?: number;
/** 总条数 */
TotalRow?: number;
/** 设备标签列表 */
Set?: DeviceTagInfo[];
}
/** 设备类型 */
declare interface DeviceType {
/** 设备类型编码 */
Code?: string;
/** 设备类型名称 */
Name?: string;
/** 父设备类型编码 */
ParentCode?: string;
/** 父设备类型名称 */
ParentName?: string;
/** 是否子系统,1是 */
IsSubsystem?: number;
}
/** 设备类型概览信息 */
declare interface DeviceTypeOverview {
/** 设备类型值 */
DeviceType?: string;
/** 设备类型名称 */
Name?: string;
/** 汇总数。在线(正常+故障) + 离线 */
Total?: number;
/** 正常数 */
Normal?: number;
/** 离线数 */
Offline?: number;
/** 故障数 */
Fault?: number;
}
/** 设备类型列表 */
declare interface DeviceTypeSet {
/** 设备类型列表 */
Set?: DeviceType[];
}
/** 构件地理坐标 */
declare interface ElementCoordinates {
/** 经度 */
Longitude?: number;
/** 纬度 */
Latitude?: number;
/** 高程 */
Altitude?: number;
}
/** 构件概要信息 */
declare interface ElementProfile {
/** 建筑id */
BuildingId?: string;
/** 构件id */
ElementId?: string;
/** 构件类型 */
EntityType?: string;
/** 构件名称 */
ElementName?: string;
/** 构件空间级别 */
Level?: number;
/** 底部标高(单位mm) */
BottomHeight?: number;
/** 排序 */
Sort?: number;
/** 空间编码 */
SpaceCode?: string;
/** 空间分类编码 */
SpaceTypeCode?: string;
/** 空间分类名称 */
SpaceTypeName?: string;
/** 父级构件id */
ParentElementId?: string;
/** 空间层级类型编码 */
SpacePoiId?: string;
/** 构件描述 */
ElementDesc?: string;
/** 删除标记 */
IsDelete?: number;
}
/** 构件分页查询响应体 */
declare interface ElementProfilePageRes {
/** 构件总数 */
TotalCount?: number;
/** 构件列表 */
List?: ElementProfile[];
}
/** 构件树节点信息 */
declare interface ElementProfileTreeNode {
/** 构件概要信息 */
ElementProfile?: ElementProfile;
/** 子节点信息 */
Children?: ElementProfileTreeNode[];
}
/** 构件树响应体 */
declare interface ElementProfileTreeRes {
/** 建筑id */
BuildingId?: string;
/** 父级构件id */
ParentElementId?: string;
/** 构件树 */
Root?: ElementProfileTreeNode;
}
/** 构件属性信息 */
declare interface ElementProperty {
/** 属性名称 */
Name?: string;
/** 属性描述 */
Description?: string;
/** 属性内容 */
Content?: string;
}
/** 构件属性信息响应体 */
declare interface ElementPropertyRes {
/** 建筑id */
BuildingId?: string;
/** 构件id */
ElementId?: string;
/** 构件属性集合 */
PropertySet?: ElementProperty[];
/** 构件地理坐标 */
Coordinates?: ElementCoordinates;
/** 构件偏移量 */
Translate?: ElementTranslate;
/** 构件名称 */
ElementName?: string;
/** 构件类型代码 */
EntityTypeCode?: string;
/** 构件类型名称 */
EntityTypeName?: string;
}
/** 构件平移信息 */
declare interface ElementTranslate {
/** X方向偏移量 */
X?: number;
/** Y方向偏移量 */
Y?: number;
/** Z方向偏移量 */
Z?: number;
}
/** 空结果返回 */
declare interface EmptyRes {
/** 返回请求状态,成功ok,失败error */
Msg?: string;
}
/** 事件信息 */
declare interface Event {
/** 事件id或动作Id */
Id?: number;
/** 事件名称或动作名称 */
Name?: string;
}
/** 事件详细信息 */
declare interface EventDetail {
/** 事件id */
Id?: number;
/** 事件名 */
Name?: string;
/** 事件触发类型 */
TriggerType?: string;
/** 事件触发条件,返回为x-json后的字段 */
TriggerCondition?: string;
/** 有效期 */
ValidPeriod?: string;
/** 关联规则列表 */
LinkRuleSet?: LinkRule[];
/** 创建时间 */
CreateTime?: string;
/** 设备类型,当触发类型为deviceType时返回 */
DeviceType?: string;
/** 设备的wid,当触发类型是device返回 */
WID?: string;
}
/** 事件对象 */
declare interface EventObj {
/** 事件id */
Id?: number;
/** 事件名称 */
Name?: string;
/** 事件触发类型名称 */
Type?: string;
/** 时间触发条件 */
Condition?: string;
}
/** 文件下载URL */
declare interface FileDownloadURL {
/** 下载地址 */
FileURL?: string;
}
/** 文件信息 */
declare interface FileInfo {
/** 文件id */
FileId?: string;
/** 名称 */
ReportName?: string;
}
/** 获取文件上传URL接口回包 */
declare interface FileUploadURL {
/** 上传地址 */
UploadURL?: string;
/** 文件Id */
FileId?: string;
/** 下载地址 */
DownloadURL?: string;
}
/** 告警处理记录 */
declare interface HandleRecordInfo {
/** 告警处理记录id */
Id?: number;
/** 描述 */
Description?: string;
/** 名称 */
Name?: string;
/** 操作类型 */
OperationType?: string;
/** 处理时间 */
Time?: string;
/** 类型 */
Type?: string;
/** 文件列表 */
FileSet?: FileInfo[];
/** 应用appid */
AppId?: number;
/** 扩展字段1,存非孪生中台用户id */
ExtendOne?: string;
}
/** 告警处理人列表 */
declare interface HandlerPersonInfo {
/** 用户id */
Id?: string;
/** 用户名 */
Name?: string;
}
/** 关联规则信息 */
declare interface LinkRule {
/** 关联联动规则id */
Id?: number;
/** 关联联动规则名字 */
Name?: string;
}
/** 联动规则信息 */
declare interface LinkRuleInfo {
/** 联动id */
Id?: number;
/** 联动名称 */
Name?: string;
/** 事件列表 */
EventSet?: Event[];
/** 动作列表 */
ActionSet?: Action[];
/** 状态:0开,-1关 */
Status?: number;
/** 起始时间 */
BeginDate?: string;
/** 结束时间 */
EndDate?: string;
/** 有效周期内容,有效字段为x-json后的字段 */
ValidPeriod?: string;
}
/** 上报消息概要 */
declare interface MessageProfile {
/** 应用类型 */
AppType: string;
/** 模型Id */
ModelId?: string;
/** 设备类型 */
PoiCode?: string;
}
/** 模型基础信息 */
declare interface ModelInfo {
/** 工作空间id */
WorkspaceId?: number;
/** 模型名称 */
ModelName?: string;
/** 物模型id */
ModelId?: string;
/** 关联产品信息 */
RelatedProduct?: RelatedProduct[];
/** 设备类型名 */
DeviceTypeName?: string;
/** 设备类型id */
DeviceType?: string;
/** 物模型类型,产品模型/标准模型 */
ModelType?: number;
/** 模型参数内容,有效字段为"x-json:"后的字段 */
ModelParams?: string;
}
/** 模型列表查询结果 */
declare interface ModelSet {
/** 第几页 */
PageNumber?: number;
/** 每页条数 */
PageSize?: number;
/** 总页数 */
TotalPage?: number;
/** 总条数 */
TotalRow?: number;
/** 模型基础信息 */
Set?: ModelInfo[];
}
/** 设备自定义值修改信息入参 */
declare interface ModifyDeviceFieldInfo {
/** 设备id */
WID: string;
/** 自定义字段key */
Key: string;
/** 自定义字段值 */
Val: string;
}
/** 设备组修改信息入参 */
declare interface ModifyDeviceGroupInfo {
/** 设备id */
WID: string;
/** 设备分组id */
GroupId: number;
}
/** 设备标签修改信息入参 */
declare interface ModifyDeviceTagInfo {
/** 设备id */
WID: string;
/** 设备标签名称集合 */
NameSet: string[];
}
/** 处理记录项 */
declare interface ProcessRecordInfo {
/** 告警的id */
Id: string;
/** 处理时间,毫秒 */
ProcessTime: number;
/** 处理类型,此处操作类型固定填add_record */
ProcessType: string;
/** 注:此字段填写的是孪生中台的用户,非孪生中台用户不填该字段[{\"id\":\"123\",\"name\":\"tes\"}] */
Processor?: string;
/** 处理描述信息 */
ProcessDescription?: string;
/** 附加文件标识 */
AttachedFileId?: string;
}
/** 产品信息 */
declare interface ProductInfo {
/** 工作空间id */
WorkspaceId?: number;
/** 产品PID */
ProductId?: number;
/** 产品名称 */
ProductName?: string;
/** 设备类型 */
DeviceTypeName?: string;
/** 设备类型id */
DeviceTypeId?: string;
/** 产品属性,如:网关(1)、直连设备(2)、子设备(3) */
Attribute?: number;
/** 产品型号 */
ProductType?: string;
/** 产品能力:信令数据、音视频。二进制数值中第0位表示信令数据、第1位表示音视频 。1(信令数据),3(具有信令数据以及音视频能力)。 */
ProductAbility?: number;
/** 生产厂商 */
Manufacturer?: string;
/** 维保厂商 */
MaintenanceMfr?: string;
/** 物模型名称 */
ModelName?: string;
/** 物模型id */
ModelId?: string;
/** 物模型类型,产品模型/标准模型 */
ModelType?: number;
}
/** 产品列表查询结果 */
declare interface ProductSet {
/** 第几页 */
PageNumber?: number;
/** 每页条数 */
PageSize?: number;
/** 总页数 */
TotalPage?: number;
/** 总条数 */
TotalRow?: number;
/** 产品信息列表 */
Product?: ProductInfo[];
}
/** 视频流Raw协议信息 */
declare interface RawInfo {
/** 加密向量(如果视频网关选择流为非加密传输这个参数可忽略) */
SM4Vector?: string;
/** 专线ip (非专线接入可忽略) */
NATIP?: string;
/** 客户端握手鉴权参数 */
StreamToken?: string;
/** 拉流端口 */
Port?: number;
/** 视频流加密key,目前为AES128加密KEY(如果视频网关选择流为非加密传输这个参数可忽略) */
StreamEnKey?: string;
/** 拉流公网地址(非公网接入时,这个地址是内网地址) */
IP?: string;
/** 拉流内网地址 */
InnerIP?: string;
}
/** 录像信息 */
declare interface RecordInfo {
/** 本录像片段开始时间(s) */
StartTime?: number;
/** 本录像片段结束时间(s) */
EndTime?: number;
/** 录像片段文件url */
VideoURL?: string;
}
/** 关联产品信息 */
declare interface RelatedProduct {
/** 关联产品pid */
Id?: number;
/** 关联产品名字 */
Name?: string;
}
/** 单条消息上报请求 */
declare interface ReportAppMessage {
/** 工作空间Id */
WorkspaceId: number;
/** 消息定义 */
Profile?: MessageProfile;
/** 数据上报时间 */
ReportTs?: number;
/** 属性定义 - KV,若为json格式,需在前加上x-json:,有效字段为x-json:后的字段 */
Properties?: string;
/** 事件定义 - KKV,若为json格式,需在前加上x-json:,有效字段为x-json:后的字段 */
EventSet?: string;
/** 服务定义 - KKV,若为json格式,需在前加上x-json:,有效字段为x-json:后的字段 */
ServiceSet?: string;
/** 扩展字段2,如:算法上报id,若为json格式,需在前加上x-json: */
ExtendTwo?: string;
/** 透传信息,若为json格式,需在前加上x-json:,有效字段为x-json:后的字段 */
Echo?: string;
}
/** 上报图片列表 */
declare interface ReportImg {
/** 类型 */
Type?: number;
/** 数据 */
Data?: string;
}
/** 上报消息结果 */
declare interface ReportMsgRes {
/** 上报消息对应下标的16位标识Id, 即第几个消息 */
ReportId?: string;
/** 上报消息结果,1表示成功推送,0表示推送失败 */
ReportStatus?: number;
}
/** 规则详情查询结果 */
declare interface RuleDetailRes {
/** 联动id */
RuleId?: number;
/** 联动名称 */
RuleName?: string;
/** 联动说明 */
RuleDesc?: string;
/** 1 全天有效,0:固定时间段有效 */
ValidType?: number;
/** 有效期,json字符串(全天有效时为空) */
ValidPeriod?: string;
/** 起始时间 */
BeginDate?: string;
/** 结束时间 */
EndDate?: string;
/** 启用状态。1-启用,0-停用 */
Status?: number;
/** 触发规则,事件的组合 */
EventRule?: string;
/** 事件对象集合 */
EventInfoSet?: EventObj[];
/** 动作对象集合 */
ActionInfoSet?: ActionObj[];
}
/** 保存or修改设备分组回包 */
declare interface SaveDeviceGroupRes {
/** 保存or修改设备分组回包信息 */
Id?: number;
}
/** 场景信息 */
declare interface SceneInfo {
/** 场景id */
SceneId?: string;
/** 场景名称 */
SceneName?: string;
/** 场景版本 */
Version?: string;
}
/** 场景列表响应体 */
declare interface SceneListRes {
/** 场景列表 */
SceneList?: SceneInfo[];
}
/** 查询项目空间楼栋数量与建筑面积响应体 */
declare interface SpaceDataListStatsRes {
/** 楼栋数量与建筑面积列表 */
List?: SpaceDataStats[];
}
/** 项目空间楼栋数量与建筑面积出参 */
declare interface SpaceDataStats {
/** 工作空间ID */
WorkspaceId?: string;
/** 工作空间名称 */
WorkspaceName?: string;
/** 楼栋数量 */
BuildingCount?: number;
/** 建筑面积 */
BuildingArea?: number;
}
/** 查询租户楼栋数量和楼栋建筑面积相应体 */
declare interface SpaceDataTotalStatsRes {
/** 总楼栋数量 */
BuildingCount?: number;
/** 总建筑面积 */
BuildingArea?: number;
}
/** 查询指定空间id列表响应 */
declare interface SpaceDeviceIdListRes {
/** 设备id列表 */
DeviceIds?: string[];
}
/** 设备-空间绑定关系 */
declare interface SpaceDeviceRelation {
/** 设备id */
DeviceId?: string;
/** 构件id */
ElementId?: string;
}
/** 设备-空间绑定关系响应体 */
declare interface SpaceDeviceRelationRes {
/** 设备空间绑定关系列表 */
SpaceDeviceRelationList?: SpaceDeviceRelation[];
}
/** 项目空间详细信息 */
declare interface SpaceInfo {
/** 项目空间id */
WorkspaceId?: number;
/** 租户id */
TenantId?: number;
/** 英文名 */
EnglishName?: string;
/** 中文名 */
ChineseName?: string;
/** 项目空间描述 */
Description?: string;
/** 项目空间状态:0 启用 1 停用 -1 已删除 */
Status?: number;
/** 是否是公共空间 */
IsCommWorkspace?: boolean;
/** 有效期开始时间 */
ValidityStartTime?: string;
/** 有效期结束时间 */
ValidityEndTime?: string;
/** 选中状态 */
Selected?: number;
/** 系统生成状态 */
IsSystem?: number;
}
/** 空间层级关系 */
declare interface SpaceRelation {
/** 构件id */
ElementId?: string;
/** 构件名称 */
ElementName?: string;
/** 空间层级 */
Level?: number;
/** 空间编码 */
SpaceCode?: string;
/** 父级空间编码 */
ParentSpaceCode?: string;
/** 子构件信息 */
Children?: SpaceRelation[];
}
/** 空间层级关系响应体 */
declare interface SpaceRelationRes {
/** 空间层级关系 */
SpaceRelation?: SpaceRelation;
}
/** 空间分类 */
declare interface SpaceType {
/** 空间分类编码 */
SpaceTypeCode?: string;
/** 空间分类名称 */
SpaceTypeName?: string;
}
/** 空间分类列表响应体 */
declare interface SpaceTypeListRes {
/** 空间分类列表 */
SpaceTypeList?: SpaceType[];
}
/** 部门用户 */
declare interface SsoDepartment {
/** 部门ID */
DepartmentId?: string;
/** 部门名称 */
Name?: string;
/** 父级部门ID */
ParentDepartmentId?: string;
}
/** 部门用户结果 */
declare interface SsoDepartmentsResult {
/** 总数 */
Total?: number;
/** 部门列表 */
Departments?: SsoDepartment[];
}
/** 部门用户 */
declare interface SsoTeamUser {
/** 用户ID */
UserId?: string;
/** 用户名称 */
RealName?: string;
/** 用户类型,1-超级管理员;2-1号管理员;3-普通管理员;99-普通用户 */
UserType?: string;
/** 所属租户ID */
TenantId?: string;
/** 邮箱 */
Email?: string;
/** 电话 */
Phone?: string;
/** 用户状态 */
Status?: number;
/** 创建时间 */
CreateAt?: number;
/** 部门ID */
DepartmentId?: string;
/** 部门名称 */
DepartmentName?: string;
/** 是否关联权限 */
LinkFilter?: number;
}
/** 空间用户结果 */
declare interface SsoTeamUserResult {
/** 总数 */
Total?: number;
/** 部门用户列表 */
Users?: SsoTeamUser[];
}
/** 用户结果 */
declare interface SsoUser {
/** 用户ID */
UserId?: string;
/** 用户昵称 */
UserName?: string;
/** 用户名称 */
RealName?: string;
/** 用户类型,1-超级管理员;2-1号管理员;3-普通管理员;99-普通用户 */
UserType?: string;
/** 所属租户ID */
TenantId?: string;
/** 所属组ID */
UserGroup?: string;
/** 邮箱 */
Email?: string;
/** 电话 */
Phone?: string;
/** 用户状态,0待审核,1正常启用,2禁用 */
Status?: number;
/** 创建时间 */
CreateAt?: number;
/** 更新时间 */
UpdateAt?: number;
/** 是否属于团队,0不可用,1属于,2不属 */
BelongTeam?: number;
/** 部门ID */
DepartmentId?: string;
/** 部门名称 */
DepartmentName?: string;
/** 子账户ID */
DepartmentUserId?: number;
/** 密码 */
Password?: string;
}
/** 租户人员结果 */
declare interface SsoUserResult {
/** 总数 */
Total?: number;
/** 租户人员数据 */
Users?: SsoUser[];
}
/** 设备类型统计 */
declare interface StatDeviceType {
/** 汇总数。在线(正常+故障) + 离线 */
Total?: number;
/** 正常数 */
Normal?: number;
/** 离线数 */
Offline?: number;
/** 故障数 */
Fault?: number;
/** 设备名 */
Name?: string;
/** 设备类型 */
DeviceType?: string;
}
/** 层级统计 */
declare interface StatLevel {
/** 汇总数。在线(正常+故障) + 离线 */
Total?: number;
/** 正常数 */
NormalSum?: number;
/** 离线数 */
OfflineSum?: number;
/** 故障数 */
FaultSum?: number;
/** 空间id */
SpaceCode?: string;
/** 设备类型统计列表 */
StatDeviceTypeSet?: StatDeviceType[];
}
/** 云录像接口结果 */
declare interface VideoCloudRecordRes {
/** 录像信息总数 */
TotalCount?: number;
/** 录像信息列表 */
RecordSet?: RecordInfo[];
}
/** 视频流查询结果 */
declare interface VideoRecordStreamRes {
/** FLV协议格式视频流 */
FLV?: string;
/** RTMP协议格式视频流 */
RTMP?: string;
/** HLS协议格式视频流 */
HLS?: string;
/** WebRtc协议格式视频流 */
WebRTC?: string;
/** RAW协议格式视频流 */
RAW?: RawInfo;
/** 视频流的唯一标识 */
Stream?: string;
}
/** 项目空间列表 */
declare interface WorkspaceInfoList {
/** 项目空间列表 */
List?: SpaceInfo[];
}
declare interface AddAlarmProcessRecordRequest {
/** 处理记录项 */
RecordSet: ProcessRecordInfo[];
/** 工作空间id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
/** 非孪生平台外部应用appid */
ApplicationId?: number;
/** 此字段填写的是非孪生中台的用户id(多个用逗号分隔),如果是非孪生中台用户必填该字段 */
ExtendOne?: string;
}
declare interface AddAlarmProcessRecordResponse {
/** 添加告警处理记录结果 */
Result?: EmptyRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BatchCreateDeviceRequest {
/** 工作空间Id */
WorkspaceId: number;
/** 设备信息项 */
AddDeviceSet: AddDeviceInfo[];
/** 应用token */
ApplicationToken: string;
}
declare interface BatchCreateDeviceResponse {
/** 批量新增设备返回结果 */
Result?: BatchCreateDeviceRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BatchDeleteDeviceRequest {
/** 工作空间id */
WorkspaceId: number;
/** 设备wid数组列表 */
WIDSet: string[];
/** 应用token */
ApplicationToken: string;
}
declare interface BatchDeleteDeviceResponse {
/** 返回请求结果 */
Result?: EmptyRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BatchKillAlarmRequest {
/** 告警开始时间,必填,时间戳秒 */
BeginTime: number;
/** 告警结束时间,必填,时间戳秒 */
EndTime: number;
/** 告警状态: unprocessed processing */
StatusSet: string[];
/** 工作空间id */
WorkspaceId: number;
/** 当前操作用户id */
UserId: string;
/** 当前操作用户名称 */
UserName: string;
/** 应用token */
ApplicationToken: string;
/** 当前告警处理人,填孪生中台用户id,多个用逗号分隔 */
ProcessorId?: string;
/** 告警子类型(如果传告警子类型,则必传父类型) */
AlarmTypeSet?: AlarmTypeInfo[];
/** 告警级别,包括1~5 */
LevelSet?: number[];
/** 设备id */
WIDSet?: string[];
/** 告警id */
IdSet?: string[];
/** 告警处理的说明 */
Desc?: string;
}
declare interface BatchKillAlarmResponse {
/** 批量消警结果 */
Result?: EmptyRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BatchReportAppMessageRequest {
/** 工作空间Id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
/** 消息上报请求列表 */
ReportSet?: ReportAppMessage[];
}
declare interface BatchReportAppMessageResponse {
/** 批量消息上报结果 */
Result?: BatchReportAppMessageRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ChangeAlarmStatusRequest {
/** 告警的id,返回的列表中的id */
Id: string;
/** 告警状态 processed unprocessed processing misreport shield */
Status: string;
/** 告警处理时间 */
ProcessTime: number;
/** 处理类型 */
ProcessType: string;
/** 工作空间id */
WorkspaceId: number;
/** 当前操作用户id */
UserId: string;
/** 当前操作用户名称 */
UserName: string;
/** 应用token */
ApplicationToken: string;
/** 平台告警处理人 */
Processor?: string;
/** 告警处理的描述信息 */
ProcessDescription?: string;
/** 告警处理的扩展信息,可以为JSON字符串 */
ProcessExtend?: string;
/** 扩展字段1,目前存的应用告警处理人 */
ExtendOne?: string;
/** 应用id */
ApplicationId?: number;
}
declare interface ChangeAlarmStatusResponse {
/** 返回空结果 */
Result?: EmptyRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ControlCameraPTZRequest {
/** 设备的唯一标识 */
WID: string;
/** ptz指令left - 向左移动right - 向右移动up - 向上移动down - 向下zoomOut - 镜头缩小zoomIn - 镜头放大irisIn - 光圈缩小irisOut - 光圈放大focusIn - 焦距变近focusOut - 焦距变远 */
CMD: string;
/** 工作空间Id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
}
declare interface ControlCameraPTZResponse {
/** 控制摄像头结果返回 */
Result?: EmptyRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ControlDeviceRequest {
/** 工作空间id */
WorkspaceId: number;
/** 设备wid,最大100个 */
WIDSet: string[];
/** 控制内容 */
ControlData: string;
/** 应用token */
ApplicationToken: string;
/** 是否同步返回设备下控ack结果 */
IsSynchronized?: boolean;
}
declare interface ControlDeviceResponse {
/** 设备控制后结果集 */
Result?: ControlDeviceSet;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateApplicationTokenRequest {
/** 应用id */
ApplicationId: number;
/** 一个随机数或者时间戳,用于防止重放攻击,每个请求唯一,建议用uuid */
Nonce: string;
/** 租户id */
TenantId: number;
/** 请求时间,当前时间的unix毫秒时间戳 */
RequestTime: number;
/** 签名方法见用户使用文档 */
Signature: string;
}
declare interface CreateApplicationTokenResponse {
/** 应用令牌信息 */
Result?: ApplicationTokenInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteDeviceGroupRequest {
/** 设备分组的id */
Id: number;
/** 工作空间的id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
}
declare interface DeleteDeviceGroupResponse {
/** 无返回信息 */
Result?: EmptyRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeActionListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 分页查询,第几页,必传,大于0 */
PageNumber: number;
/** 每页条数,必传大于0 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
/** 动作类型,(app,device,toAlarm,toNotification) */
ActionType?: string;
/** 事件id详情 */
IdSet?: number[];
}
declare interface DescribeActionListResponse {
/** 动作列表查询结果 */
Result?: DescribeActionListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAdministrationByTagRequest {
/** 应用token */
ApplicationToken: string;
/** 工作空间ID */
WorkspaceId: number;
/** 标签值 */
Tag: string;
}
declare interface DescribeAdministrationByTagResponse {
/** 行政区划返回结构 */
Result?: DescribeAdministrationByTagRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAlarmLevelListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeAlarmLevelListResponse {
/** 告警级别列表查询结果 */
Result?: DescribeAlarmLevelListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAlarmListRequest {
/** 告警开始时间,必填,时间戳秒 */
BeginTime: number;
/** 告警结束时间,必填,时间戳秒 */
EndTime: number;
/** 分页查询,第几页 */
PageNumber: number;
/** 每页条数 */
PageSize: number;
/** 工作空间id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
/** 告警状态 */
Statuses?: string[];
/** 告警类型 */
AlarmTypeSet?: AlarmTypeInfo[];
/** 告警级别id */
LevelSet?: number[];
/** 告警id */
IdSet?: string[];
/** 应用id */
AppIdSet?: number[];
/** 设备id */
WIDSet?: string[];
/** 空间层级 */
SpaceCodeSet?: string[];
/** 应用扩展字段1 */
ExtendOne?: string[];
/** 应用扩展字段2 */
ExtendTwo?: string[];
/** 当前告警处理人,填孪生中台的用户id */
ProcessorSet?: string[];
/** 分组id */
GroupIdSet?: number[];
}
declare interface DescribeAlarmListResponse {
/** 告警列表查询结果 */
Result?: DescribeAlarmListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAlarmStatusListRequest {
/** 应用token */
ApplicationToken: string;
/** 工作空间ID */
WorkspaceId: string;
}
declare interface DescribeAlarmStatusListResponse {
/** 告警状态返回结构 */
Result?: DescribeAlarmStatusListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAlarmTypeListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
/** 一级类型 */
ParentType?: string;
}
declare interface DescribeAlarmTypeListResponse {
/** 告警类型列表查询 */
Result?: DescribeAlarmTypeListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeApplicationListRequest {
/** 项目空间id,本次查询返回的应用均关联至该空间 */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
/** 应用id数组,可选,填了则表示根据id批量查询 */
ApplicationId?: number[];
/** 请求页号 */
PageNumber?: number;
/** 页容量,默认为10 */
PageSize?: number;
}
declare interface DescribeApplicationListResponse {
/** 应用列表 */
Result?: ApplicationList;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBuildingListRequest {
/** 项目空间id */
WorkspaceId: string;
/** 应用token */
ApplicationToken: string;
/** 是否有模型文件 */
HasModel?: boolean;
/** 空间编码 */
SpaceCodes?: string[];
}
declare interface DescribeBuildingListResponse {
/** 查询建筑列表出参 */
Result?: BuildingListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBuildingModelRequest {
/** 建筑id */
BuildingId: string;
/** 项目空间id */
WorkspaceId: string;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeBuildingModelResponse {
/** 建模模型信息出参 */
Result?: BuildingModelRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBuildingProfileRequest {
/** 建筑id */
BuildingId: string;
/** 项目空间id */
WorkspaceId: string;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeBuildingProfileResponse {
/** 查询建筑信息出参 */
Result?: BuildingProfileRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCameraExtendInfoRequest {
/** 设备的唯一标识 */
WID: string;
/** 工作空间Id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeCameraExtendInfoResponse {
/** 获取视频扩展信息结果 */
Result?: CameraExtendInfoRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceGroupListRequest {
/** 应用token */
ApplicationToken: string;
/** 工作空间ID */
WorkspaceId: number;
/** 分组id, 不传默认全部 */
GroupId?: number;
}
declare interface DescribeDeviceGroupListResponse {
/** 分组信息 */
Result?: DescribeDeviceGroupListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 分页查询,第几页,必传,大于0 */
PageNumber: number;
/** 每页条数,必传大于0 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
/** 设备类型,非必填 */
DeviceTypeSet?: string[];
/** 产品 pid,非必填 */
ProductIdSet?: number[];
/** 设备标签,非必填 */
TagIdSet?: number[];
/** 空间层级 */
SpaceCodeSet?: string[];
/** 设备标签名,非必填 */
DeviceTagSet?: string[];
/** 设备wid,非必填 */
WIDSet?: string[];
/** 自定义字段 */
Field?: CustomField;
/** 分组id列表,非必填 */
GroupIdSet?: number[];
/** 是否激活,默认全部,"1"激活,"0"未激活 */
IsActive?: string;
/** 是否为摄像头,默认全部,"true"摄像头,"false"非摄像头 */
IsCamera?: string;
}
declare interface DescribeDeviceListResponse {
/** 查询设备列表结果 */
Result?: DescribeDeviceListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceShadowListRequest {
/** 工作空间id */
WorkspaceId: number;
/** WID */
WIDSet: string[];
/** 分页查询,第几页 */
PageNumber: number;
/** 每页条数 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
/** 设备类型code */
DeviceTypeSet?: string[];
/** 产品 pid */
ProductIdSet?: number[];
/** 设备标签id */
TagIdSet?: number[];
/** 空间层级,(支持空间多层,比如具体建筑、具体楼层) */
SpaceCodeSet?: string[];
/** 设备标签名 */
DeviceTagSet?: string[];
}
declare interface DescribeDeviceShadowListResponse {
/** 获取设备影子结果 */
Result?: DeviceShadowRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceStatusListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
/** 分页查询,第几页,必传,大于0 */
PageNumber: number;
/** 每页条数,必传大于0 */
PageSize: number;
/** 设备类型 */
DeviceTypeSet?: string[];
/** 产品 pid */
ProductIdSet?: number[];
/** 设备标签id */
TagIdSet?: number[];
/** 空间位置(支持空间多层,比如具体建筑、具体楼层) */
SpaceCodeSet?: string[];
/** 设备编号列表 */
WIDSet?: string[];
/** 设备标签名,非必填 */
DeviceTagSet?: string[];
/** 通信在/离线状态(online=normal+fault、offline) */
DeviceStatusSet?: string[];
/** 设备业务状态(正常-normal、故障-fault、离线-offline) */
StatusSet?: string[];
/** 推流状态,推流中-true,未推流-false 仅摄像头有的状态 */
IsAlive?: boolean[];
}
declare interface DescribeDeviceStatusListResponse {
/** 查询设备状态结果 */
Result?: DeviceStatusRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceStatusStatRequest {
/** 所属空间地理层级,必填。0表示查询所有层级(1、2)的设备状态,1表示楼栋,2表示楼层 */
Level: number;
/** 工作空间id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
/** 空间位置,非必填。为空表示查询所有(1,2)层级 */
SpaceCodeSet?: string[];
/** 设备类型,非必填。为空表示查询所有设备类型 */
DeviceTypeSet?: string[];
}
declare interface DescribeDeviceStatusStatResponse {
/** 设备状态统计结果 */
Result?: DeviceStatusStatRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceTagListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 分页查询,第几页,必传,大于0 */
PageNumber: number;
/** 每页条数,必传大于0 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeDeviceTagListResponse {
/** 设备标签查询结果 */
Result?: DeviceTagRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDeviceTypeListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
/** 默认0只拉取设备列表关联的设备类型列表;1拉取空间下所有的设备类型列表 */
Flag?: number;
}
declare interface DescribeDeviceTypeListResponse {
/** 设备的设备类型列表 */
Result?: DeviceTypeSet;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeEdgeApplicationTokenRequest {
/** 应用token */
ApplicationToken: string;
/** 是否刷新token,默认为false */
Refresh?: boolean;
}
declare interface DescribeEdgeApplicationTokenResponse {
/** 边缘应用令牌信息 */
Result?: ApplicationTokenInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeElementProfilePageRequest {
/** 建筑id */
BuildingId: string;
/** 页码 */
PageNumber: number;
/** 页容量 */
PageSize: number;
/** 项目空间id */
WorkspaceId: string;
/** 应用token */
ApplicationToken: string;
/** 父级构件id */
ParentElementIds?: string[];
/** 空间层级 */
Level?: number;
/** 空间分类代码 */
SpaceTypeCode?: string;
/** 构件类型 */
EntityTypes?: string[];
/** 是否包含已删除构件 */
IncludeDelete?: boolean;
/** 时间范围-开始 */
StartTime?: number;
/** 时间范围-结束 */
EndTime?: number;
}
declare interface DescribeElementProfilePageResponse {
/** 分页查询构件出参 */
Result?: ElementProfilePageRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeElementProfileTreeRequest {
/** 建筑id */
BuildingId: string;
/** 项目空间id */
WorkspaceId: string;
/** 应用token */
ApplicationToken: string;
/** 父级构件id */
ElementId?: string;
/** 构件级别 */
Level?: number;
/** 空间分类代码 */
SpaceTypeCode?: string;
}
declare interface DescribeElementProfileTreeResponse {
/** 构件树出参 */
Result?: ElementProfileTreeRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeEventListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 分页查询,第几页,必传,大于0 */
PageNumber: number;
/** 每页条数,必传大于0 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
/** 事件触发类型,(app, device, timer) */
TriggerType?: string;
/** 事件id详情 */
IdSet?: number[];
}
declare interface DescribeEventListResponse {
/** 事件列表查询结果 */
Result?: DescribeEventListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeFileDownloadURLRequest {
/** 工作空间Id */
WorkspaceId: number;
/** 文件Id */
FileId: string;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeFileDownloadURLResponse {
/** 文件下载URL地址 */
Result?: FileDownloadURL;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeFileUploadURLRequest {
/** 工作空间Id */
WorkspaceId: number;
/** 文件名称 */
FileName: string;
/** 文件大小 */
FileSize: number;
/** 应用token */
ApplicationToken: string;
/** 文件MD5 */
FileMD5?: string;
/** 存储类型 */
SaveType?: string;
/** 过期时间,过期时间戳,精确到秒的时间戳,noExpireFlag为false时必填 */
FileExpireTime?: number;
/** 永不过期标记 */
NoExpireFlag?: boolean;
}
declare interface DescribeFileUploadURLResponse {
/** 获取文件上传地址结果 */
Result?: FileUploadURL;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeInterfaceListRequest {
/** 应用token */
ApplicationToken: string;
/** 请求页号 */
PageNumber?: number;
/** 请求页容量,默认全量返回 */
PageSize?: number;
/** 查询关键字 */
Keyword?: string;
/** 接口方式 1.http 2消息通知服务 */
Style?: number[];
/** 接口分类0. 其他服务 1. IOT服务 2. 空间服务 3.微应用服务 4.场景服务 5.AI算法服务 6.任务算法服务 7.第三方服务 8.3DTiles服务 */
Type?: number[];
}
declare interface DescribeInterfaceListResponse {
/** API列表 */
Result?: ApiInfoList;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeLinkRuleListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 分页查询,第几页,必传,大于0 */
PageNumber: number;
/** 每页条数,必传大于0 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
/** 事件触发类型 */
TriggerType?: string;
/** 联动id */
IdSet?: number[];
}
declare interface DescribeLinkRuleListResponse {
/** 联动规则列表查询结果 */
Result?: DescribeLinkRuleListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeModelListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 分页查询,第几页,大于0 */
PageNumber: number;
/** 每页条数,大于0 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
/** 设备类型 */
DeviceTypeSet?: string[];
/** 产品 pid */
ProductIdSet?: number[];
/** 模型id */
ModelIdSet?: string[];
}
declare interface DescribeModelListResponse {
/** 模型列表查询结果 */
Result?: ModelSet;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeProductListRequest {
/** 工作空间id */
WorkspaceId: number;
/** 分页查询,第几页 */
PageNumber: number;
/** 每页条数,大于0 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
/** 设备类型 */
DeviceTypeSet?: string[];
/** 产品 pid */
ProductIdSet?: number[];
/** 模型id */
ModelIdSet?: string[];
}
declare interface DescribeProductListResponse {
/** 产品列表查询结果 */
Result?: ProductSet;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribePropertyListRequest {
/** 建筑id */
BuildingId: string;
/** 构件id */
ElementId: string;
/** 项目空间id */
WorkspaceId: string;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribePropertyListResponse {
/** 构件属性信息出参 */
Result?: ElementPropertyRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeRuleDetailRequest {
/** 工作空间id */
WorkspaceId: string;
/** 联动id */
Id: string;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeRuleDetailResponse {
/** 规则详情查询结果 */
Result?: RuleDetailRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSceneListRequest {
/** 项目空间id */
WorkspaceId: string;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeSceneListResponse {
/** 场景列表出参 */
Result?: SceneListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSpaceDeviceIdListRequest {
/** 构件id列表 */
ElementIds: string[];
/** 是否级联 */
IsCascade: boolean;
/** 项目空间id */
WorkspaceId: string;
/** 页码 */
PageNumber: number;
/** 页容量 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeSpaceDeviceIdListResponse {
/** 设备ID列表 */
Result?: SpaceDeviceIdListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSpaceDeviceRelationListRequest {
/** 构件id列表 */
ElementIds: string[];
/** 是否级联 */
IsCascade: boolean;
/** 项目空间id */
WorkspaceId: string;
/** 页码 */
PageNumber: number;
/** 页容量 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeSpaceDeviceRelationListResponse {
/** 查询指定空间下设备与构件绑定关系列表出参 */
Result?: SpaceDeviceRelationRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSpaceInfoByDeviceIdRequest {
/** 设备id */
DeviceId: string;
/** 项目空间id */
WorkspaceId: string;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeSpaceInfoByDeviceIdResponse {
/** 设备绑定的空间信息出参 */
Result?: DeviceSpaceInfoRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSpaceRelationByDeviceIdRequest {
/** 设备id */
DeviceId: string;
/** 工作空间id */
WorkspaceId: string;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeSpaceRelationByDeviceIdResponse {
/** 空间层级关系出参 */
Result?: SpaceRelationRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSpaceTypeListRequest {
/** 项目空间ID */
WorkspaceId: string;
/** 页码 */
PageNumber: number;
/** 页容量 */
PageSize: number;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeSpaceTypeListResponse {
/** 空间分类列表出参 */
Result?: SpaceTypeListRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTenantBuildingCountAndAreaRequest {
/** 租户所有工作空间ID列表 */
WorkspaceIdList: string[];
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeTenantBuildingCountAndAreaResponse {
/** 租户所有项目空间楼栋数量与建筑面积统计结果 */
Result?: SpaceDataTotalStatsRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTenantDepartmentListRequest {
/** 翻页页码 */
Offset: number;
/** 翻页大小 */
Limit: number;
/** token */
ApplicationToken: string;
/** 租户ID */
TenantId?: string;
/** 更新时间戳,单位秒 */
UpdateAt?: number;
/** 部门ID */
DepartmentId?: string;
/** 用户id */
Cursor?: string;
}
declare interface DescribeTenantDepartmentListResponse {
/** 返回数据 */
Result?: SsoDepartmentsResult;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTenantUserListRequest {
/** 翻页页码 */
Offset: number;
/** 翻页大小 */
Limit: number;
/** token */
ApplicationToken: string;
/** 租户ID */
TenantId?: string;
/** 更新时间戳,单位秒 */
UpdateAt?: number;
/** 部门ID */
DepartmentId?: string;
/** 用户id */
Cursor?: string;
/** 状态,0,获取所有数据,1正常启用,2禁用 */
Status?: number;
/** 项目空间id */
WorkspaceId?: string;
/** 关键词 */
Keyword?: string;
/** 是否递归获取子级数据,0需要,1不需要,默认为0 */
NoRecursive?: string;
}
declare interface DescribeTenantUserListResponse {
/** 返回数据 */
Result?: SsoUserResult;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeVideoCloudRecordRequest {
/** 设备的唯一标识 */
WID: string;
/** 录像开始时间(s) */
StartTime: number;
/** 录像结束时间(s) */
EndTime: number;
/** 工作空间Id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
}
declare interface DescribeVideoCloudRecordResponse {
/** 获取云录像结果 */
Result?: VideoCloudRecordRes;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeVideoLiveStreamRequest {
/** 设备的唯一标识 */
WID: string;
/** 枚举如下:flvrtmphlswebrtcraw (视频原始帧) */
Protocol: string;
/** 工作空间Id */
WorkspaceId: number;
/** 应用token */
ApplicationToken: string;
/** 主码流传0,子码流传1,默认主码流 */
StreamId?: number;
/** 设备所在环境,公有云私有化项目传0或者不传,混合云项目一般传空间id */
Env?: string;
}
declare interface DescribeVideoLiveStr