tencentcloud-sdk-nodejs
Version:
2,570 lines (2,564 loc) • 550 kB
TypeScript
/**
* 创建任务返回体
*/
export interface CreateTaskResult {
/**
* 任务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskId?: string;
}
/**
* 角色对象
*/
export interface SystemRole {
/**
* 角色id
*/
RoleId?: string;
/**
* 角色名称
注意：此字段可能返回 null，表示取不到有效值。
*/
RoleName?: string;
/**
* 角色展示名
注意：此字段可能返回 null，表示取不到有效值。
*/
RoleDisplayName?: string;
/**
* 描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Description?: string;
}
/**
* ListOpsTriggerWorkflows返回参数结构体
*/
export interface ListOpsTriggerWorkflowsResponse {
/**
* 工作流查询结果
注意：此字段可能返回 null，表示取不到有效值。
*/
Data?: TriggerWorkflowResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListWorkflowPermissions返回参数结构体
*/
export interface ListWorkflowPermissionsResponse {
/**
* 分页的授权信息查询结果
*/
Data?: WorkflowPermissionPage;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListProcessLineage返回参数结构体
*/
export interface ListProcessLineageResponse {
/**
* <p>分页数据</p>
*/
Data?: ListProcessLineagePage;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetWorkflowFolder请求参数结构体
*/
export interface GetWorkflowFolderRequest {
/**
* 项目ID
*/
ProjectId: string;
/**
* 文件夹id
*/
FolderId: string;
}
/**
* 获取工作流的列表信息item
*/
export interface WorkflowInfo {
/**
* 工作流ID
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowId?: string;
/**
* 工作流名称
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowName?: string;
/**
* 工作流类型，cycle及manual
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowType?: string;
/**
* 负责人ID
注意：此字段可能返回 null，表示取不到有效值。
*/
OwnerUin?: string;
/**
* 创建时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime?: string;
/**
* 最新修改时间
注意：此字段可能返回 null，表示取不到有效值。
*/
ModifyTime?: string;
/**
* 最后更新人ID
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateUserUin?: string;
/**
* 工作流描述
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowDesc?: string;
/**
* 创建人ID
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateUserUin?: string;
}
/**
* RevokePrivileges请求参数结构体
*/
export interface RevokePrivilegesRequest {
/**
* 资源数组，数据来源于ListPermissions接口返回的Resource中的ResourceType和ResourceUri
*/
Resources: Array<PrivilegeResource>;
/**
* 授权回收主体数组，参数组装需要注意：
1.SubjectType 和SubjectValues的取值参考ListPermissions接口中返回SubjectDetails中的SubjectType和SubjectValue
2.批量回收时，Subjects数组长度需要与权限点Privileges长度一致，并且数据一一对应
*/
Subjects: Array<Subject>;
/**
* 权限点，Name来源于ListPermissions接口返回的PermissionDetails中的Name，例如：BROWSE 、GRANT_PRIVILEGES
*/
Privileges: Array<PrivilegeInfo>;
}
/**
* ListTable返回参数结构体
*/
export interface ListTableResponse {
/**
* 分页数据
*/
Data?: ListTablePage;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateQualityRule请求参数结构体
*/
export interface CreateQualityRuleRequest {
/**
* 项目id
*/
ProjectId: string;
/**
* 规则创建场景
1：单表多规则
2：多表单规则
3：克隆创建规则
*/
CreateRuleScene: number;
/**
* 单条规则信息集合
*/
RuleBOList: Array<QualityRuleInfo>;
}
/**
* CreateDataSource请求参数结构体
*/
export interface CreateDataSourceRequest {
/**
* <p>数据源项目ID</p>
*/
ProjectId: string;
/**
* <p>数据源名称</p>
*/
Name: string;
/**
* <p>数据源类型:枚举值- MYSQL- TENCENT_MYSQL- POSTGRE- ORACLE- SQLSERVER- FTP- HIVE- HUDI- HDFS- ICEBERG- KAFKA- DTS_KAFKA- HBASE- SPARK- TBASE- DB2- DM- GAUSSDB- GBASE- IMPALA- ES- TENCENT_ES- GREENPLUM- SAP_HANA- SFTP- OCEANBASE- CLICKHOUSE- KUDU- VERTICA- REDIS- COS- DLC- DORIS- CKAFKA- S3_DATAINSIGHT- TDSQL- TDSQL_MYSQL- MONGODB- TENCENT_MONGODB- REST_API- TiDB- StarRocks- Trino- Kyuubi- TCHOUSE_X- TCHOUSE_P- TCHOUSE_C- TCHOUSE_D- INFLUXDB- BIG_QUERY- SSH- BLOB- TDSQL_POSTGRE- GDB- TDENGINE- TDSQLC- FileSystem- TCLake- TDSQL_BOUNDLESS</p>
*/
Type: string;
/**
* <p>数据源的配置信息，以JSON KV存储，根据每个数据源类型不同，而KV存储信息不同</p><blockquote><p>deployType:<br>CONNSTR_PUBLICDB(公网实例)<br>CONNSTR_CVMDB(自建实例)<br>INSTANCE(云实例)</p></blockquote><p><pre><code>mysql: 自建实例{ "deployType": "CONNSTR_CVMDB", "url": "jdbc:mysql://1.1.1.1:1111/example#test#123456", "username": "root", "password": "example#test#123456", "region": "ap-shanghai", "vpcId": "vpc-kprq42yo", "type": "MYSQL"}mysql: 云实例{ "instanceid": "cdb-12uxdo5e", "db": "db", "region": "ap-shanghai", "username": "msyql", "password": "example#test#123456", "deployType": "INSTANCE", "type": "TENCENT_MYSQL"}sql_server: { "deployType": "CONNSTR_PUBLICDB", "url": "jdbc:sqlserver://1.1.1.1:223;example#test#123456", "username": "user_1", "password": "example#test#123456", "type": "SQLSERVER"}redis: redisType: -NO_ACCOUT(免账号) -SELF_ACCOUNT(自定义账号){ "deployType": "CONNSTR_PUBLICDB", "username":"" "password": "example#test#123456", "ip": "1.1.1.1", "port": "6379", "redisType": "NO_ACCOUT", "type": "REDIS"}oracle: { "deployType": "CONNSTR_CVMDB", "url": "jdbc:oracle:thin:@1.1.1.1:1521:example#test#123456", "username": "oracle", "password": "example#test#123456", "region": "ap-shanghai", "vpcId": "vpc-kprq42yo", "type": "ORACLE"}mongodb: advanceParams(自定义参数，会拼接至url后){ "advanceParams": [ { "key": "authSource", "value": "auth" } ], "db": "admin", "deployType": "CONNSTR_PUBLICDB", "username": "user", "password": "example#test#123456", "type": "MONGODB", "host": "1.1.1.1:9200"}postgresql:{ "deployType": "CONNSTR_PUBLICDB", "url": "jdbc:postgresql://1.1.1.1:1921/example#test#123456", "username": "user", "password": "example#test#123456", "type": "POSTGRE"}kafka: authType: - sasl - jaas - sasl_plaintext - sasl_ssl - GSSAPI ssl: -PLAIN -GSSAPI{ "deployType": "CONNSTR_PUBLICDB", "host": "1.1.1.1:9092", "ssl": "GSSAPI", "authType": "sasl", "type": "KAFKA", "principal": "aaaa", "serviceName": "kafka"}cos:{ "region": "ap-shanghai", "deployType": "INSTANCE", "secretId": "aaaaa", "secretKey": "example#test#123456", "bucket": "aaa", "type": "COS"}</code></pre></p>
*/
ProdConProperties: string;
/**
* <p>开发环境数据源配置信息，若项目为标准模式，则此字段必填</p>
*/
DevConProperties?: string;
/**
* <p>生产环境数据源文件上传</p>
*/
ProdFileUpload?: DataSourceFileUpload;
/**
* <p>开发环境数据源文件上传</p>
*/
DevFileUpload?: DataSourceFileUpload;
/**
* <p>数据源展示名，为了可视化查看</p>
*/
DisplayName?: string;
/**
* <p>数据源描述信息</p>
*/
Description?: string;
}
/**
* GetResourceGroupMetrics返回参数结构体
*/
export interface GetResourceGroupMetricsResponse {
/**
* 执行组指标信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Data?: ResourceGroupMetrics;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteWorkflow返回参数结构体
*/
export interface DeleteWorkflowResponse {
/**
* 是否删除成功
*/
Data?: DeleteWorkflowResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListDataSources请求参数结构体
*/
export interface ListDataSourcesRequest {
/**
* <p>项目id</p>
*/
ProjectId: string;
/**
* <p>返回数量，默认10</p>
*/
PageSize?: number;
/**
* <p>页码，默认1</p>
*/
PageNumber?: number;
/**
* <p>数据源名称</p>
*/
Name?: string;
/**
* <p>数据源展示名</p>
*/
DisplayName?: string;
/**
* <p>数据源类型:枚举值</p><ul><li>MYSQL</li><li>TENCENT_MYSQL</li><li>POSTGRE</li><li>ORACLE</li><li>SQLSERVER</li><li>FTP</li><li>HIVE</li><li>HUDI</li><li>HDFS</li><li>ICEBERG</li><li>KAFKA</li><li>HBASE</li><li>SPARK</li><li>VIRTUAL</li><li>TBASE</li><li>DB2</li><li>DM</li><li>GAUSSDB</li><li>GBASE</li><li>IMPALA</li><li>ES</li><li>TENCENT_ES</li><li>GREENPLUM</li><li>PHOENIX</li><li>SAP_HANA</li><li>SFTP</li><li>OCEANBASE</li><li>CLICKHOUSE</li><li>KUDU</li><li>VERTICA</li><li>REDIS</li><li>COS</li><li>DLC</li><li>DORIS</li><li>CKAFKA</li><li>S3</li><li>TDSQL</li><li>TDSQL_MYSQL</li><li>MONGODB</li><li>TENCENT_MONGODB</li><li>REST_API</li><li>SuperSQL</li><li>PRESTO</li><li>TiDB</li><li>StarRocks</li><li>Trino</li><li>Kyuubi</li><li>TCHOUSE_X</li><li>TCHOUSE_P</li><li>TCHOUSE_C</li><li>TCHOUSE_D</li><li>INFLUXDB</li><li>BIG_QUERY</li><li>SSH</li><li>BLOB</li></ul>
*/
Type?: Array<string>;
/**
* <p>创建人</p>
*/
Creator?: string;
}
/**
* 查询工作流分页列表
*/
export interface OpsWorkflows {
/**
* 记录列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Items?: Array<OpsWorkflow>;
/**
* 结果总数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount?: number;
/**
* 总页数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalPageNumber?: number;
/**
* 分页大小
注意：此字段可能返回 null，表示取不到有效值。
*/
PageSize?: number;
/**
* 分页页码
注意：此字段可能返回 null，表示取不到有效值。
*/
PageNumber?: number;
}
/**
* 项目信息
*/
export interface ProjectRequest {
/**
* 项目标识，英文名，以字母开头，可包含字母、数字和下划线，不能超过32个字符
*/
ProjectName: string;
/**
* 项目显示名称，可以为中文名，以字母开头，可包含字母、数字和下划线，不能超过32个字符
*/
DisplayName: string;
/**
* 项目模式，SIMPLE（默认）：简单模式 STANDARD：标准模式
*/
ProjectModel?: string;
}
/**
* 工作流SPARK_SQL参数
*/
export interface WorkflowGeneralTaskParam {
/**
* 通用任务参数类型,目前只支持SPARK_SQL
注意：此字段可能返回 null，表示取不到有效值。
*/
Type?: string;
/**
* 通用任务参数内容, 不同参数用;
分割
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
}
/**
* GetMyCodeMaxPermission请求参数结构体
*/
export interface GetMyCodeMaxPermissionRequest {
/**
* 项目ID
*/
ProjectId: string;
/**
* 授权资源唯一id，文件夹id或文件id、
*/
ResourceId: string;
}
/**
* DeleteResourceFolder返回参数结构体
*/
export interface DeleteResourceFolderResponse {
/**
* true代表删除成功，false代表删除失败
*/
Data?: DeleteFolderResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateTask请求参数结构体
*/
export interface UpdateTaskRequest {
/**
* 项目ID
*/
ProjectId: string;
/**
* 任务ID
*/
TaskId: string;
/**
* 任务基本属性
*/
Task: UpdateTaskBrief;
}
/**
* map
*/
export interface KVMap {
/**
* k
注意：此字段可能返回 null，表示取不到有效值。
*/
K?: string;
/**
* v
注意：此字段可能返回 null，表示取不到有效值。
*/
V?: string;
}
/**
* CreateTriggerWorkflowRun返回参数结构体
*/
export interface CreateTriggerWorkflowRunResponse {
/**
* 操作结果信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Data?: CreateTriggerWorkflowRunResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListResourceFiles返回参数结构体
*/
export interface ListResourceFilesResponse {
/**
* 获取资源文件列表
*/
Data?: ResourceFilePage;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListDownstreamTaskInstances请求参数结构体
*/
export interface ListDownstreamTaskInstancesRequest {
/**
* 项目Id
*/
ProjectId: string;
/**
* **实例唯一标识**
*/
InstanceKey: string;
/**
* **时区** timeZone, 默认UTC+8
*/
TimeZone?: string;
/**
* **页码，整型**配合pageSize使用且不能小于1， 默认值1
*/
PageNumber?: number;
/**
* **每页显示的条数，默认为10，最小值为1、最大值为100
*/
PageSize?: number;
}
/**
* UpdateProject请求参数结构体
*/
export interface UpdateProjectRequest {
/**
* 目标修改的项目ID
*/
ProjectId: string;
/**
* 项目显示名称，可以为中文名,需要租户范围内唯一
*/
DisplayName?: string;
/**
* 备注
*/
Description?: string;
/**
* 项目负责人id
*/
ProjectOwnerUin?: string;
}
/**
* DeleteWorkflow请求参数结构体
*/
export interface DeleteWorkflowRequest {
/**
* 项目Id
*/
ProjectId: string;
/**
* 工作流id
*/
WorkflowId: string;
}
/**
* ListProjectMembers请求参数结构体
*/
export interface ListProjectMembersRequest {
/**
* 项目id
*/
ProjectId: string;
/**
* 使用成员名过滤，支持模糊查询
*/
UserName?: string;
/**
* 使用成员id过滤，支持模糊查询
*/
UserUin?: string;
/**
* 分页大小，默认第一页
*/
PageSize?: number;
/**
* 分页条数，默认10条
*/
PageNumber?: number;
}
/**
* DeleteDataBackfillPlanAsync请求参数结构体
*/
export interface DeleteDataBackfillPlanAsyncRequest {
/**
* 项目id
*/
ProjectId: string;
/**
* 补录计划id
*/
DataBackfillPlanId: string;
}
/**
* DeleteTriggerWorkflow返回参数结构体
*/
export interface DeleteTriggerWorkflowResponse {
/**
* 是否删除成功
*/
Data?: DeleteTriggerWorkflowResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 工作流调度模式下的任务运行概要信息
*/
export interface TriggerTaskRunBrief {
/**
* 任务运行ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecutionId?: string;
/**
* 执行状态，运行失败:FAILED、运行成功:SUCCESS、等待中:PENDING、跳过运行:SKIP、运行中:RUNNING
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecutionState?: string;
/**
* 项目ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ProjectId?: string;
/**
* 工作流ID
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowId?: string;
/**
* 工作流运行ID
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowExecutionId?: string;
/**
* 任务 ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskId?: string;
/**
* 任务类型
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskType?: string;
/**
* 任务版本
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskVersionId?: string;
/**
* 触发类型
注意：此字段可能返回 null，表示取不到有效值。
*/
TriggerType?: string;
/**
* 等待时长，单位秒
注意：此字段可能返回 null，表示取不到有效值。
*/
WaitTime?: string;
/**
* 所属资源组
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceGroup?: string;
/**
* 错误码
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrorCode?: string;
/**
* 运行账号
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecuteUserUin?: string;
/**
* 创建人 ID
注意：此字段可能返回 null，表示取不到有效值。
*/
CreaterUin?: string;
/**
* 执行平台执行 ID
注意：此字段可能返回 null，表示取不到有效值。
*/
JobId?: string;
/**
* 创建时间戳
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime?: string;
/**
* 计划调度时间
注意：此字段可能返回 null，表示取不到有效值。
*/
ScheduleTime?: string;
/**
* 更新时间戳
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: string;
/**
* 依赖任务完成时间
注意：此字段可能返回 null，表示取不到有效值。
*/
DependenceFinishedTime?: string;
/**
* 任务下发执行平台时间
注意：此字段可能返回 null，表示取不到有效值。
*/
QueueStartTime?: string;
/**
* 开始等待资源时间
注意：此字段可能返回 null，表示取不到有效值。
*/
PendingStartTime?: string;
/**
* 运行开始时间
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecutionStartTime?: string;
/**
* 运行结束时间
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecutionEndTime?: string;
/**
* 排队时间
注意：此字段可能返回 null，表示取不到有效值。
*/
QueueCostTime?: string;
/**
* 运行时间
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecutionTime?: string;
/**
* 总花费时间
注意：此字段可能返回 null，表示取不到有效值。
*/
AllCostTime?: string;
/**
* 时区
注意：此字段可能返回 null，表示取不到有效值。
*/
TimeZone?: string;
/**
* 依赖上游任务 ID 列表
注意：此字段可能返回 null，表示取不到有效值。
*/
DependOnList?: Array<string>;
/**
* 运行参数
注意：此字段可能返回 null，表示取不到有效值。
*/
RunParams?: string;
/**
* 任务扩展信息，包含脚本路径
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskTypeExtensions?: string;
/**
* 重试次数，为 0 则表示首次运行
注意：此字段可能返回 null，表示取不到有效值。
*/
RetryTimes?: number;
/**
* 左侧坐标
注意：此字段可能返回 null，表示取不到有效值。
*/
LeftCoordinate?: number;
/**
* 顶部坐标
注意：此字段可能返回 null，表示取不到有效值。
*/
TopCoordinate?: number;
/**
* 资源组 ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceGroupId?: string;
/**
* 错误码描述
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrorCodeStr?: string;
/**
* 创建人 UIN
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateUin?: string;
/**
* 下发执行平台时间
注意：此字段可能返回 null，表示取不到有效值。
*/
IssueTime?: string;
/**
* 任务名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskName?: string;
/**
* 工作流名称
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowName?: string;
/**
* 运行人名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecuteUserName?: string;
/**
* 重跑次数
注意：此字段可能返回 null，表示取不到有效值。
*/
RerunTimes?: number;
/**
* 是否是最新一次运行
注意：此字段可能返回 null，表示取不到有效值。
*/
IsLatestExecution?: boolean;
/**
* 任务运行状态
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskExecutionState?: string;
/**
* 周期类型
注意：此字段可能返回 null，表示取不到有效值。
*/
CycleType?: string;
/**
* 责任人名称
注意：此字段可能返回 null，表示取不到有效值。
*/
UserNameInCharge?: string;
/**
* 责任人id
注意：此字段可能返回 null，表示取不到有效值。
*/
UserUinInCharge?: string;
/**
* 资源组名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceGroupName?: string;
/**
* 时区
注意：此字段可能返回 null，表示取不到有效值。
*/
Timezone?: string;
/**
* 文件夹id
注意：此字段可能返回 null，表示取不到有效值。
*/
FolderId?: string;
/**
* 文件夹名称
注意：此字段可能返回 null，表示取不到有效值。
*/
FolderName?: string;
/**
* 项目名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ProjectName?: string;
/**
* 任务类型id
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskTypeId?: number;
/**
* 工作流运行参数
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowParams?: string;
/**
* 是否支持重跑
注意：此字段可能返回 null，表示取不到有效值。
*/
SupportRerun?: boolean;
/**
* 工作流运行状态
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowExecutionState?: string;
/**
* 任务执行结果
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecutionResult?: string;
/**
* 依赖策略
注意：此字段可能返回 null，表示取不到有效值。
*/
DependencyTriggerPolicy?: string;
}
/**
* ListTriggerWorkflows请求参数结构体
*/
export interface ListTriggerWorkflowsRequest {
/**
* 项目ID
*/
ProjectId: string;
/**
* 请求的数据页数。默认值为1，取值大于等于1
*/
PageNumber?: number;
/**
* 每页显示的数据条数。默认值为10 ，最小值为10，最大值为200
*/
PageSize?: number;
/**
* 搜索关键词
*/
Keyword?: string;
/**
* 工作流所属文件夹
*/
ParentFolderPath?: string;
/**
* bundleId项
*/
BundleId?: string;
/**
* 负责人ID
*/
OwnerUin?: string;
/**
* 创建人ID
*/
CreateUserUin?: string;
/**
* 修改时间区间 yyyy-MM-dd HH:mm:ss，需要在数组填入两个时间
*/
ModifyTime?: Array<string>;
/**
* 创建时间区间 yyyy-MM-dd HH:mm:ss，需要在数组填入两个时间
*/
CreateTime?: Array<string>;
}
/**
* PauseOpsTasksAsync请求参数结构体
*/
export interface PauseOpsTasksAsyncRequest {
/**
* 所属项目Id
*/
ProjectId: string;
/**
* 任务Id列表
*/
TaskIds: Array<string>;
/**
* 是否需要终止已生成实例
*/
KillInstance?: boolean;
}
/**
* 任务配置信息
*/
export interface TaskConfiguration {
/**
* 代码内容的Base64编码
注意：此字段可能返回 null，表示取不到有效值。
*/
CodeContent?: string;
/**
* 任务扩展属性配置列表
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskExtConfigurationList?: Array<TaskExtParameter>;
/**
* 集群ID
注意：此字段可能返回 null，表示取不到有效值。
*/
DataCluster?: string;
/**
* 指定的运行节点
注意：此字段可能返回 null，表示取不到有效值。
*/
BrokerIp?: string;
/**
* 资源池队列名称，需要通过 DescribeProjectClusterQueues 获取
注意：此字段可能返回 null，表示取不到有效值。
*/
YarnQueue?: string;
/**
* 来源数据源ID, 需要通过 DescribeDataSourceWithoutInfo 获取
注意：此字段可能返回 null，表示取不到有效值。
*/
SourceServiceId?: string;
/**
* 来源数据源类型, 需要通过 DescribeDataSourceWithoutInfo 获取
注意：此字段可能返回 null，表示取不到有效值。
*/
SourceServiceType?: string;
/**
* 来源数据源名称, 需要通过 DescribeDataSourceWithoutInfo 获取
注意：此字段可能返回 null，表示取不到有效值。
*/
SourceServiceName?: string;
/**
* 目标数据源ID, 需要通过 DescribeDataSourceWithoutInfo 获取
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetServiceId?: string;
/**
* 目标数据源类型, 需要通过 DescribeDataSourceWithoutInfo 获取
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetServiceType?: string;
/**
* 目标数据源名称, 需要通过 DescribeDataSourceWithoutInfo 获取
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetServiceName?: string;
/**
* 资源组ID： 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupId
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceGroup?: string;
/**
* 资源组名称： 需要通过 DescribeNormalSchedulerExecutorGroups 获取 ExecutorGroupName
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceGroupName?: string;
/**
* 调度参数
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskSchedulingParameterList?: Array<TaskSchedulingParameter>;
/**
* Bundle使用的ID
注意：此字段可能返回 null，表示取不到有效值。
*/
BundleId?: string;
/**
* Bundle信息
注意：此字段可能返回 null，表示取不到有效值。
*/
BundleInfo?: string;
}
/**
* 依赖任务信息
*/
export interface DependencyTriggerTaskBrief {
/**
* 任务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskId: string;
}
/**
* DissociateResourceGroupFromProject请求参数结构体
*/
export interface DissociateResourceGroupFromProjectRequest {
/**
* 资源组id
*/
ResourceGroupId: string;
/**
* 项目id
*/
ProjectId: string;
}
/**
* dlc集群信息
*/
export interface DLCClusterInfo {
/**
* dlc资源名称（需要添加角色Uin到dlc中，否则可能获取不到资源）
注意：此字段可能返回 null，表示取不到有效值。
*/
ComputeResources: Array<string>;
/**
* dlc地域
注意：此字段可能返回 null，表示取不到有效值。
*/
Region: string;
/**
* 指定DLC集群的默认数据库
注意：此字段可能返回 null，表示取不到有效值。
*/
DefaultDatabase: string;
/**
* 集群配置标记（ 仅对标准模式的项目生效并且标准模式必填），枚举值：
- Prod (生产环境)
- Dev (开发环境)
*/
StandardModeEnvTag?: string;
/**
* 访问账号（ 仅对标准模式的项目生效并且标准模式必填），用于提交dlc任务的账号
建议使用指定子账号，给子账号设置对应库表的权限；任务负责人模式在负责人离职后容易造成任务失败；主账号模式在多个项目权限不同的情况下不易做权限控制。
枚举值：
- TASK_RUNNER （任务负责人）
- OWNER （主账号模式）
- SUB （子账号模式）
*/
AccessAccount?: string;
/**
* 子账号id（ 仅对标准模式的项目生效），AccessAccount为子账号模式时，需要指定子账号的id信息，其他模式不需要指定
*/
SubAccountUin?: string;
}
/**
* 更新工作流结果
*/
export interface UpdateTriggerWorkflowResult {
/**
* 更新工作流结果
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: boolean;
}
/**
* CreateWorkflow请求参数结构体
*/
export interface CreateWorkflowRequest {
/**
* 项目ID
*/
ProjectId: string;
/**
* 工作流名称
*/
WorkflowName: string;
/**
* 所属文件夹路径
*/
ParentFolderPath: string;
/**
* 工作流类型,取值示例：cycle 周期工作流；manual 手动工作流，默认传入cycle
*/
WorkflowType?: string;
/**
* 工作流描述
*/
WorkflowDesc?: string;
/**
* 工作流负责人ID
*/
OwnerUin?: string;
/**
* 工作流参数
*/
WorkflowParams?: Array<ParamInfo>;
/**
* 统一调度信息
*/
WorkflowSchedulerConfiguration?: WorkflowSchedulerConfigurationInfo;
/**
* BundleId项
*/
BundleId?: string;
/**
* Bundle信息
*/
BundleInfo?: string;
}
/**
* 任务调度变量参数
*/
export interface TaskSchedulingParameter {
/**
* 参数名
注意：此字段可能返回 null，表示取不到有效值。
*/
ParamKey: string;
/**
* 参数值
注意：此字段可能返回 null，表示取不到有效值。
*/
ParamValue: string;
}
/**
* SubmitTask请求参数结构体
*/
export interface SubmitTaskRequest {
/**
* 项目ID
*/
ProjectId: string;
/**
* 任务ID
*/
TaskId: string;
/**
* 版本备注
*/
VersionRemark: string;
}
/**
* RemoveMemberProjectRole返回参数结构体
*/
export interface RemoveMemberProjectRoleResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 任务调度变量参数
*/
export interface SchedulingParameter {
/**
* 参数名
注意：此字段可能返回 null，表示取不到有效值。
*/
ParamKey?: string;
/**
* 参数值
注意：此字段可能返回 null，表示取不到有效值。
*/
ParamValue?: string;
/**
* 拓展参数json
注意：此字段可能返回 null，表示取不到有效值。
*/
ExtProperties?: string;
}
/**
* UpdateSQLFolder请求参数结构体
*/
export interface UpdateSQLFolderRequest {
/**
* 文件夹Id
*/
FolderId: string;
/**
* 文件夹名称
*/
FolderName: string;
/**
* 项目id
*/
ProjectId: string;
/**
* 权限范围：SHARED, PRIVATE
*/
AccessScope?: string;
}
/**
* 单次补录实例详情
*/
export interface BackfillInstance {
/**
* 任务名称
*/
TaskName?: string;
/**
* 任务Id
*/
TaskId?: string;
/**
* 实例数据时间
*/
CurRunDate?: string;
/**
* 执行状态
*/
State?: string;
/**
* 开始时间
注意：此字段可能返回 null，表示取不到有效值。
*/
StartTime?: string;
/**
* 结束时间
注意：此字段可能返回 null，表示取不到有效值。
*/
EndTime?: string;
/**
* 执行时长
注意：此字段可能返回 null，表示取不到有效值。
*/
CostTime?: string;
}
/**
* 工作流列表分页详情
*/
export interface OpsWorkflow {
/**
* 任务数量
*/
TaskCount?: number;
/**
* 文件名
注意：此字段可能返回 null，表示取不到有效值。
*/
FolderName?: string;
/**
* 工作流文件id
*/
FolderId?: string;
/**
* 工作流id
*/
WorkflowId?: string;
/**
* 工作流名称
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowName?: string;
/**
* 工作流类型
- cycle周期
- manual手动
*/
WorkflowType?: string;
/**
* 工作流描述
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowDesc?: string;
/**
* 负责人userId,多个‘；’隔开
注意：此字段可能返回 null，表示取不到有效值。
*/
OwnerUin?: string;
/**
* 项目id
*/
ProjectId?: string;
/**
* 项目名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ProjectName?: string;
/**
* 工作流状态
* ALL_RUNNING : 全部调度中
* ALL_FREEZED : 全部已暂停
* ALL_STOPPTED : 全部已下线
* PART_RUNNING : 部分调度中
* ALL_NO_RUNNING : 全部未调度
* ALL_INVALID : 全部已失效
*/
Status?: string;
/**
* 工作流创建时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime?: string;
/**
* 最近更新时间, 包含开发、生产变更
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: string;
/**
* 最近更新人，包含开发、生产变更
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateUserUin?: string;
}
/**
* CreateSQLFolder请求参数结构体
*/
export interface CreateSQLFolderRequest {
/**
* 文件夹名称
*/
FolderName: string;
/**
* 项目id
*/
ProjectId: string;
/**
* 父文件夹path，/aaa/bbb/ccc，路径头需带斜杠，查询根目录传/
*/
ParentFolderPath: string;
/**
* 权限范围：SHARED, PRIVATE
*/
AccessScope?: string;
}
/**
* GetOpsTask返回参数结构体
*/
export interface GetOpsTaskResponse {
/**
* 任务详情
*/
Data?: Task;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateTriggerTask返回参数结构体
*/
export interface UpdateTriggerTaskResponse {
/**
* 任务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
Data?: UpdateTaskResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteQualityRuleGroup请求参数结构体
*/
export interface DeleteQualityRuleGroupRequest {
/**
* 项目Id
*/
ProjectId: string;
/**
* 监控任务id
*/
RuleGroupIdList: Array<number | bigint>;
}
/**
* 查询任务信息分页
*/
export interface ListTriggerTaskInfo {
/**
* 任务数组
注意：此字段可能返回 null，表示取不到有效值。
*/
Items?: Array<TriggerTaskBaseAttribute>;
/**
* 当前请求的数据页数
注意：此字段可能返回 null，表示取不到有效值。
*/
PageNumber?: number;
/**
* 当前请求的数据页条数
注意：此字段可能返回 null，表示取不到有效值。
*/
PageSize?: number;
/**
* 满足查询条件的数据总条数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount?: number;
/**
* 满足查询条件的数据总页数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalPageNumber?: number;
}
/**
* 停止sql运行结果
*/
export interface SQLStopResult {
/**
* 是否成功
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: boolean;
}
/**
* 资源组操作状态
*/
export interface ResourceStatus {
/**
* 资源组操作状态
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: boolean;
}
/**
* 数据质量规则
*/
export interface QualityRule {
/**
* 规则ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleId?: number;
/**
* 规则组ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleGroupId?: number;
/**
* 数据表Id
注意：此字段可能返回 null，表示取不到有效值。
*/
TableId?: string;
/**
* 规则名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 规则类型 1.系统模版, 2.自定义模版, 3.自定义SQL
注意：此字段可能返回 null，表示取不到有效值。
*/
Type?: number;
/**
* 规则模板Id
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleTemplateId?: number;
/**
* 规则模板概述
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleTemplateContent?: string;
/**
* 规则所属质量维度 1：准确性，2：唯一性，3：完整性，4：一致性，5：及时性，6：有效性
注意：此字段可能返回 null，表示取不到有效值。
*/
QualityDim?: number;
/**
* 规则适用的源数据对象类型（1：常量，2：离线表级，3：离线字段级别）
注意：此字段可能返回 null，表示取不到有效值。
*/
SourceObjectType?: number;
/**
* 规则适用的源数据对象类型（1：数值，2：字符串）
注意：此字段可能返回 null，表示取不到有效值。
*/
SourceObjectDataType?: number;
/**
* 源字段详细类型，INT、STRING
注意：此字段可能返回 null，表示取不到有效值。
*/
SourceObjectDataTypeName?: string;
/**
* 源字段名称
注意：此字段可能返回 null，表示取不到有效值。
*/
SourceObjectValue?: string;
/**
* 检测范围 1.全表, 2.条件扫描
注意：此字段可能返回 null，表示取不到有效值。
*/
ConditionType?: number;
/**
* 条件扫描WHERE条件表达式
注意：此字段可能返回 null，表示取不到有效值。
*/
ConditionExpression?: string;
/**
* 自定义SQL
注意：此字段可能返回 null，表示取不到有效值。
*/
CustomSql?: string;
/**
* 报警触发条件
注意：此字段可能返回 null，表示取不到有效值。
*/
CompareRule?: QualityCompareRule;
/**
* 报警触发级别 1.低, 2.中, 3.高
注意：此字段可能返回 null，表示取不到有效值。
*/
AlarmLevel?: number;
/**
* 规则描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Description?: string;
/**
* 规则配置人
注意：此字段可能返回 null，表示取不到有效值。
*/
Operator?: string;
/**
* 目标库Id
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetDatabaseId?: string;
/**
* 目标库名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetDatabaseName?: string;
/**
* 目标表Id
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetTableId?: string;
/**
* 目标表名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetTableName?: string;
/**
* 目标字段过滤条件表达式
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetConditionExpr?: string;
/**
* 源字段与目标字段关联条件on表达式
注意：此字段可能返回 null，表示取不到有效值。
*/
RelConditionExpr?: string;
/**
* 自定义模版sql表达式参数
注意：此字段可能返回 null，表示取不到有效值。
*/
FieldConfig?: QualityRuleFieldConfig;
/**
* 是否关联多表
注意：此字段可能返回 null，表示取不到有效值。
*/
MultiSourceFlag?: boolean;
/**
* 是否where参数
注意：此字段可能返回 null，表示取不到有效值。
*/
WhereFlag?: boolean;
/**
* 模版原始SQL
注意：此字段可能返回 null，表示取不到有效值。
*/
TemplateSql?: string;
/**
* 模版子维度：0.父维度类型,1.一致性: 枚举范围一致性,2.一致性：数值范围一致性,3.一致性：字段数据相关性
注意：此字段可能返回 null，表示取不到有效值。
*/
SubQualityDim?: number;
/**
* 规则适用的目标数据对象类型（1：常量，2：离线表级，3：离线字段级别）
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetObjectType?: number;
/**
* 规则适用的目标数据对象类型（1：数值，2：字符串）
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetObjectDataType?: number;
/**
* 目标字段详细类型，INT、STRING
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetObjectDataTypeName?: string;
/**
* 目标字段名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetObjectValue?: string;
/**
* 源端对应的引擎类型
注意：此字段可能返回 null，表示取不到有效值。
*/
SourceEngineTypes?: Array<number | bigint>;
/**
* 表名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TableName?: string;
/**
* 表负责人名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TableOwnerName?: string;
/**
* 执行策略信息
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecStrategy?: QualityRuleGroupExecStrategy;
/**
* 订阅信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Subscription?: QualityRuleGroupSubscribe;
/**
* 创建时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime?: string;
/**
* 数据源 id
注意：此字段可能返回 null，表示取不到有效值。
*/
DatasourceId?: number;
/**
* 数据库 id
注意：此字段可能返回 null，表示取不到有效值。
*/
DatabaseId?: string;
/**
* 监控是否开启.0false,1true
注意：此字段可能返回 null，表示取不到有效值。
*/
MonitorStatus?: number;
/**
* 触发条件
注意：此字段可能返回 null，表示取不到有效值。
*/
TriggerCondition?: string;
/**
* 0或者未返回或者null：未定义，1：生产，2：开发
注意：此字段可能返回 null，表示取不到有效值。
*/
DsEnvType?: number;
/**
* 数据源类型
注意：此字段可能返回 null，表示取不到有效值。
*/
DatasourceType?: number;
/**
* 模式名称
注意：此字段可能返回 null，表示取不到有效值。
*/
SchemaName?: string;
/**
* 目标模式名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetSchemaName?: string;
/**
* 项目id
注意：此字段可能返回 null，表示取不到有效值。
*/
ProjectId?: string;
/**
* 项目名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ProjectName?: string;
/**
* 更新时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: string;
/**
* 数据源名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DatasourceName?: string;
/**
* 数据库名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DatabaseName?: string;
/**
* 失败原因
注意：此字段可能返回 null，表示取不到有效值。
*/
FailMsg?: string;
/**
* 任务类型
注意：此字段可能返回 null，表示取不到有效值。
*/
GroupType?: string;
/**
* 编排任务id
注意：此字段可能返回 null，表示取不到有效值。
*/
AspectTaskId?: string;
/**
* 数据目录
注意：此字段可能返回 null，表示取不到有效值。
*/
CatalogName?: string;
/**
* 目标表的数据目录
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetCatalogName?: string;
}
/**
* EnableProject返回参数结构体
*/
export interface EnableProjectResponse {
/**
* 无
*/
Data?: ProjectResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListCatalogPage
*/
export interface ListCatalogPage {
/**
* 目录记录列表
*/
Items?: Array<CatalogInfo>;
/**
* 分页总页数
*/
PageCount?: number;
/**
* 分页大小
*/
PageSize?: number;
/**
* 分页页码
*/
PageNumber?: number;
/**
* 记录总数
*/
TotalCount?: number;
}
/**
* CreateProjectMember请求参数结构体
*/
export interface CreateProjectMemberRequest {
/**
* 项目id
*/
ProjectId: string;
/**
* 用户id
*/
UserUins: Array<string>;
/**
* 角色id
*/
RoleIds: Array<string>;
}
/**
* DeleteLineage返回参数结构体
*/
export interface DeleteLineageResponse {
/**
* 删除结果
*/
Data?: OperateResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 调度任务实例详情
*/
export interface TaskInstanceDetail {
/**
* 所属项目id
注意：此字段可能返回 null，表示取不到有效值。
*/
ProjectId?: string;
/**
* **实例唯一标识**
注意：此字段可能返回 null，表示取不到有效值。
*/
InstanceKey?: string;
/**
* 文件夹ID
注意：此字段可能返回 null，表示取不到有效值。
*/
FolderId?: string;
/**
* 文件夹名称
注意：此字段可能返回 null，表示取不到有效值。
*/
FolderName?: string;
/**
* 工作流ID
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowId?: string;
/**
* 工作流名称
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowName?: string;
/**
* 任务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskId?: string;
/**
* 任务名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskName?: string;
/**
* taskType对应的id
*/
TaskTypeId?: number;
/**
* 任务类型
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskType?: string;
/**
* **任务周期类型**
* ONEOFF_CYCLE: 一次性
* YEAR_CYCLE: 年
* MONTH_CYCLE: 月
* WEEK_CYCLE: 周
* DAY_CYCLE: 天
* HOUR_CYCLE: 小时
* MINUTE_CYCLE: 分钟
* CRONTAB_CYCLE: crontab表达式类型
注意：此字段可能返回 null，表示取不到有效值。
*/
CycleType?: string;
/**
* 实例数据时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CurRunDate?: string;
/**
* **实例状态**
- WAIT_EVENT: 等待事件
- WAIT_UPSTREAM: 等待上游
- WAIT_RUN: 等待运行
- RUNNING: 运行中
- SKIP_RUNNING: 跳过运行
- FAILED_RETRY: 失败重试
- EXPIRED: 失败
- COMPLETED: 成功
注意：此字段可能返回 null，表示取不到有效值。
*/
InstanceState?: string;
/**
* **实例类型**
- 0 表示补录类型
- 1 表示周期实例
- 2 表示非周期实例
注意：此字段可能返回 null，表示取不到有效值。
*/
InstanceType?: number;
/**
* 负责人列表
注意：此字段可能返回 null，表示取不到有效值。
*/
OwnerUinList?: Array<string>;
/**
* 累计运行次数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalRunNum?: number;
/**
* 每次运行失败，下发重试次数限制
注意：此字段可能返回 null，表示取不到有效值。
*/
TryLimit?: number;
/**
* **失败重试次数**
再次使用 手动重跑 或 补录实例等方式触发运行时，会被重置为 0 后重新计数
注意：此字段可能返回 null，表示取不到有效值。
*/
Tries?: number;
/**
* 耗费时间, 单位ms
注意：此字段可能返回 null，表示取不到有效值。
*/
CostTime?: number;
/**
* 运行开始时间
注意：此字段可能返回 null，表示取不到有效值。
*/
StartTime?: string;
/**
* 运行完成时间
注意：此字段可能返回 null，表示取不到有效值。
*/
EndTime?: string;
/**
* 计划调度时间
注意：此字段可能返回 null，表示取不到有效值。
*/
SchedulerTime?: string;
/**
* 实例最近更新时间, 时间格式为 yyyy-MM-dd HH:mm:ss
注意：此字段可能返回 null，表示取不到有效值。
*/
LastUpdateTime?: string;
/**
* 执行资源组ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecutorGroupId?: string;
/**
* 资源组名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecutorGroupName?: string;
/**
* 简要的任务失败信息
注意：此字段可能返回 null，表示取不到有效值。
*/
JobErrorMsg?: string;
}
/**
* 创建任务文件夹结果
*/
export interface CreateTaskFolderResult {
/**
* 创建成功的文件夹ID。如果创建失败则报错。
*/
TaskFolderId?: string;
}
/**
* 规则执行结果
*/
export interface QualityRuleExecResult {
/**
* 规则执行ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleExecId?: number;
/**
* 规则组执行ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleGroupExecId?: number;
/**
* 规则组ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleGroupId?: number;
/**
* 规则ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleId?: number;
/**
* 规则名称
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleName?: string;
/**
* 规则类型 1.系统模版, 2.自定义模版, 3.自定义SQL
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleType?: number;
/**
* 源字段详细类型，int string
注意：此字段可能返回 null，表示取不到有效值。
*/
SourceObjectDataTypeName?: string;
/**
* 源字段名称
注意：此字段可能返回 null，表示取不到有效值。
*/
SourceObjectValue?: string;
/**
* 条件扫描WHERE条件表达式
注意：此字段可能返回 null，表示取不到有效值。
*/
ConditionExpression?: string;
/**
* 检测结果（1:检测通过，2：触发规则，3：检测失败）
注意：此字段可能返回 null，表示取不到有效值。
*/
ExecResultStatus?: number;
/**
* 触发结果，告警发送成功, 阻断任务成功
注意：此字段可能返回 null，表示取不到有效值。
*/
TriggerResult?: string;
/**
* 对比结果
注意：此字段可能返回 null，表示取不到有效值。
*/
CompareResult?: CompareQualityResult;
/**
* 模版名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TemplateName?: string;
/**
* 质量维度
注意：此字段可能返回 null，表示取不到有效值。
*/
QualityDim?: number;
/**
* 目标表-库表名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetDBTableName?: string;
/**
* 目标表-字段名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetObjectValue?: string;
/**
* 目标表-字段类型
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetObjectDataType?: string;
/**
* 自定义模版sql表达式参数
注意：此字段可能返回 null，表示取不到有效值。
*/
FieldConfig?: QualityRuleFieldConfig;
/**
* 源字段与目标字段关联条件on表达式
注意：此字段可能返回 null，表示取不到有效值。
*/
RelConditionExpr?: string;
/**
* 执行时间
注意：此字段可能返回 null，表示取不到有效值。
*/
StartTime?: string;
/**
* 1/2/3:低/中/高
注意：此字段可能返回 null，表示取不到有效值。
*/
AlarmLevel?: number;
/**
* 触发条件
注意：此字段可能返回 null，表示取不到有效值。
*/
TriggerCondition?: string;
/**
* 任务名称
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleGroupName?: string;
/**
* 数据源ID
注意：此字段可能返回 null，表示取不到有效值。
*/
DatasourceId?: string;
/**
* 数据源名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DatasourceName?: string;
/**
* 数据库名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DatabaseName?: string;
/**
* 模式名称
注意：此字段可能返回 null，表示取不到有效值。
*/
SchemaName?: string;
/**
* 表名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TableName?: string;
/**
* 判断是否屏蔽监控 0.屏蔽 1.不屏蔽
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleGroupExist?: number;
/**
* 数据源类型
注意：此字段可能返回 null，表示取不到有效值。
*/
DatasourceType?: number;
/**
* 数据表id
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleGroupTableId?: number;
/**
* 监控方式 1.未配置, 2.关联生产调度, 3.离线周期检测
注意：此字段可能返回 null，表示取不到有效值。
*/
MonitorType?: number;
/**
* 执行结束时间
注意：此字段可能返回 null，表示取不到有效值。
*/
FinishTime?: string;
/**
* 监控任务类型
注意：此字段可能返回 null，表示取不到有效值。
*/
GroupType?: string;
/**
* 编排任务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
AspectTaskId?: string;
/**
* 数据目录
注意：此字段可能返回 null，表示取不到有效值。
*/
CatalogName?: string;
/**
* 规则执行状态（0：初始状态，1：运行中，2：运行成功，3：运行失败，4：被杀死）
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleExecStatus?: number;
}
/**
* 项目的用户对象
*/
export interface ProjectUserRole {
/**
* 租户id
注意：此字段可能返回 null，表示取不到有效值。
*/
AppId?: string;
/**
* 主账号id
注意：此字段可能返回 null，表示取不到有效值。
*/
RootAccountId?: string;
/**
* 用户id
注意：此字段可能返回 null，表示取不到有效值。
*/
UserUin?: string;
/**
* 用户名
注意：此字段可能返回 null，表示取不到有效值。
*/
UserName?: string;
/**
* 显示名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DisplayName?: string;
/**
* 用户角色对象
注意：此字段可能返回 null，表示取不到有效值。
*/
Roles?: Array<SystemRole>;
/**
* 是否创建者
注意：此字段可能返回 null，表示取不到有效值。
*/
IsCreator?: boolean;
/**
* 创建时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime?: string;
/**
* 是否项目负责人
注意：此字段可能返回 null，表示取不到有效值。
*/
IsProjectOwner?: boolean;
/**
* 手机号
注意：此字段可能返回 null，表示取不到有效值。
*/
PhoneNum?: string;
/**
* 邮箱
注意：此字段可能返回 null，表示取不到有效值。
*/
Email?: string;
}
/**
* 依赖任务信息
*/
export interface TaskDependDto {
/**
* 任务Id
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskId?: string;
/**
* 任务名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskName?: string;
/**
* 工作流id
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowId?: string;
/**
* 工作流名称
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowName?: string;
/**
* 项目id
注意：此字段可能返回 null，表示取不到有效值。
*/
ProjectId?: string;
/**
* 任务状态:
- Y: 运行
- F: 停止
- O: 冻结
- T: 停止中
- INVALID: 已失效
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: string;
/**
* 任务类型id
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskTypeId?: number;
/**
* 任务类型描述
- 20 : 通用数据同步
- 25 : ETLTaskType
- 26 : ETLTaskType
- 30 : python
- 31 : pyspark
- 34 : hivesql
- 35 : shell
- 36 : sparksql
- 21 : jdbcsql
- 32 : dlc
- 33 : ImpalaTaskType
- 40 : CDWTaskType
- 41 : kettle
- 42 : TCHouse-X
- 43 : TCHouse-X SQL
- 46 : dlcsparkTaskType
- 47 : TiOneMachineLearningTaskType
- 48 : Trino
- 50 : DLCPyspark
- 23 : TencentDistributedSQL
- 39 : spark
- 92 : MRTaskType
- 38 : ShellScript
- 70 : HiveSQLScrip
- 130 : 分支
- 131 : 归并
- 132 : Notebook探索
- 133 : SSH节点
- 134 : StarRocks
- 137 : For-each
- 10000 : 自定义业务通用
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskTypeDesc?: string;
/**
* 调度计划展示描述信息
注意：此字段可能返回 null，表示取不到有效值。
*/
ScheduleDesc?: string;
/**
* 任务开始时间
注意：此字段可能返回 null，表示取不到有效值。
*/
StartTime?: string;
/**
* 任务结束时间
注意：此字段可能返回 null，表示取不到有效值。
*/
EndTime?: string;
/**
* 延迟时间
注意：此字段可能返回 null，表示取不到有效值。
*/
DelayTime?: number;
/**
* 周期类型：默认为 D
支持的类型为
* O: 一次性
* Y: 年
* M: 月
* W: 周
* D: 天
* H: 小时
* I: 分钟
* C: crontab表达式类型
注意：此字段可能返回 null，表示取不到有效值。
*/
CycleType?: string;
/**
* 负责人
注意：此字段可能返回 null，表示取不到有效值。
*/
OwnerUin?: string;
/**
* 弹性周期配置
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskAction?: string;
/**
* 调度初始化策略
注意：此字段可能返回 null，表示取不到有效值。
*/
InitStrategy?: string;
/**
* crontab表达式
注意：此字段可能返回 null，表示取不到有效值。
*/
CrontabExpression?: string;
}
/**
* 数据开发权限删除结果
*/
export interface DeleteWorkflowPermissionsResult {
/**
* 整体删除结果 true/false
*/
Status?: boolean;
}
/**
* SetSuccessTaskInstancesAsync请求参数结构体
*/
export interface SetSuccessTaskInstancesAsyncRequest {
/**
* 项目Id
*/
ProjectId: string;
/**
* 实例id列表,可以从ListInstances中获取
*/
InstanceKeyList: Array<string>;
}
/**
* GetOpsTaskCode返回参数结构体
*/
export interface GetOpsTaskCodeResponse {
/**
* 获取任务代码结果
*/
Data?: TaskCode;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListWorkflows返回参数结构体
*/
export interface ListWorkflowsResponse {
/**
* 查询工作流分页信息
*/
Data?: ListWorkflowInfo;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateProject返回参数结构体
*/
export interface CreateProjectResponse {
/**
* 创建项目结果
*/
Data?: CreateProjectResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 告警规则项目波动率告警配置信息
*/
export interface ProjectInstanceStatisticsAlarmInfo {
/**
* 告警类型
projectFailureInstanceUpwardFluctuationAlarm: 失败实例向上波动告警
projectSuccessInstanceDownwardFluctuationAlarm： 成功实例向下波动告警
*/
AlarmType: string;
/**
* 实例成功数向下波动比例告警阀值；实例失败数向上波动比例告警阀值
*/
InstanceThresholdCountPercent?: number;
/**
* 累计实例数波动阀值
*/
InstanceThresholdCount?: number;
/**
* 稳定性次数阈值(防抖动配置统计周期数)
*/
StabilizeThreshold?: number;
/**
* 稳定性统计周期(防抖动配置统计周期数)
*/
StabilizeStatisticsCycle?: number;
/**
* 是否累计计算,false:连续,true:累计
*/
IsCumulant?: boolean;
/**
* 当日累计实例数;
当天失败实例数向下波动量
*/
InstanceCount?: number;
}
/**
* DeleteProject返回参数结构体
*/
export interface DeleteProjectResponse {
/**
* 删除结果
*/
Data?: ProjectResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 规则变量替换
*/
export interface QualityRuleFieldConfig {
/**
* where变量
注意：此字段可能返回 null，表示取不到有效值。
*/
WhereConfig?: Array<QualityFieldConfig>;
/**
* 库表变量
注意：此字段可能返回 null，表示取不到有效值。
*/
TableConfig?: Array<QualityTableConfig>;
}
/**
* 工作流列表查询
*/
export interface TriggerWorkflowResult {
/**
* 总记录数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount?: number;
/**
* 页数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalPageNumber?: number;
/**
* 页码
注意：此字段可能返回 null，表示取不到有效值。
*/
PageNumber?: number;
/**
* 页大小
注意：此字段可能返回 null，表示取不到有效值。
*/
PageSize?: number;
/**
* 工作流信息集合
注意：此字段可能返回 null，表示取不到有效值。
*/
Items?: Array<TriggerWorkflowBrief>;
}
/**
* 数据探索文件授权结果
*/
export interface CodePermissionsResultItem {
/**
* 资源id
注意：此字段可能返回 null，表示取不到有效值。
*/
Item?: string;
/**
* 该资源权限操作是否成功
注意：此字段可能返回 null，表示取不到有效值。
*/
Result?: boolean;
/**
* 若是创建失败, 提供失败原因
注意：此字段可能返回 null，表示取不到有效值。
*/
Reason?: string;
}
/**
* GetTaskVersion返回参数结构体
*/
export interface GetTaskVersionResponse {
/**
* 版本详情
注意：此字段可能返回 null，表示取不到有效值。
*/
Data?: TaskVersionDetail;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetOpsWorkflow请求参数结构体
*/
export interface GetOpsWorkflowRequest {
/**
* 项目Id
*/
ProjectId: string;
/**
* 工作流Id，可以从ListOpsWorkflows接口获取
*/
WorkflowId: string;
}
/**
* ListTaskVersions返回参数结构体
*/
export interface ListTaskVersionsResponse {
/**
* <p>版本列表</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Data?: ListTaskVersions;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 查询数据源分页列表
*/
export interface ProjectBrief {
/**
* 分页页码
注意：此字段可能返回 null，表示取不到有效值。
*/
PageNumber?: number;
/**
* 分页大小
注意：此字段可能返回 null，表示取不到有效值。
*/
PageSize?: number;
/**
* 数据源列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Items?: Array<Project>;
/**
* 总数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount?: number;
/**
* 总页码
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalPage