tencentcloud-sdk-nodejs 4.1.26 → 4.1.28

package/tencentcloud/services/iss/v20230517/iss_models.d.ts

@@ -603,6 +603,15 @@ export interface ListAITasksResponse {
      */
     RequestId?: string;
 }
+/**
+ * BatchDeleteVideoDownloadTask请求参数结构体
+ */
+export interface BatchDeleteVideoDownloadTaskRequest {
+    /**
+     * 本地录像下载任务 ID 列表
+     */
+    DownloadTaskIds?: Array<string>;
+}
 /**
  * AI分析配置
  */
@@ -1116,89 +1125,13 @@ export interface ListRecordBackupPlanDevicesData {
     List?: Array<RecordPlanChannelInfo>;
 }
 /**
- * 查询复杂任务详情返回结果
+ * DeleteTask返回参数结构体
  */
-export interface TaskData {
-    /**
-     * 任务ID
-     */
-    TaskId?: string;
-    /**
-     * 任务状态1:NEW,2:RUNNING,3:COMPLETED ,4:FAILED
-     */
-    Status?: number;
-    /**
-     * 失败原因
-     */
-    FailReason?: string;
-    /**
-     * 进度（0-1）
-     */
-    Progress?: number;
-    /**
-     * 任务操作类型，批量任务类型以Batch开头
-     */
-    Action?: string;
-    /**
-     * 操作类型中文描述
-     */
-    ActionZhDesc?: string;
-    /**
-     * 任务类型 1.简单 2.复杂 3.子任务
-     */
-    TaskType?: number;
-    /**
-     * 任务资源id（复杂任务该字段无效）
-     */
-    ResourceId?: string;
-    /**
-     * 总任务数（仅复杂任务有效）
-     */
-    Total?: number;
-    /**
-     * 成功任务数（仅复杂任务有效）
-     */
-    SuccessCount?: number;
-    /**
-     * 失败任务数（仅复杂任务有效）
-     */
-    FailCount?: number;
-    /**
-     * 运行任务数（仅复杂任务有效）
-     */
-    RunningCount?: number;
-    /**
-     * 启动任务时间
-     */
-    StartedAt?: string;
-    /**
-     * 创建任务时间
-     */
-    CreatedAt?: string;
-    /**
-     * 更新任务时间
-     */
-    UpdatedAt?: string;
-    /**
-     * 任务运行时间，单位ms
-     */
-    Runtime?: number;
-    /**
-     * 设备ID
-     */
-    DeviceId?: string;
-    /**
-     * 设备名称
-     */
-    DeviceName?: string;
-    /**
-     * 通道ID
-     */
-    ChannelId?: string;
+export interface DeleteTaskResponse {
     /**
-     *  通道名称
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
-    ChannelName?: string;
+    RequestId?: string;
 }
 /**
  * DescribeGateway请求参数结构体
@@ -1370,37 +1303,17 @@ export interface UpdateRecordBackupPlanModify {
     OrganizationId?: Array<string>;
 }
 /**
- * UpdateAITask请求参数结构体
+ * ListVideoDownloadTask返回参数结构体
  */
-export interface UpdateAITaskRequest {
-    /**
-     * AI 任务 ID
-     */
-    TaskId: string;
-    /**
-     * AI 任务名称。仅支持中文、英文、数字、_、-，长度不超过32个字符
-     */
-    Name?: string;
-    /**
-     * AI 任务描述。仅支持中文、英文、数字、_、-，长度不超过128个字符
-     */
-    Desc?: string;
-    /**
-     * 通道 ID 列表。不能添加存在于其他 AI 任务的通道，限制1000个通道。
-     */
-    ChannelList?: Array<string>;
+export interface ListVideoDownloadTaskResponse {
     /**
-     * AI 结果回调地址。类似 "http://ip:port/***或者https://domain/***
+     * 本地录像下载任务列表
      */
-    CallbackUrl?: string;
+    Data?: ListVideoDownloadTaskData;
     /**
-     * 是否立即开启 AI 任务。"true"代表立即开启 AI 任务，"false"代表暂不开启 AI 任务，默认为 false。
-     */
-    IsStartTheTask?: boolean;
-    /**
-     * AI 配置列表
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
-    Templates?: Array<AITemplates>;
+    RequestId?: string;
 }
 /**
  * 口罩识别结果详情
@@ -1743,13 +1656,89 @@ export interface AITemplates {
  */
 export declare type DescribeOrganizationRequest = null;
 /**
- * UpdateAITaskStatus返回参数结构体
+ * 查询复杂任务详情返回结果
  */
-export interface UpdateAITaskStatusResponse {
+export interface TaskData {
     /**
-     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     * 任务ID
      */
-    RequestId?: string;
+    TaskId?: string;
+    /**
+     * 任务状态1:NEW,2:RUNNING,3:COMPLETED ,4:FAILED
+     */
+    Status?: number;
+    /**
+     * 失败原因
+     */
+    FailReason?: string;
+    /**
+     * 进度（0-1）
+     */
+    Progress?: number;
+    /**
+     * 任务操作类型，批量任务类型以Batch开头
+     */
+    Action?: string;
+    /**
+     * 操作类型中文描述
+     */
+    ActionZhDesc?: string;
+    /**
+     * 任务类型 1.简单 2.复杂 3.子任务
+     */
+    TaskType?: number;
+    /**
+     * 任务资源id（复杂任务该字段无效）
+     */
+    ResourceId?: string;
+    /**
+     * 总任务数（仅复杂任务有效）
+     */
+    Total?: number;
+    /**
+     * 成功任务数（仅复杂任务有效）
+     */
+    SuccessCount?: number;
+    /**
+     * 失败任务数（仅复杂任务有效）
+     */
+    FailCount?: number;
+    /**
+     * 运行任务数（仅复杂任务有效）
+     */
+    RunningCount?: number;
+    /**
+     * 启动任务时间
+     */
+    StartedAt?: string;
+    /**
+     * 创建任务时间
+     */
+    CreatedAt?: string;
+    /**
+     * 更新任务时间
+     */
+    UpdatedAt?: string;
+    /**
+     * 任务运行时间，单位ms
+     */
+    Runtime?: number;
+    /**
+     * 设备ID
+     */
+    DeviceId?: string;
+    /**
+     * 设备名称
+     */
+    DeviceName?: string;
+    /**
+     * 通道ID
+     */
+    ChannelId?: string;
+    /**
+     *  通道名称
+     */
+    ChannelName?: string;
 }
 /**
  * ControlRecord返回参数结构体
@@ -1962,6 +1951,19 @@ export interface RecordPlanOptData {
      */
     RepairMode?: number;
 }
+/**
+ * 列举子任务列表
+ */
+export interface ListSubTasksData {
+    /**
+     * 子任务列表
+     */
+    List?: Array<SubTaskData>;
+    /**
+     * 子任务数量
+     */
+    TotalCount?: number;
+}
 /**
  * DescribeRecordPlan返回参数结构体
  */
@@ -1975,6 +1977,19 @@ export interface DescribeRecordPlanResponse {
      */
     RequestId?: string;
 }
+/**
+ * 时间片段结构体
+ */
+export interface Timeline {
+    /**
+     * 分片起始时间
+     */
+    Begin?: number;
+    /**
+     * 分片结束时间
+     */
+    End?: number;
+}
 /**
  * 查询网关列表返回结果
  */
@@ -1988,6 +2003,31 @@ export interface ListGatewaysData {
      */
     TotalCount?: number;
 }
+/**
+ * 取回任务通道信息
+ */
+export interface RecordRetrieveTaskChannelInfo {
+    /**
+     * 设备通道所属的设备ID
+     */
+    DeviceId?: string;
+    /**
+     * 设备通道所属的设备名称
+     */
+    DeviceName?: string;
+    /**
+     * 设备通道ID
+     */
+    ChannelId?: string;
+    /**
+     * 设备通道名称
+     */
+    ChannelName?: string;
+    /**
+     * 任务状态，0:已取回，1:取回中，2:待取回, 3:无归档录像
+     */
+    Status?: number;
+}
 /**
  * CallISAPI请求参数结构体
  */
@@ -2101,84 +2141,155 @@ export interface ChannelInfo {
     /**
      * 通道所属的设备ID
      */
-    DeviceId: string;
+    DeviceId: string;
+    /**
+     * 设备通道ID，一个设备通道只允许被一个上云计划添加
+     */
+    ChannelId: string;
+}
+/**
+ * DescribeDevicePreset请求参数结构体
+ */
+export interface DescribeDevicePresetRequest {
+    /**
+     * 通道ID（从通道查询接口DescribeDeviceChannel中获取）
+     */
+    ChannelId: string;
+}
+/**
+ * DescribeDomain请求参数结构体
+ */
+export declare type DescribeDomainRequest = null;
+/**
+ * 批量操作设备返回结果
+ */
+export interface BatchOperateDeviceData {
+    /**
+     * 任务 ID（用于在查询任务的子任务列表接口ListSubTasks中查询任务进度）
+     */
+    TaskId?: string;
+}
+/**
+ * 云录像回放url
+ */
+export interface RecordPlaybackUrl {
+    /**
+     * hls回放url
+     */
+    Hls?: string;
+}
+/**
+ * BatchDeleteVideoDownloadTask返回参数结构体
+ */
+export interface BatchDeleteVideoDownloadTaskResponse {
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * 组织目录下的未添加到实时上云计划中的通道数量返回数据
+ */
+export interface ListOrganizationChannelNumbersData {
+    /**
+     * 组织下通道总数
+     */
+    TotalCount?: number;
+    /**
+     * 组织下未添加到计划的通道总数
+     */
+    NotInPlanCount?: number;
+}
+/**
+ * 本地录像下载任务
+ */
+export interface VideoDownloadTask {
+    /**
+     * 下载任务 ID
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    DownloadTaskId?: string;
+    /**
+     * 通道 ID
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ChannelId?: string;
+    /**
+     * 通道名称
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ChannelName?: string;
+    /**
+     * 通道编码
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ChannelCode?: string;
+    /**
+     * 设备名称
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    DeviceName?: string;
     /**
-     * 设备通道ID，一个设备通道只允许被一个上云计划添加
+     * 设备编码
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    ChannelId: string;
-}
-/**
- * 取回任务通道信息
- */
-export interface RecordRetrieveTaskChannelInfo {
+    DeviceCode?: string;
     /**
-     * 设备通道所属的设备ID
+     * 任务状态（0：未执行；1：执行中；2 任务完成；
+  3：任务失败）
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    DeviceId?: string;
+    Status?: number;
     /**
-     * 设备通道所属的设备名称
+     * 下载录像时间段
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    DeviceName?: string;
+    VideoTimeSection?: string;
     /**
-     * 设备通道ID
+     * 倍速
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    ChannelId?: string;
+    Scale?: number;
     /**
-     * 设备通道名称
+     * 下载时长
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    ChannelName?: string;
+    DownloadTime?: number;
     /**
-     * 任务状态，0:已取回，1:取回中，2:待取回, 3:无归档录像
+     * 录像大小
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    Status?: number;
-}
-/**
- * DescribeDomain请求参数结构体
- */
-export declare type DescribeDomainRequest = null;
-/**
- * 批量操作设备返回结果
- */
-export interface BatchOperateDeviceData {
+    VideoSize?: number;
     /**
-     * 任务 ID（用于在查询任务的子任务列表接口ListSubTasks中查询任务进度）
+     * 任务开始时间
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    TaskId?: string;
-}
-/**
- * 云录像回放url
- */
-export interface RecordPlaybackUrl {
+    StartTime?: string;
     /**
-     * hls回放url
+     * 任务结束时间
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    Hls?: string;
-}
-/**
- * 列举子任务列表
- */
-export interface ListSubTasksData {
+    EndTime?: string;
     /**
-     * 子任务列表
+     * 文件下载地址
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    List?: Array<SubTaskData>;
+    FileDownloadUrl?: string;
     /**
-     * 子任务数量
+     * 失败原因
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    TotalCount?: number;
-}
-/**
- * 组织目录下的未添加到实时上云计划中的通道数量返回数据
- */
-export interface ListOrganizationChannelNumbersData {
+    FailedReason?: string;
     /**
-     * 组织下通道总数
+     * 生命周期规则，热存天数
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    TotalCount?: number;
+    Expire?: number;
     /**
-     * 组织下未添加到计划的通道总数
+     * mp4预览地址
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    NotInPlanCount?: number;
+    PreviewUrl?: string;
 }
 /**
  * CallISAPI返回参数结构体
@@ -2557,6 +2668,19 @@ export interface CarAIResultInfo {
      */
     Location?: Location;
 }
+/**
+ * UpdateRecordTemplate请求参数结构体
+ */
+export interface UpdateRecordTemplateRequest {
+    /**
+     * 模板ID
+     */
+    TemplateId: string;
+    /**
+     * 修改内容
+     */
+    Mod: UpdateRecordTemplateData;
+}
 /**
  * DescribeRecordPlaybackUrl请求参数结构体
  */
@@ -2582,6 +2706,15 @@ export interface DescribeRecordPlaybackUrlRequest {
      */
     CorrectTimestamp?: boolean;
 }
+/**
+ * 查询国标设备地址列表
+ */
+export interface DescribeDeviceAddrList {
+    /**
+     * 设备地址列表
+     */
+    RemoteAddrs?: Array<RemoteAddrInfo>;
+}
 /**
  * ListRecordPlans返回参数结构体
  */
@@ -2653,6 +2786,39 @@ export interface DescribeDevicePresetResponse {
      */
     RequestId?: string;
 }
+/**
+ * UpdateAITask请求参数结构体
+ */
+export interface UpdateAITaskRequest {
+    /**
+     * AI 任务 ID
+     */
+    TaskId: string;
+    /**
+     * AI 任务名称。仅支持中文、英文、数字、_、-，长度不超过32个字符
+     */
+    Name?: string;
+    /**
+     * AI 任务描述。仅支持中文、英文、数字、_、-，长度不超过128个字符
+     */
+    Desc?: string;
+    /**
+     * 通道 ID 列表。不能添加存在于其他 AI 任务的通道，限制1000个通道。
+     */
+    ChannelList?: Array<string>;
+    /**
+     * AI 结果回调地址。类似 "http://ip:port/***或者https://domain/***
+     */
+    CallbackUrl?: string;
+    /**
+     * 是否立即开启 AI 任务。"true"代表立即开启 AI 任务，"false"代表暂不开启 AI 任务，默认为 false。
+     */
+    IsStartTheTask?: boolean;
+    /**
+     * AI 配置列表
+     */
+    Templates?: Array<AITemplates>;
+}
 /**
  * UpdateRecordBackupPlan请求参数结构体
  */
@@ -2849,6 +3015,15 @@ export interface ListRecordBackupPlanDevicesResponse {
      */
     RequestId?: string;
 }
+/**
+ * DeleteTask请求参数结构体
+ */
+export interface DeleteTaskRequest {
+    /**
+     * 任务ID
+     */
+    TaskId: string;
+}
 /**
  * 网关设备数据
  */
@@ -3000,6 +3175,16 @@ export interface GatewaysData {
      */
     DeviceNum?: number;
 }
+/**
+ * 录像下载任务数据结构
+ */
+export interface VideoDownloadTaskData {
+    /**
+     * 下载任务ID
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    DownloadTaskId?: string;
+}
 /**
  * 查询网关设备列表返回数据
  */
@@ -3036,13 +3221,17 @@ export interface ListForbidplayChannelsData {
     List?: Array<ChannelAttrInfo>;
 }
 /**
- * DescribeDevicePreset请求参数结构体
+ * CreateVideoDownloadTask返回参数结构体
  */
-export interface DescribeDevicePresetRequest {
+export interface CreateVideoDownloadTaskResponse {
     /**
-     * 通道ID（从通道查询接口DescribeDeviceChannel中获取）
+     * 下载任务返回结果
      */
-    ChannelId: string;
+    Data?: VideoDownloadTaskData;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
 }
 /**
  * ListGateways返回参数结构体
@@ -3112,17 +3301,13 @@ export interface DescribeGatewayProtocolResponse {
     RequestId?: string;
 }
 /**
- * 时间片段结构体
+ * DescribeGBDeviceAddr请求参数结构体
  */
-export interface Timeline {
-    /**
-     * 分片起始时间
-     */
-    Begin?: number;
+export interface DescribeGBDeviceAddrRequest {
     /**
-     * 分片结束时间
+     * 设备ID列表
      */
-    End?: number;
+    DeviceIds: Array<string>;
 }
 /**
  * 获取AI任务列表的数据
@@ -3587,6 +3772,21 @@ export interface QueryForbidPlayChannelListRequest {
      */
     PageNumber: number;
 }
+/**
+ * 本地录像下载任务列表
+ */
+export interface ListVideoDownloadTaskData {
+    /**
+     * 任务列表
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    List?: Array<VideoDownloadTask>;
+    /**
+     * 任务总数
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    TotalCount?: number;
+}
 /**
  * AI车牌信息
  */
@@ -3630,6 +3830,19 @@ export interface DescribeRecordFileResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeGBDeviceAddr返回参数结构体
+ */
+export interface DescribeGBDeviceAddrResponse {
+    /**
+     * 无
+     */
+    Data?: DescribeDeviceAddrList;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * ControlDevicePreset请求参数结构体
  */
@@ -4260,6 +4473,15 @@ export interface RecordPlanChannelInfo {
      */
     AccessProtocol?: number;
 }
+/**
+ * UpdateAITaskStatus返回参数结构体
+ */
+export interface UpdateAITaskStatusResponse {
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * SetForbidPlayChannels返回参数结构体
  */
@@ -4270,17 +4492,45 @@ export interface SetForbidPlayChannelsResponse {
     RequestId?: string;
 }
 /**
- * UpdateRecordTemplate请求参数结构体
+ * ListVideoDownloadTask请求参数结构体
  */
-export interface UpdateRecordTemplateRequest {
+export interface ListVideoDownloadTaskRequest {
     /**
-     * 模板ID
+     * 设备名称，用于模糊搜索
      */
-    TemplateId: string;
+    DeviceName?: string;
     /**
-     * 修改内容
+     * 通道名称，用于模糊搜索
      */
-    Mod: UpdateRecordTemplateData;
+    ChannelName?: string;
+    /**
+     * 任务状态（0：准备中，1：执行中，2：已完成，3：失败）
+     */
+    Status?: number;
+    /**
+     * 排序规则（仅支持 StartTime，EndTime，倒序为-StartTime，-EndTime）
+     */
+    SortRule?: string;
+    /**
+     * 响应是否携带预览地址(0:不携带；1:携带)
+     */
+    WithPreviewUrl?: number;
+    /**
+     * 分页页数
+     */
+    PageNumber?: number;
+    /**
+     * 分页大小
+     */
+    PageSize?: number;
+    /**
+     * 下载任务 ID
+     */
+    DownloadTaskId?: string;
+    /**
+     * 下载地址过期时间，单位秒，最大为 1 天， 86400秒
+     */
+    UrlExpires?: number;
 }
 /**
  * DeleteRecordBackupTemplate请求参数结构体
@@ -4326,6 +4576,19 @@ export interface DescribeVideoBitRateList {
      */
     BitRates?: Array<BitRateInfo>;
 }
+/**
+ * UpdateRecordTemplate返回参数结构体
+ */
+export interface UpdateRecordTemplateResponse {
+    /**
+     * 返回结果
+     */
+    Data?: RecordTemplateInfo;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * AddRecordBackupTemplate返回参数结构体
  */
@@ -4810,6 +5073,19 @@ export interface DeleteUserDeviceResponse {
      */
     RequestId?: string;
 }
+/**
+ * 设备地址返回结果
+ */
+export interface RemoteAddrInfo {
+    /**
+     * 设备Id
+     */
+    DeviceId?: string;
+    /**
+     * IP地址
+     */
+    Addr?: string;
+}
 /**
  * UpdateRecordBackupPlan返回参数结构体
  */
@@ -4934,17 +5210,37 @@ export interface DeleteRecordBackupTemplateResponse {
     RequestId?: string;
 }
 /**
- * UpdateRecordTemplate返回参数结构体
+ * CreateVideoDownloadTask请求参数结构体
  */
-export interface UpdateRecordTemplateResponse {
+export interface CreateVideoDownloadTaskRequest {
     /**
-     * 返回结果
+     * 通道ID
      */
-    Data?: RecordTemplateInfo;
+    ChannelId: string;
     /**
-     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     * 开始时间
      */
-    RequestId?: string;
+    BeginTime: number;
+    /**
+     * 结束时间
+     */
+    EndTime: number;
+    /**
+     * 默认1倍速，支持（1,2,4,8）倍速
+     */
+    Scale?: number;
+    /**
+     * 转码后的mp4文件过期时间（支持7,15,30,60,90,180,365）
+     */
+    Expire?: number;
+    /**
+     * 下载文件格式，当前仅支持（1：mp4）
+     */
+    FileType?: number;
+    /**
+     * 完成策略（0：拉流失败但是录像不完整则认为任务失败，不生成 MP4；1：拉流失败但是录像不完整则认为任务成功，生成 mp4）
+     */
+    CompletionPolicy?: number;
 }
 /**
  * DescribeRecordRetrieveTask返回参数结构体