AdhocDetail
子任务记录
被如下接口引用:SubmitSqlTask。
名称 | 类型 | 描述 |
---|---|---|
Id | Integer | 子任务记录Id 示例值:11111 |
ScriptContent | String | 脚本内容 示例值:select 1 |
StartTime | Timestamp ISO8601 | 任务启动时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-04-15T15:36:34+08:00 |
EndTime | Timestamp ISO8601 | 任务结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-04-15T15:36:34+08:00 |
Status | String | 当前任务状态 示例值:CREATED |
RecordId | Integer | 提交任务id 示例值:11111 |
AdhocRecord
任务提交记录
被如下接口引用:SubmitSqlTask。
名称 | 类型 | 描述 |
---|---|---|
Id | Integer | 任务提交记录id 注意:此字段可能返回 null,表示取不到有效值。 示例值:11111 |
ScriptContent | String | 脚本内容 注意:此字段可能返回 null,表示取不到有效值。 示例值:\n\n\n\n\nselect 1\n |
CreateTime | Timestamp ISO8601 | 任务提交时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-04-15T15:36:34+08:00 |
Status | String | 任务状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:CREATED |
InstanceId | String | 实例id 注意:此字段可能返回 null,表示取不到有效值。 示例值:20220218112409315_2022-03-02T12:34:03+08:00 |
AgentStatus
Agent采集器状态统计
被如下接口引用:DescribeIntegrationTask。
名称 | 类型 | 描述 |
---|---|---|
Running | Integer | 运行中的数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
Abnormal | Integer | 异常的数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:6 |
InOperation | Integer | 操作中的数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:7 |
AiOpsEventListenerDTO
监听事件
被如下接口引用:DescribeAllByFolderNew, DescribeDependTaskLists, DescribeSuccessorOpsTaskInfos, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EventName | String | 否 | 事件名 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectDisplayName | String | 否 | 项目展示名 注意:此字段可能返回 null,表示取不到有效值。 |
EventSubType | String | 否 | 事件周期 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 否 | 事件项目ID 注意:此字段可能返回 null,表示取不到有效值。 |
PropertiesList | Array of ParamInfoDs | 否 | 扩展名 注意:此字段可能返回 null,表示取不到有效值。 |
EventBroadcastType | String | 否 | 事件广播类型 注意:此字段可能返回 null,表示取不到有效值。 |
AiopsDLCResourceConfigDto
DLC资源配置信息
被如下接口引用:DescribeAllByFolderNew, DescribeDependTaskLists, DescribeSuccessorOpsTaskInfos, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DriverSize | String | 否 | Driver资源 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutorSize | String | 否 | Executor资源 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutorNumbers | String | 否 | Executor数量 注意:此字段可能返回 null,表示取不到有效值。 |
IsInherit | String | 否 | 资源配置方式 注意:此字段可能返回 null,表示取不到有效值。 |
AiopsScriptInfo
数据运维脚本信息
被如下接口引用:DescribeAllByFolderNew, DescribeDependTaskLists, DescribeSuccessorOpsTaskInfos, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ScriptContent | String | 是 | 脚本内容 注意:此字段可能返回 null,表示取不到有效值。 |
CosPath | String | 是 | 脚本所在COS的路径 注意:此字段可能返回 null,表示取不到有效值。 |
CosRegion | String | 是 | 脚本所在COS的地域 注意:此字段可能返回 null,表示取不到有效值。 |
CosBucketName | String | 是 | 脚本所在COS的桶名称 注意:此字段可能返回 null,表示取不到有效值。 |
AiopsSimpleTaskDto
父任务simple信息
被如下接口引用:DescribeAllByFolderNew, DescribeDependTaskLists, DescribeSuccessorOpsTaskInfos, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 否 | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 |
TaskName | String | 否 | 任务名 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 否 | 任务状态 注意:此字段可能返回 null,表示取不到有效值。 |
CycleType | String | 否 | 周期类型 注意:此字段可能返回 null,表示取不到有效值。 |
Creator | String | 否 | 任务创建人 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowId | String | 否 | 工作流id 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowName | String | 否 | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 否 | 项目id 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectIdent | String | 否 | 项目标识 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectName | String | 否 | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 |
ConfigType | String | 否 | 配置策略 注意:此字段可能返回 null,表示取不到有效值。 |
TimeDimension | String | 否 | 时间维度 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceScope | String | 否 | 实例范围 注意:此字段可能返回 null,表示取不到有效值。 |
ExectuorPolicy | String | 否 | 执行策略 注意:此字段可能返回 null,表示取不到有效值。 |
AlarmEventInfo
告警事件详情
被如下接口引用:DescribeAlarmEvents。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AlarmId | String | 是 | 告警ID 示例值:4523 |
AlarmTime | String | 是 | 告警时间 示例值:2020-10-10 10:10:10 |
TaskId | String | 是 | 任务ID 示例值:74567 |
RegularName | String | 是 | 规则名称 示例值:hjgjh |
AlarmLevel | Integer | 是 | 告警级别,0表示普通,1表示重要,2表示紧急 示例值:1 |
AlarmWay | Integer | 是 | 告警方式,多个用逗号隔开(1:邮件,2:短信,3:微信,4:语音,5:代表企业微信,6:http) 示例值:1,2,3 |
AlarmRecipientId | String | 是 | 告警接收人Id,多个用逗号隔开 示例值:780798 |
ProjectId | String | 是 | 项目ID 示例值:8765 |
AlarmIndicator | Integer | 否 | 告警指标,0表示任务失败,1表示任务运行超时,2表示任务停止,3表示任务暂停 示例值:1 |
AlarmIndicatorDesc | String | 否 | 告警指标描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:hgff |
TriggerType | Integer | 否 | 指标阈值,1表示离线任务第一次运行失败,2表示离线任务所有重试完成后失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
EstimatedTime | Integer | 否 | 预计的超时时间,分钟级别 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
InstanceId | String | 否 | 实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:865764 |
TaskName | String | 否 | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:ggrt |
IsSendSuccess | Integer | 否 | 0:部分成功,1:全部成功,2:全部失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
InQuitePeriods | Integer | 否 | 是否在免打扰时间内,0:否, 1:是 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
RecordId | Integer | 否 | 告警记录id 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
MessageId | String | 否 | 消息ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:kuytujnv |
Operator | Integer | 否 | 阈值计算算子,1 : 大于 2 :小于 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RegularId | String | 否 | 告警规则ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:11 |
AlarmRecipientName | String | 否 | 告警接收人昵称 注意:此字段可能返回 null,表示取不到有效值。 示例值:dsf |
TaskType | Integer | 否 | 告警任务类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:202 |
SendResult | String | 否 | 发送结果 注意:此字段可能返回 null,表示取不到有效值。 示例值:dsf |
MonitorObjectId | String | 否 | 监控对象id 注意:此字段可能返回 null,表示取不到有效值。 示例值:89 |
MonitorObjectName | String | 否 | 监控对象名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:名称A |
Threshold | Float | 否 | 指标阈值 注意:此字段可能返回 null,表示取不到有效值。 示例值:80 |
AlarmReason | String | 否 | 告警原因 注意:此字段可能返回 null,表示取不到有效值。 示例值:原因 |
IndicatorTimeRangeValue | Integer | 否 | 近范围值 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
IndicatorTimeRangeUnit | String | 否 | 近范围单位 注意:此字段可能返回 null,表示取不到有效值。 示例值:day |
SyncType | Integer | 否 | 同步类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AlarmIndicatorInfo
告警指标
被如下接口引用:BatchCreateIntegrationTaskAlarms, CreateTaskAlarmRegular, DescribeTaskAlarmRegulations, ModifyTaskAlarmRegular。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | String | 否 | 指标id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
AlarmIndicator | Integer | 否 | 告警指标,0任务失败,1任务运行超时,2任务停止,3任务暂停, 4读取速度,5写入速度,6读取吞吐 7写入吞吐, 8脏数据字节数,9脏数据条数,10任务异常,11任务检测异常, 12重启次数, 13任务延时, 14近20分内的重启次数 15传输延迟,16业务延迟, 50离线包CPU使用率, 51离线包内存使用率, 52离线包并行度使用率, 53离线包排队中的实例数, 54实时包资源使用率, 55实时包运行中的任务数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AlarmIndicatorDesc | String | 否 | 告警指标描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:任务失败 |
TriggerType | Integer | 否 | 指标阈值,1表示离线任务第一次运行失败,2表示离线任务所有重试完成后失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
EstimatedTime | Integer | 否 | 预计的超时时间,分钟级别 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
Operator | Integer | 否 | 告警阈值的算子,1 大于,2 小于 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AlarmIndicatorUnit | String | 否 | 告警指标阈值单位:ms(毫秒)、s(秒)、min(分钟) 注意:此字段可能返回 null,表示取不到有效值。 示例值:ms |
Duration | Integer | 否 | 告警周期 示例值:1 |
DurationUnit | String | 否 | 告警周期单位:hour,minute,day 示例值:minute |
MaxTimes | Integer | 否 | 周期内最多告警次数 示例值:1 |
Threshold | Float | 否 | 指标阈值 注意:此字段可能返回 null,表示取不到有效值。 示例值:50 |
IndicatorTimeRangeUnit | String | 否 | 时间范围单位 注意:此字段可能返回 null,表示取不到有效值。 示例值:minute |
IndicatorTimeRangeValue | Integer | 否 | 时间范围值 注意:此字段可能返回 null,表示取不到有效值。 示例值:12 |
AlarmInfo
任务告警信息
被如下接口引用:SetTaskAlarmNew。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskIds | String | 是 | 关联任务id 示例值:111,111 |
AlarmType | String | 是 | 告警类别;failure表示失败告警;overtime表示超时告警 示例值:failure |
AlarmWay | String | 是 | 告警方式;SMS表示短信;Email表示邮件;HTTP 表示接口方式;Wechat表示微信方式 示例值:SMS,Email |
AlarmRecipient | String | 是 | 告警接收人,多个告警接收人以;分割 示例值:wang;zhang |
AlarmRecipientId | String | 是 | 告警接收人id,多个告警接收人id以;分割 示例值:111;222 |
Hours | Integer | 是 | 预计运行的小时,取值范围0-23 示例值:2 |
Minutes | Integer | 是 | 预计运行分钟,取值范围0-59 示例值:20 |
TriggerType | Integer | 是 | 告警出发时机;1表示第一次运行失败;2表示所有重试完成后失败; 示例值:1 |
AlarmId | String | 否 | 告警信息id 示例值:xxx |
Status | Integer | 否 | 告警状态设置;1表示可用;0表示不可用,默认可用 示例值:1 |
AlarmReceiverInfo
告警接收人详情
被如下接口引用:DescribeAlarmReceiver。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AlarmId | String | 是 | 告警ID 示例值:76 |
AlarmReceiver | String | 是 | 告警接收人ID 示例值:765645 |
Integer | 是 | 邮件,0:未设置,1:成功,2:失败 示例值:1 |
|
Sms | Integer | 是 | 短信,0:未设置,1:成功,2:失败 示例值:1 |
Integer | 是 | 微信,0:未设置,1:成功,2:失败 示例值:1 |
|
Voice | Integer | 是 | 电话,0:未设置,1:成功,2:失败 示例值:1 |
Wecom | Integer | 是 | 企业微信,0:未设置,1:成功,2:失败 示例值:1 |
Http | Integer | 是 | http,0:未设置,1:成功,2:失败 示例值:1 |
WecomGroup | Integer | 否 | 企业微信群,0:未设置,1:成功,2:失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
LarkGroup | Integer | 否 | 飞书群,0:未设置,1:成功,2:失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Apply
审批列表信息
被如下接口引用:DescribeApproveList。
名称 | 类型 | 描述 |
---|---|---|
ApplicantId | String | 申请人id 示例值:1001252651935 |
ApplicantName | String | 申请人名称 示例值:"test_name" |
Remark | String | 审批备注 注意:此字段可能返回 null,表示取不到有效值。 示例值:"test" |
ApproveClassification | String | 审批分类key 示例值:"db" |
ApproveId | String | 审批单id 示例值:1562 |
ApproveType | String | 审批类型key 示例值:"db_db" |
Reason | String | 申请原因 注意:此字段可能返回 null,表示取不到有效值。 示例值:"use test" |
CreateTime | String | 创建时间 示例值:"2022-04-12T06:15:16+08:00" |
ApproveTime | String | 审批时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2022-04-12T06:15:16+08:00" |
ApproveClassificationName | String | 审批分类名称 示例值:"库表申请" |
Status | String | 状态 示例值:"pass" |
ApproveTypeName | String | 审批类型名称 示例值:"库申请" |
ErrorMessage | String | 审批异常或者失败信息 示例值:"错误信息" |
ApplyName | String | 申请名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test_db153562203 |
ApproverId | String | 审批人id 注意:此字段可能返回 null,表示取不到有效值。 示例值:10065986435 |
ApproverName | String | 审批人名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"name1" |
ApproveProjectName | String | 审批所属项目 注意:此字段可能返回 null,表示取不到有效值。 示例值:"project_name" |
ApplyId | String | 审批id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
ApproveModify
修改审批单状态
被如下接口引用:ModifyApproveStatus。
名称 | 类型 | 描述 |
---|---|---|
ApproveId | String | 审批单id 示例值:1 |
Success | Boolean | 是否修改成功 示例值:true |
ApproveType
审批分类
被如下接口引用:DescribeApproveTypeList。
名称 | 类型 | 描述 |
---|---|---|
Type | String | 申请分类key 示例值:db_db |
TypeName | String | 类型名称 示例值:库申请 |
Classification | String | 申请类型key 示例值:db |
AttributeItemDTO
aiops基础信息
被如下接口引用:DescribeInstanceDetailInfo, DescribeOpsInstanceLogList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 否 | key 注意:此字段可能返回 null,表示取不到有效值。 |
Value | String | 否 | value 注意:此字段可能返回 null,表示取不到有效值。 |
Description | String | 否 | 描述 注意:此字段可能返回 null,表示取不到有效值。 |
BaseClusterInfo
集群基础信息
被如下接口引用:DescribeProject。
名称 | 类型 | 描述 |
---|---|---|
ClusterId | String | 集群id 注意:此字段可能返回 null,表示取不到有效值。 示例值:43453434sdsd |
ClusterType | String | 集群类型,EMR/CDW等 注意:此字段可能返回 null,表示取不到有效值。 示例值:EMR |
ClusterName | String | 集群名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:testcluster |
RegionCn | String | 地域中文 注意:此字段可能返回 null,表示取不到有效值。 示例值:北京 |
RegionEn | String | 地域英文 注意:此字段可能返回 null,表示取不到有效值。 示例值:beijing |
RegionArea | String | 地区 注意:此字段可能返回 null,表示取不到有效值。 示例值:beijing |
Used | Boolean | 集群是否使用 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
Status | Integer | 集群状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
StatusInfo | String | 集群状态信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:success |
StorageType | String | 集群存储类型 注意:此字段可能返回 null,表示取不到有效值。 |
ComputeType | String | 集群计算类型 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterResource | String | 集群资源量 注意:此字段可能返回 null,表示取不到有效值。 |
ChargeType | String | 集群付费方式 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
CreateTime | Timestamp ISO8601 | 集群创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2020-09-22T00:00:00+00:00 |
ExtraConf | String | 额外配置 注意:此字段可能返回 null,表示取不到有效值。 |
RangerUserName | String | ranger账号名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:user |
CdwUserName | String | cdw账号(用于展示) 注意:此字段可能返回 null,表示取不到有效值。 示例值:wedata |
BaseTenant
租户基础信息
被如下接口引用:DescribeProject。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TenantId | String | 是 | 租户id 注意:此字段可能返回 null,表示取不到有效值。 示例值:100010 |
TenantName | String | 是 | 租户标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:testtenant |
DisplayName | String | 是 | 租户显示名称,一般是中文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:测试租户 |
Description | String | 是 | 备注 注意:此字段可能返回 null,表示取不到有效值。 示例值:测试租户备注 |
OwnerUserId | String | 是 | 租户主账号 注意:此字段可能返回 null,表示取不到有效值。 示例值:12343445 |
Params | String | 是 | 租户的额外配置参数, json格式字符串 注意:此字段可能返回 null,表示取不到有效值。 |
BaseUser
基础用户信息
被如下接口引用:DescribeProject。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UserId | String | 否 | 有云的UIN,全局唯一 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
UserName | String | 否 | 用户全局唯一标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:u100019933 |
DisplayName | String | 否 | 用户显示名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:xiaoming |
PhoneNum | String | 否 | 电话号码 注意:此字段可能返回 null,表示取不到有效值。 示例值:18888888888 |
String | 否 | 邮箱 注意:此字段可能返回 null,表示取不到有效值。 示例值:test@test.com |
BatchCreateTaskVersionDTO
BatchCreateTaskVersion使用,描述任务信息
被如下接口引用:BatchCreateTaskVersionAsync, CreateTaskVersionDs。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 是 | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
VersionRemark | String | 否 | VersionRemark 注意:此字段可能返回 null,表示取不到有效值。 示例值:ABC |
FolderId | String | 否 | 文件夹ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:ABC |
BatchOperateResult
批量操作的结果返回
被如下接口引用:SetTaskAlarmNew。
名称 | 类型 | 描述 |
---|---|---|
SuccessCount | Integer | 批量操作成功数 示例值:0 |
FailedCount | Integer | 批量操作失败数 示例值:0 |
TotalCount | Integer | 批量操作的总数 示例值:0 |
BatchOperateResultOpsDto
实例批量操作结果类
被如下接口引用:KillOpsMakePlanInstances, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances。
名称 | 类型 | 描述 |
---|---|---|
Result | Boolean | 结果 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorId | String | 错误id 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorDesc | String | 错误说明 注意:此字段可能返回 null,表示取不到有效值。 |
AsyncActionId | String | 异步操作id 注意:此字段可能返回 null,表示取不到有效值。 |
BatchOperationOpsDto
批量操作的结果返回
被如下接口引用:BatchDeleteOpsTasks, BatchModifyOpsOwners, BatchStopOpsTasks, UpdateWorkflowOwner。
名称 | 类型 | 描述 |
---|---|---|
SuccessCount | Integer | 批量操作成功数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
FailedCount | Integer | 批量操作失败数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TotalCount | Integer | 批量操作的总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
AsyncActionId | String | 异步操作记录的唯一id 注意:此字段可能返回 null,表示取不到有效值。 示例值:111222 |
BatchOpsDTO
批量操作结果,带失败原因
被如下接口引用:TriggerDsEvent。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
SuccessCount | Integer | 成功数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
FailCount | Integer | 失败数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:8 |
FailMessageList | Array of FailMessage | 失败原因 注意:此字段可能返回 null,表示取不到有效值。 |
BatchResult
批量操作结果
被如下接口引用:ModifyWorkflowSchedule。
名称 | 类型 | 描述 |
---|---|---|
Running | Integer | 正在运行的任务数 |
Success | Integer | 执行成功的任务数 |
Failed | Integer | 执行失败的任务数 |
Total | Integer | 总任务数 |
BatchResultDs
批量执行结果
被如下接口引用:RenewWorkflowSchedulerInfoDs。
名称 | 类型 | 描述 |
---|---|---|
Success | Integer | 成功数 注意:此字段可能返回 null,表示取不到有效值。 |
Failed | Integer | 失败数 注意:此字段可能返回 null,表示取不到有效值。 |
Total | Integer | 总计 注意:此字段可能返回 null,表示取不到有效值。 |
BatchReturn
操作结果
被如下接口引用:RegisterEvent, RegisterEventListener, TriggerEvent。
名称 | 类型 | 描述 |
---|---|---|
Result | Boolean | 执行结果 |
ErrorDesc | String | 执行情况备注 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorId | String | 执行情况id 注意:此字段可能返回 null,表示取不到有效值。 |
BatchTaskOperateNew
批量操作出参
被如下接口引用:BatchCreateTaskVersionAsync。
名称 | 类型 | 描述 |
---|---|---|
JobId | Integer | 操作Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
BytesSpeed
实时任务同步速度 字节/s
被如下接口引用:DescribeRealTimeTaskSpeed。
名称 | 类型 | 描述 |
---|---|---|
NodeType | String | 节点类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:SOURCE |
NodeName | String | 节点名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:mysql读取节点 |
Values | Array of SpeedValue | 速度值列表 注意:此字段可能返回 null,表示取不到有效值。 |
CollectionFolderOpsDto
文件夹列表
被如下接口引用:DescribeAllByFolderNew。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TotalCount | Integer | 否 | 总数 注意:此字段可能返回 null,表示取不到有效值。 |
TotalPage | Integer | 否 | 总页面数 注意:此字段可能返回 null,表示取不到有效值。 |
PageCount | Integer | 否 | 当前页面数量 注意:此字段可能返回 null,表示取不到有效值。 |
PageNumber | Integer | 否 | 页码 注意:此字段可能返回 null,表示取不到有效值。 |
PageSize | Integer | 否 | 每页数量 注意:此字段可能返回 null,表示取不到有效值。 |
Items | Array of FolderOpsDto | 否 | 任务信息 注意:此字段可能返回 null,表示取不到有效值。 |
CollectionInstanceOpsDto
实例列表结构体
被如下接口引用:DagInstances, DescribeScheduleInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TotalCount | Integer | 否 | 总数 注意:此字段可能返回 null,表示取不到有效值。 |
TotalPage | Integer | 否 | 总页面数 注意:此字段可能返回 null,表示取不到有效值。 |
PageCount | Integer | 否 | 当前页面数量 注意:此字段可能返回 null,表示取不到有效值。 |
PageNumber | Integer | 否 | 页码 注意:此字段可能返回 null,表示取不到有效值。 |
PageSize | Integer | 否 | 每页数量 注意:此字段可能返回 null,表示取不到有效值。 |
Items | Array of InstanceOpsDto | 否 | 实例信息 注意:此字段可能返回 null,表示取不到有效值。 |
ColumnAggregationLineage
列血缘聚合信息
被如下接口引用:DescribeColumnLineage。
名称 | 类型 | 描述 |
---|---|---|
TableName | String | 表名 注意:此字段可能返回 null,表示取不到有效值。 |
ParentId | String | 父节点ID 注意:此字段可能返回 null,表示取不到有效值。 |
MetastoreType | String | 元数据类型 注意:此字段可能返回 null,表示取不到有效值。 |
ParentSet | String | 字符串类型的父节点集合 注意:此字段可能返回 null,表示取不到有效值。 |
ChildSet | String | 字符串类型的子节点集合 注意:此字段可能返回 null,表示取不到有效值。 |
ColumnInfoSet | Array of SimpleColumnInfo | 列信息集合 注意:此字段可能返回 null,表示取不到有效值。 |
ColumnBasicInfo
表的元数据信息
被如下接口引用:DescribeFieldBasicInfo。
名称 | 类型 | 描述 |
---|---|---|
TableId | String | 表的全局唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:12345 |
DatasourceId | String | 数据源全局唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:111 |
DatasourceName | String | 数据源名 注意:此字段可能返回 null,表示取不到有效值。 示例值:emr-xx.default |
DatabaseId | String | 数据库ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatabaseName | String | 数据库名 注意:此字段可能返回 null,表示取不到有效值。 示例值:Default |
TableName | String | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:student |
ColumnName | String | 字段名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:name |
DataType | String | 数据类型,string/int等 注意:此字段可能返回 null,表示取不到有效值。 示例值:string |
ColumnType | String | 字段类型, varchar(32)/int(10)等 注意:此字段可能返回 null,表示取不到有效值。 示例值:varchar |
ColumnDefault | String | 字段默认值 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
ColumnKey | String | 索引类型, PRI/MUL/PARTITION等,普通字段该值为空串 注意:此字段可能返回 null,表示取不到有效值。 示例值:PRI |
ColumnPosition | Integer | 字段顺序标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ColumnComment | String | 字段注释 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
StoreType | String | 数据类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
ProjectId | String | 所属项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:12345 |
ProjectName | String | 所属项目英文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:project |
ProjectDisplayName | String | 所属项目中文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:项目 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-12-26 |
UpdateTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-12-26 |
Scale | Integer | 精度 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
ColumnData
ColumnItem
被如下接口引用:DiagnosePro。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EventName | String | 否 | ColumnName1 注意:此字段可能返回 null,表示取不到有效值。 示例值:ColumnName1 |
EventProjectName | String | 否 | ColumnName1 注意:此字段可能返回 null,表示取不到有效值。 示例值:ColumnName1 |
Type | String | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CurRunDate | String | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TaskId | String | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
State | String | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
EventType | String | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TaskName | String | 否 | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test_task |
ProjectName | String | 否 | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:dev_pro |
ProjectId | String | 否 | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ColumnItem
ColumnItem
被如下接口引用:DiagnosePro。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ColumnName | String | 否 | ColumnName1 注意:此字段可能返回 null,表示取不到有效值。 示例值:ColumnName1 |
ColumnRef | String | 否 | ColumnName1 注意:此字段可能返回 null,表示取不到有效值。 示例值:ColumnName1 |
ColumnLineageInfo
血缘字段信息
被如下接口引用:DescribeColumnLineage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | String | 是 | 血缘id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
DatasourceId | String | 是 | 数据源ID 注意:此字段可能返回 null,表示取不到有效值。 |
ColumnName | String | 否 | 字段名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
ColumnNameCn | String | 否 | 字段中文名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
ColumnType | String | 否 | 字段类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:int |
RelationParams | String | 否 | 关系参数 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
Params | String | 否 | 参数 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
ParentId | String | 否 | 父id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
MetastoreType | String | 否 | 元数据类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:HIVE |
MetastoreTypeName | String | 否 | 元数据类型名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Hive |
TableName | String | 否 | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
QualifiedName | String | 否 | 字段全名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:a.b.c |
DownStreamCount | Integer | 否 | 下游节点数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
UpStreamCount | Integer | 否 | 上游节点数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Description | String | 否 | 描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
PrefixPath | String | 否 | 由中心节点出发的路径信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:a,b,c |
CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-08-01 00:00:00 |
ModifyTime | String | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-08-01 00:00:00 |
Tasks | Array of String | 否 | 任务id列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:["123"] |
ParentSet | String | 否 | 父节点列表字符串 注意:此字段可能返回 null,表示取不到有效值。 |
ChildSet | String | 否 | 子节点列表字符串 注意:此字段可能返回 null,表示取不到有效值。 |
ExtParams | Array of LineageParamRecord | 否 | 额外参数 注意:此字段可能返回 null,表示取不到有效值。 |
TableId | String | 否 | 表ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:12345 |
ColumnMeta
列的元数据
被如下接口引用:DescribeColumnsMeta。
名称 | 类型 | 描述 |
---|---|---|
NameEn | String | 字段英文名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:age |
NameCn | String | 字段中文名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:年龄 |
Type | String | 字段类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:String |
Description | String | 字段描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:年龄 |
Position | Integer | 字段序号 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
IsPartition | Boolean | 是否为分区字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
Name | String | 字段名 注意:此字段可能返回 null,表示取不到有效值。 示例值:age |
ColumnFamiliesFieldSet | Array of Pair | HBase列簇属性集合 注意:此字段可能返回 null,表示取不到有效值。 |
DictionaryId | String | 对应码表字典ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DictionaryName | String | 对应码表字典名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:dict1 |
LevelName | String | 安全等级:名称 注意:此字段可能返回 null,表示取不到有效值。 |
LevelRank | Integer | 安全等级:值范围1-10 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
InfluxCategory | String | influxdb字段类别 注意:此字段可能返回 null,表示取不到有效值。 示例值:timetamp |
CommonContent
内容详情
被如下接口引用:ModifyTaskScript。
名称 | 类型 | 描述 |
---|---|---|
Content | String | 详情内容 注意:此字段可能返回 null,表示取不到有效值。 |
CommonId
Id包装对象
被如下接口引用:CreateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | String | 是 | Id值 注意:此字段可能返回 null,表示取不到有效值。 |
CommonIdOpsDto
返回命令id
被如下接口引用:CreateOpsMakePlan。
名称 | 类型 | 描述 |
---|---|---|
Id | String | 返回补录计划id 注意:此字段可能返回 null,表示取不到有效值。 示例值:"0c2dd8d6-ab68-48cc-8264-85b70ff4b291" |
CompareResult
质量检查对比结果
被如下接口引用:CommitRuleGroupTask, DescribeRuleExecDetail, DescribeRuleExecResults, DescribeRuleGroupExecResultsByPage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Items | Array of CompareResultItem | 是 | 对比结果项列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalRows | Integer | 是 | 检测总行数 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
PassRows | Integer | 是 | 检测通过行数 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TriggerRows | Integer | 是 | 检测不通过行数 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
CompareResultItem
对比结果项
被如下接口引用:CommitRuleGroupTask, DescribeRuleExecDetail, DescribeRuleExecResults, DescribeRuleGroupExecResultsByPage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
FixResult | Integer | 是 | 对比结果, 1为真 2为假 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ResultValue | String | 是 | 质量sql执行结果 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
Values | Array of ThresholdValue | 是 | 阈值列表 注意:此字段可能返回 null,表示取不到有效值。 |
Operator | String | 是 | 比较操作类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:> |
CompareType | Integer | 是 | 比较类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ValueComputeType | Integer | 是 | 值比较类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CompareRule
对比规则
被如下接口引用:CreateRule, DescribeRule, DescribeRules, ModifyRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Items | Array of CompareRuleItem | 否 | 比较条件列表 注意:此字段可能返回 null,表示取不到有效值。 |
CycleStep | Integer | 否 | 周期性模板默认周期,单位秒 注意:此字段可能返回 null,表示取不到有效值。 |
ComputeExpression | String | 否 | o 表示 或,a 表示 且,数字表示items下标 注意:此字段可能返回 null,表示取不到有效值。 示例值:((0a1)o2a3) |
CompareRuleItem
比较条件
被如下接口引用:CreateRule, DescribeRule, DescribeRules, ModifyRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CompareType | Integer | 否 | 比较类型 1.固定值 2.波动值 3.数值范围比较 4.枚举范围比较 5.不用比较 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Operator | String | 否 | 比较操作类型 < <= == => > != IRLCRO:在区间内(左闭右开) IRLORC:在区间内(左开右闭) IRLCRC:在区间内(左闭右闭) IRLORO:在区间内(左开右开) NRLCRO:不在区间内(左闭右开) NRLORC:不在区间内(左开右闭) NRLCRC:不在区间内(左闭右闭) NRLORO:不在区间内(左开右开) 注意:此字段可能返回 null,表示取不到有效值。 示例值:< |
ValueComputeType | Integer | 否 | 质量统计值类型 1.绝对值 2.上升 3. 下降 4._C包含 5. N_C不包含 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ValueList | Array of ThresholdValue | 否 | 比较阈值列表 注意:此字段可能返回 null,表示取不到有效值。 |
Content
Content
被如下接口引用:DiagnosePro。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 否 | 任务id 注意:此字段可能返回 null,表示取不到有效值。 示例值:任务id |
TaskName | String | 否 | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:任务名称 |
Diagnose | String | 否 | 诊断 注意:此字段可能返回 null,表示取不到有效值。 示例值:诊断 |
Reason | String | 否 | 理由 注意:此字段可能返回 null,表示取不到有效值。 示例值:理由 |
Operation | String | 否 | 操作 注意:此字段可能返回 null,表示取不到有效值。 示例值:操作 |
Url | String | 否 | 链接 注意:此字段可能返回 null,表示取不到有效值。 示例值:链接 |
CosTokenResponse
cos token信息
被如下接口引用:GetCosToken。
名称 | 类型 | 描述 |
---|---|---|
Id | String | token id 注意:此字段可能返回 null,表示取不到有效值。 |
Token | String | token内容 注意:此字段可能返回 null,表示取不到有效值。 |
SecretId | String | 密钥id 注意:此字段可能返回 null,表示取不到有效值。 |
SecretKey | String | 密钥内容 注意:此字段可能返回 null,表示取不到有效值。 |
Response | String | 响应 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerUin | String | 用户uin 注意:此字段可能返回 null,表示取不到有效值。 |
ExpiredTime | Integer | 过期时间 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | Integer | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | Integer | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
OperatorUin | String | 操作者uin 注意:此字段可能返回 null,表示取不到有效值。 |
CreateAndDDLSupport
是否支持creat 或ddl
被如下接口引用:DescribeTableMeta, DescribeTableMetas。
名称 | 类型 | 描述 |
---|---|---|
SupportSelect | Boolean | 是否支持select 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
SupportDdl | Boolean | 是否支持ddl 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
CreateMakeDatetimeInfo
补录计划日期范围
被如下接口引用:CreateOpsMakePlan, DescribeOpsMakePlans。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
StartDate | String | 否 | 开始日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2024-04-07" |
EndDate | String | 否 | 结束日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2024-04-10" |
StartTime | String | 否 | 开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"00:00" |
EndTime | String | 否 | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"23:59" |
DailyScoreInfo
日评分信息
被如下接口引用:DescribeQualityScoreTrend, DescribeTableScoreTrend。
名称 | 类型 | 描述 |
---|---|---|
StatisticsDate | Integer | 统计日期 时间戳 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
Score | Float | 评分 注意:此字段可能返回 null,表示取不到有效值。 示例值:12.02 |
DataCheckStat
数据监测情况结果
被如下接口引用:DescribeDataCheckStat。
名称 | 类型 | 描述 |
---|---|---|
TableTotal | Integer | 表总数 示例值:1 |
ColumnTotal | Integer | 字段总数 示例值:1 |
TableConfig | Integer | 表配置检测数 示例值:1 |
ColumnConfig | Integer | 字段配置检测数 示例值:1 |
TableExec | Integer | 表实际检测数 示例值:1 |
ColumnExec | Integer | 字段实际检测数 示例值:1 |
DataServicePublishedApiListFilter
获取数据服务API的发布态信息列表过滤条件
被如下接口引用:DescribeDataServicePublishedApiList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
PathUrl | String | 否 | 请求路径关键词筛选 示例值:test |
Keyword | String | 否 | Api名称关键词筛选 示例值:test |
AuthTypes | Array of Integer | 否 | Api认证方式筛选 0:免认证 1:应用认证 示例值:[0] |
ApiStatus | Array of Integer | 否 | 服务Api状态 1:已上线 3:已下线 示例值:[1] |
ConfigTypes | Array of Integer | 否 | API配置方式 0:向导、1、脚本、2、注册Api 示例值:[1] |
DataServiceRequestListOrder
数据服务通用排序参数
被如下接口引用:DescribeDataServicePublishedApiList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 否 | 排序参数名称 取值: CreateTime 表示按照创建时间排序 ModifyTime 表示按照更新时间排序 示例值:CreateTime, ModifyTime |
Direction | String | 否 | 排序参数顺序 示例值:ASC |
DataServiceRequestParam
数据服务入参
被如下接口引用:DescribeDataServicePublishedApiDetail。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ParamName | String | 是 | 参数名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
BindField | String | 是 | 绑定字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:123-abc |
ParamType | String | 是 | 参数类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:123-abc |
ParamPosition | String | 是 | 参数位置 注意:此字段可能返回 null,表示取不到有效值。 示例值:path |
Operator | String | 是 | 操作符 注意:此字段可能返回 null,表示取不到有效值。 示例值:= |
NonEmpty | Integer | 是 | 是否为空 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DefaultValue | String | 否 | 默认值 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ExampleValue | String | 否 | 示例值 注意:此字段可能返回 null,表示取不到有效值。 示例值:123-abc |
Description | String | 否 | 参数描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:123-abc |
DataServiceResponseParam
数据服务入参
被如下接口引用:DescribeDataServicePublishedApiDetail。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ParamName | String | 是 | 参数名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
BindField | String | 是 | 绑定字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:123-abc |
ParamType | String | 是 | 参数类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:123-abc |
ExampleValue | String | 是 | 示例值 注意:此字段可能返回 null,表示取不到有效值。 示例值:123-abc |
Description | String | 是 | 参数描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:123-abc |
DataSourceConnectStatus
数据源云梯连接状态
被如下接口引用:DescribeDataSourceList, DescribeDatasource。
名称 | 类型 | 描述 |
---|---|---|
Id | Integer | id 示例值:1 |
ProjectId | String | 项目id 示例值:1 |
DatasourceId | String | 数据源id 示例值:1 |
ConnectResult | Integer | 连接结果 示例值:1 |
ConnectError | String | 错误信息 示例值:1 |
Timestamp | Integer | 时间戳 示例值:1 |
DataSourceEnvInfo
数据源环境信息
被如下接口引用:DescribeDataSourceList, DescribeDatasource。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Env | String | 否 | 环境 注意:此字段可能返回 null,表示取不到有效值。 示例值:production |
DataSourceType | String | 否 | 数据源类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:hive |
ClusterId | String | 否 | 集群id 注意:此字段可能返回 null,表示取不到有效值。 示例值:emr-asf418ag |
Params | String | 否 | 配置信息 注意:此字段可能返回 null,表示取不到有效值。 示例值: {"key":"value"} |
ProjectId | String | 否 | 项目id 注意:此字段可能返回 null,表示取不到有效值。 示例值:156431984651549 |
DataSourceId | String | 否 | 数据源id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1235 |
EnvDataSourceId | String | 否 | env环境的数据源id 注意:此字段可能返回 null,表示取不到有效值。 示例值:6546 |
BizParams | String | 否 | 配置信息 注意:此字段可能返回 null,表示取不到有效值。 示例值: {"key":"value"} |
DataSourceInfo
数据源对象
被如下接口引用:DescribeDataSourceList, DescribeDatasource。
名称 | 类型 | 描述 |
---|---|---|
DatabaseName | String | 若数据源列表为绑定数据库,则为db名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:default |
Description | String | 数据源描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:Desc |
ID | Integer | 数据源ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:10035 |
Instance | String | 数据源引擎的实例ID,如CDB实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:null |
Name | String | 数据源名称,在相同SpaceName下,数据源名称不能为空 注意:此字段可能返回 null,表示取不到有效值。 示例值:mysql_test |
Region | String | 数据源引擎所属区域 注意:此字段可能返回 null,表示取不到有效值。 示例值:beijing |
Type | String | 数据源类型:枚举值 注意:此字段可能返回 null,表示取不到有效值。 示例值:MYSQL |
ClusterId | String | 数据源所属的集群id 注意:此字段可能返回 null,表示取不到有效值。 示例值:cdb-xxx |
AppId | Integer | 应用ID AppId 注意:此字段可能返回 null,表示取不到有效值。 示例值:87654321345678 |
BizParams | String | 业务侧数据源的配置信息扩展 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"key":"value"} |
Category | String | 数据源类别:绑定引擎、绑定数据库 注意:此字段可能返回 null,表示取不到有效值。 示例值:DB |
Display | String | 数据源展示名,为了可视化查看 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
OwnerAccount | String | 数据源责任人账号ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:100653484 |
Params | String | 数据源的配置信息,以JSON KV存储,根据每个数据源类型不同,而KV存储信息不同 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"key":"value"} |
Status | Integer | 数据源数据源的可见性,1为可见、0为不可见。默认为1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
OwnerAccountName | String | 数据源责任人账号名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:admin |
ClusterName | String | 集群名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:emr-7ih89qvf |
OwnerProjectId | String | 归属项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
OwnerProjectName | String | 归属项目Name 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
OwnerProjectIdent | String | 归属项目标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:test_ident |
AuthorityProjectName | String | 授权项目 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
AuthorityUserName | String | 授权用户 注意:此字段可能返回 null,表示取不到有效值。 示例值:aaasdg |
Edit | Boolean | 是否有编辑权限 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
Author | Boolean | 是否有授权权限 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
Deliver | Boolean | 是否有转交权限 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
DataSourceStatus | String | 数据源状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:Available |
CreateTime | Integer | 时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1712823812655 |
ParamsString | String | Params json字符串 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
BizParamsString | String | BizParams json字符串 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
ModifiedTime | Integer | 修改时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
ShowType | String | 数据源页面展示类型,与Type对应 注意:此字段可能返回 null,表示取不到有效值。 示例值:MYSQL |
ProductId | Integer | 当前数据源生产源Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:110111121 |
DevelopmentId | Integer | 当前数据源开发源Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:110111121 |
DevelopmentParams | String | 同params 内容为开发数据源的数据 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"key":"value"} |
ConnectStatus | DataSourceConnectStatus | 数据源连接状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DisplayType | String | 数据源展示类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:hive |
Env | String | 数据源环境 注意:此字段可能返回 null,表示取不到有效值。 示例值:production |
DatasourceUrn | String | 数据源唯一标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:13653851789HIVEemr-3hkbg9ej |
Model | String | 是否标准模式 注意:此字段可能返回 null,表示取不到有效值。 示例值:simple |
DataSourceEnvInfos | Array of DataSourceEnvInfo | 数据源环境信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ "Env": "production"} |
DataSourceInfoPage
查询数据源分页列表
被如下接口引用:DescribeDataSourceList。
名称 | 类型 | 描述 |
---|---|---|
PageNumber | Integer | 分页页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
PageSize | Integer | 分页大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Rows | Array of DataSourceInfo | 数据源列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
TotalPageNumber | Integer | 总分页页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatabaseInfo
数据质量数据来源数据库
被如下接口引用:DescribeDatabaseInfoList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DatasourceName | String | 否 | 数据源名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:datasource1 |
DatasourceId | String | 否 | 数据源Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
DatabaseName | String | 否 | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:database1 |
DatabaseId | String | 否 | 数据库id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
InstanceId | String | 否 | 实例Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:EMR123456 |
DatasourceType | Integer | 否 | 数据源类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
OriginDatabaseName | String | 否 | 数据库原始名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
OriginSchemaName | String | 否 | schema名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
DsEnvType | Integer | 否 | 0或者未返回.未定义,1.生产 2.开发 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ClusterDeployType | String | 否 | EMR引擎部署方式:CVM/TKE 注意:此字段可能返回 null,表示取不到有效值。 示例值:CVM |
SchemaName | String | 否 | 模式名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
DatabaseMeta
数据源元数据
被如下接口引用:DescribeDatabaseMetas。
名称 | 类型 | 描述 |
---|---|---|
ProjectId | String | 项目Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:88882 |
MetastoreType | String | 技术类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:MYSQL |
DatasourceName | String | 数据源名称 注意:此字段可能返回 null,表示取不到有效值。 |
DatasourceId | Integer | 数据源Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
ProjectName | String | 项目英文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:wedata |
Category | String | 数据源类别:绑定引擎、绑定数据库,可用值:DB,ENGINE 注意:此字段可能返回 null,表示取不到有效值。 示例值:DB |
Description | String | 数据源描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:desc |
Instance | String | 数据源引擎的实例ID,如CDB实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:cdb-abcdefg |
Region | String | 数据源引擎所属区域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-beijing |
Status | Integer | 数据源数据源的可见性,1为可见、0为不可见。默认为1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatabaseName | String | db名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:student |
ProjectDisplayName | String | 项目中文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:测试项目 |
OwnerAccountName | String | 责任人名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DisplayName | String | 数据来源展示名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxxx.xxxx |
DatabaseId | String | 数据库ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1223 |
Catalog | String | 数据来源类型:hive/mysql/hbase等 注意:此字段可能返回 null,表示取不到有效值。 示例值:hbase |
StorageSize | Integer | 存储量大小,单位为 byte 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
StorageSizeWithUnit | String | 格式化后的存储量大小,带单位,如 12B 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TableCount | Integer | 总表数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatasourceList | Array of GovDatasourceInfo | 数据源信息 注意:此字段可能返回 null,表示取不到有效值。 |
CollectJobId | String | 采集任务id 注意:此字段可能返回 null,表示取不到有效值。 |
CollectJobName | String | 采集任务名称 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterId | String | 引擎id 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterName | String | 引擎名称 注意:此字段可能返回 null,表示取不到有效值。 |
ModifiedTimeByTables | Integer | 库下表的最新更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
LastAccessTimeByTables | Integer | 库下表的最新访问时间 注意:此字段可能返回 null,表示取不到有效值。 |
DatasourceBaseInfo
数据源对象
被如下接口引用:DescribeDataSourceInfoList。
名称 | 类型 | 描述 |
---|---|---|
DatabaseNames | Array of String | 若数据源列表为绑定数据库,则为db名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Default |
Description | String | 数据源描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:Desc |
ID | Integer | 数据源ID 示例值:1 |
Instance | String | 数据源引擎的实例ID,如CDB实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:uuid |
Name | String | 数据源名称,在相同SpaceName下,数据源名称不能为空 示例值:test |
Region | String | 数据源引擎所属区域 注意:此字段可能返回 null,表示取不到有效值。 示例值:beijing |
Type | String | 数据源类型:枚举值 注意:此字段可能返回 null,表示取不到有效值。 示例值:MYSQL |
ClusterId | String | 数据源所属的集群id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Version | String | 数据源版本信息 注意:此字段可能返回 null,表示取不到有效值。 |
ParamsString | String | 数据源附带参数信息Params json字符串 注意:此字段可能返回 null,表示取不到有效值。 |
Category | String | 区分数据源类型自定义源还是系统源 注意:此字段可能返回 null,表示取不到有效值。 |
DependencyConfig
依赖配置
被如下接口引用:ModifyTaskInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DependConfType | String | 是 | 仅五种周期运行依赖配置: HOUR,DAY,WEEK,MONTH,YEAR,CRONTAB,MINUTE 示例值:HOUR |
SubordinateCyclicType | String | 是 | 依赖配置从属周期类型,CURRENT_HOUR,PREVIOUS_HOUR,CURRENT_DAY,PREVIOUS_DAY,PREVIOUS_WEEK,PREVIOUS_FRIDAY,PREVIOUS_WEEKEND,CURRENT_MONTH,PREVIOUS_MONTH,PREVIOUS_END_OF_MONTH * PREVIOUS_BEGIN_OF_MONTH,ALL_MONTH_OF_YEAR,ALL_DAY_OF_YEAR,CURRENT_YEAR,CURRENT,CURRENT_MINUTE,PREVIOUS_MINUTE_CYCLE,PREVIOUS_HOUR_CYCLE 示例值:CURRENT_HOUR |
DependencyStrategy | String | 是 | WAITING,等待(默认策略)EXECUTING:执行 示例值:WAITING |
ParentTask | TaskInnerInfo | 否 | 父任务信息 注意:此字段可能返回 null,表示取不到有效值。 |
SonTask | TaskInnerInfo | 否 | 子任务信息 注意:此字段可能返回 null,表示取不到有效值。 |
DescribeApply
申请列表
被如下接口引用:DescribeApproveList。
名称 | 类型 | 描述 |
---|---|---|
Rows | Array of Apply | 申请列表详情 示例值:{ "ApplicantId": "1000297561131", "ApplicantName": "test_0", "ApplyName": "test_db1520729990156341", "ApproveClassification": "db", "ApproveClassificationName": "库表申请", "ApproveId": "23133", "ApproveProjectName": "project_test", "ApproveTime": "2022-04-11T07:06:16+08:00", "ApproveType": "db_db", "ApproveTypeName": "库申请", "ApproverId": "100408890356", "ApproverName": "EST", "CreateTime": "2022-04-12T06:15:16+08:00", "ErrorMessage": "null", "Reason": "use test", "Remark": "test", "Status": "reject" } |
TotalPageNumber | Integer | 总分页页码 示例值:1 |
TotalCount | Integer | 总个数 示例值:1 |
PageNumber | Integer | 分页页码 示例值:1 |
PageSize | Integer | 分页大小 示例值:1 |
DescribeBatchOperateTaskDTO
批量操作任务列表
被如下接口引用:DescribeBatchOperateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 否 | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 |
TaskName | String | 否 | 任务名 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowId | String | 否 | 工作流Id 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowName | String | 否 | 工作流名 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 否 | 状态 注意:此字段可能返回 null,表示取不到有效值。 |
TaskTypeId | Integer | 否 | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 |
TaskTypeDesc | String | 否 | 任务类型 注意:此字段可能返回 null,表示取不到有效值。 |
FolderName | String | 否 | 文件夹名 注意:此字段可能返回 null,表示取不到有效值。 |
FolderId | String | 否 | 文件夹ID 注意:此字段可能返回 null,表示取不到有效值。 |
InCharge | String | 否 | 负责人 注意:此字段可能返回 null,表示取不到有效值。 |
Submit | Integer | 否 | 是否提交 注意:此字段可能返回 null,表示取不到有效值。 |
DataEngine | String | 否 | 引擎: presto\SparkJob\SparkSql 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | String | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 否 | 创造时间 注意:此字段可能返回 null,表示取不到有效值。 |
CycleUnit | String | 否 | 周期类型 注意:此字段可能返回 null,表示取不到有效值。 |
ScheduleDesc | String | 否 | 调度计划 注意:此字段可能返回 null,表示取不到有效值。 |
DatasourceId | String | 否 | 数据源ID 注意:此字段可能返回 null,表示取不到有效值。 |
DatasourceType | String | 否 | 数据源类型 注意:此字段可能返回 null,表示取不到有效值。 |
DescribeBatchOperateTaskPage
批量操作任务列表分页
被如下接口引用:DescribeBatchOperateTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
PageCount | Integer | 是 | 总页码数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Items | Array of DescribeBatchOperateTaskDTO | 是 | 内容 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 否 | 总个数 注意:此字段可能返回 null,表示取不到有效值。 |
DescribeDataServicePublishedApiDetailResp
查询数据服务API的发布态信息详情出参
被如下接口引用:DescribeDataServicePublishedApiDetail。
名称 | 类型 | 描述 |
---|---|---|
ApiName | String | 服务Api名称 示例值:1 |
PathUrl | String | 服务请求Path 示例值:/ |
OwnerName | String | 服务责任人名称 示例值:1 |
RequestType | String | 服务请求方式 示例值:POST |
ApiTagNames | String | 服务标签名称集合 注意:此字段可能返回 null,表示取不到有效值。 示例值:abcd |
ApiDescription | String | 服务描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
RequestExample | String | 服务请求返回示例 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RequestSuccess | String | 服务请求成功返回示例 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RequestError | String | 服务请求失败返回示例 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RequestParam | Array of DataServiceRequestParam | 服务请求参数列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ResponseParam | Array of DataServiceResponseParam | 服务响应参数列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
MaxAllowQps | Integer | 最大qps 示例值:100 |
MaxAllowPageSize | Integer | 最大记录数 示例值:2000 |
TimeoutPeriod | Integer | 超时时间,单位ms 示例值:5000 |
ApiId | String | ApiId 注意:此字段可能返回 null,表示取不到有效值。 示例值:20321213123 |
AuthType | Integer | 0:免认证 1:应用认证 示例值:0 |
GatewayApiUrl | String | 请求地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://127.0.0.1/test_0725_01 |
ApiStatus | Integer | 服务Api状态 1:已上线 3:已下线 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DescribeDataServicePublishedApiListResp
获取数据服务API的发布态信息列表响应内容
被如下接口引用:DescribeDataServicePublishedApiList。
名称 | 类型 | 描述 |
---|---|---|
Id | String | 服务id 示例值:1 |
ApiName | String | 服务Api名称 示例值:apiName_test |
ApiFolderName | String | 所属目录名称 示例值:abcd |
ApiTagNames | String | 服务Api标签名称集合 示例值:测试 |
OwnerName | String | 服务负责人 示例值:104593123 |
CreateTime | String | 服务创建时间 示例值:2022-05-09 12:00:00 |
ApiId | String | Api的id 示例值:"1121" |
AuthType | Integer | 服务Api认证方式 0:免认证 1:应用认证 示例值:1 |
ApiStatus | Integer | 服务Api状态 0:创建 1:已上线 2:已删除 3:已下线 示例值:1 |
ConfigType | Integer | 配置方式 0:向导、1、脚本、2、注册Api 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ModifyTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-05-09 12:00:00 |
DescribeFolderWorkflowListData
文件夹分页信息
被如下接口引用:DescribeFolderWorkflowList。
名称 | 类型 | 描述 |
---|---|---|
Items | Array of Workflow | 工作流信息列表 |
TotalCount | Integer | 总条数 示例值:10 |
PageNumber | Integer | 页号 示例值:1 |
PageSize | Integer | 页大小 示例值:10 |
DescribePendingSubmitTaskInfo
待提交任务信息
被如下接口引用:DescribePendingSubmitTaskList。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务编号 注意:此字段可能返回 null,表示取不到有效值。 示例值:1111 |
TaskName | String | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:task_test_01 |
ModifyType | String | 修改类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:N |
TaskStatus | String | 任务状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:N |
SubmitPreCheck | String | 提交预检查(Y/N) 注意:此字段可能返回 null,表示取不到有效值。 示例值:N |
SubmitPreCheckDetailList | Array of TaskSubmitPreCheckDetailInfo | 提交预检查提交可能会失败的原因 注意:此字段可能返回 null,表示取不到有效值。 示例值:依赖上游1000任务 |
ExecutorGroupId | String | 资源组编号 注意:此字段可能返回 null,表示取不到有效值。 示例值:1010101 |
ExecutorGroupName | String | 资源组名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:wedata_dev |
DiagnoseRep
DiagnoseRep
被如下接口引用:DiagnosePro。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Content | Content | 否 | 诊断信息内容 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"Content":{"Diagnose":"","Operation":"","Reason":"","TaskId":"20231227152818068","TaskName":"任务类型覆盖_离线同步_copy","Url":""} |
Table | Table | 否 | 诊断结果相关信息列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"Column":[],"Data":[]}} |
DimensionCount
维度统计业务视图
被如下接口引用:DescribeTemplateDimCount。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Count | Integer | 否 | 统计值 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
QualityDim | Integer | 否 | 维度类型1:准确性,2:唯一性,3:完整性,4:一致性,5:及时性,6:有效性 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DimensionScore
维度评分
被如下接口引用:DescribeDimensionScore。
名称 | 类型 | 描述 |
---|---|---|
DimensionScoreList | Array of DimensionScoreInfo | 维度评分列表 注意:此字段可能返回 null,表示取不到有效值。 |
DimensionScoreInfo
维度评分信息
被如下接口引用:DescribeDimensionScore。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 维度名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:准确性 |
Weight | Float | 权重 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.2 |
UserId | Integer | 设置人id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1242 |
UserName | String | 设置人名 注意:此字段可能返回 null,表示取不到有效值。 示例值:系统默认 |
UpdateTime | Integer | 更新时间 时间戳 注意:此字段可能返回 null,表示取不到有效值。 示例值:123214 |
JoinTableNumber | Integer | 参与评估表数量 示例值:1 |
Score | Float | 评分 示例值:2.1 |
UserIdStr | String | 设置人idStr 注意:此字段可能返回 null,表示取不到有效值。 示例值:"12345678" |
DlcDataGovernPolicy
数据治理配置项
被如下接口引用:GenHiveTableDDLSql。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RewriteDataPolicy | DlcRewriteDataInfo | 否 | 数据排布治理项 注意:此字段可能返回 null,表示取不到有效值。 |
ExpiredSnapshotsPolicy | DlcExpiredSnapshotsInfo | 否 | 快照过期治理项 注意:此字段可能返回 null,表示取不到有效值。 |
RemoveOrphanFilesPolicy | DlcRemoveOrphanFilesInfo | 否 | 移除孤立文件治理项 注意:此字段可能返回 null,表示取不到有效值。 |
MergeManifestsPolicy | DlcMergeManifestsInfo | 否 | 合并元数据Manifests治理项 注意:此字段可能返回 null,表示取不到有效值。 |
InheritDataBase | String | 否 | 是否集成库规则:default(默认继承)、none(不继承) 注意:此字段可能返回 null,表示取不到有效值。 示例值:default |
RuleType | String | 否 | 治理规则类型,Customize: 自定义;Intelligence: 智能治理 注意:此字段可能返回 null,表示取不到有效值。 示例值:Customize |
GovernEngine | String | 否 | 治理引擎 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
DlcExpiredSnapshotsInfo
快照过期治理项
被如下接口引用:GenHiveTableDDLSql。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ExpiredSnapshotsEnable | String | 否 | 是否启用快照过期治理项:enable、none 注意:此字段可能返回 null,表示取不到有效值。 示例值:enable |
Engine | String | 否 | 用于运行快照过期治理项的引擎名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
RetainLast | Integer | 否 | 需要保留的最近快照个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
BeforeDays | Integer | 否 | 过期指定天前的快照 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
MaxConcurrentDeletes | Integer | 否 | 清理过期快照的并行数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
IntervalMin | Integer | 否 | 快照过期治理运行周期,单位为分钟 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
DlcMergeManifestsInfo
合并元数据Manifests治理项
被如下接口引用:GenHiveTableDDLSql。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
MergeManifestsEnable | String | 否 | 是否启用合并元数据Manifests文件治理项:enable、none 注意:此字段可能返回 null,表示取不到有效值。 示例值:enable |
Engine | String | 否 | 用于运行合并元数据Manifests文件治理项的引擎名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
IntervalMin | Integer | 否 | 合并元数据Manifests文件治理运行周期,单位为分钟 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
DlcRemoveOrphanFilesInfo
移除孤立文件治理项
被如下接口引用:GenHiveTableDDLSql。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RemoveOrphanFilesEnable | String | 否 | 是否启用移除孤立文件治理项:enable、none 注意:此字段可能返回 null,表示取不到有效值。 示例值:enable |
Engine | String | 否 | 用于运行移除孤立文件治理项的引擎名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
BeforeDays | Integer | 否 | 移除指定天前的孤立文件 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
MaxConcurrentDeletes | Integer | 否 | 移除孤立文件的并行数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
IntervalMin | Integer | 否 | 移除孤立文件治理运行周期,单位为分钟 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
DlcRewriteDataInfo
数据排布治理项
被如下接口引用:GenHiveTableDDLSql。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RewriteDataEnable | String | 否 | 是否启用数据重排布治理项:enable(启动)、disable(不启用,默认) 注意:此字段可能返回 null,表示取不到有效值。 示例值:disable |
Engine | String | 否 | 用于运行数据重排布治理项的引擎名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:a |
MinInputFiles | Integer | 否 | 重排布任务执行的文件个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TargetFileSizeBytes | Integer | 否 | 数据重排布写后的数据文件大小,单位为字节 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
IntervalMin | Integer | 否 | 数据重排布治理运行周期,单位为分钟 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
DrInstanceOpsDto
试运行记录
被如下接口引用:DescribeDrInstancePage。
名称 | 类型 | 描述 |
---|---|---|
TaskSource | String | 任务来源 注意:此字段可能返回 null,表示取不到有效值。 |
JobId | String | 编排空间jobId 注意:此字段可能返回 null,表示取不到有效值。 |
RecordId | Integer | 任务提交记录Id 注意:此字段可能返回 null,表示取不到有效值。 |
SonRecordId | Integer | 子任务记录id 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceId | String | 任务实例Id 注意:此字段可能返回 null,表示取不到有效值。 |
TaskId | String | 编排空间为任务id, 开发空间为脚本id 注意:此字段可能返回 null,表示取不到有效值。 |
RemotePath | String | 脚本cos地址 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptContent | String | 试运行内容 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 任务提交时间 注意:此字段可能返回 null,表示取不到有效值。 |
StartTime | String | 任务启动时间 注意:此字段可能返回 null,表示取不到有效值。 |
Duration | String | 运行时长(秒) 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 试运行状态 注意:此字段可能返回 null,表示取不到有效值。 |
TaskName | String | 编排空间为任务名称,开发空间为脚本名称 注意:此字段可能返回 null,表示取不到有效值。 |
SubmitUserName | String | 试运行提交人 注意:此字段可能返回 null,表示取不到有效值。 |
SubmitUserId | String | 试运行提交人userId 注意:此字段可能返回 null,表示取不到有效值。 |
TaskType | String | 任务类型 注意:此字段可能返回 null,表示取不到有效值。 |
HasResultSet | Boolean | 是否含有结果集 注意:此字段可能返回 null,表示取不到有效值。 |
DrInstanceOpsDtoPage
试运行记录
被如下接口引用:DescribeDrInstancePage。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录总数 注意:此字段可能返回 null,表示取不到有效值。 |
Items | Array of DrInstanceOpsDto | 记录列表 注意:此字段可能返回 null,表示取不到有效值。 |
Duty
值班信息
被如下接口引用:DescribeDutyScheduleDetails。
名称 | 类型 | 描述 |
---|---|---|
DutyScheduleId | Integer | 值班Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
StartTime | String | 值班开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:12:00:00 |
EndTime | String | 值班结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:23:59:59 |
DutyPersons | Array of DutyPerson | 值班人员 注意:此字段可能返回 null,表示取不到有效值。 |
DutyPerson
值班人员
被如下接口引用:DescribeDutyScheduleDetails。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UserId | String | 是 | 值班人子账号id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
UserName | String | 是 | 值班人名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:name |
OwnerUserId | String | 否 | 值班人员主账号用户id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
TenantId | Integer | 否 | 值班人tenantId 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
AddTime | String | 否 | 2023-11-02 08:00:00 注意:此字段可能返回 null,表示取不到有效值。 示例值:添加时间 |
Params | String | 否 | 扩展字段 注意:此字段可能返回 null,表示取不到有效值。 |
DutySchedule
值班表列表
被如下接口引用:DescribeDutyScheduleList。
名称 | 类型 | 描述 |
---|---|---|
Rows | Array of DutyScheduleData | 值班表列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 总条数 示例值:10 |
PageNumber | Integer | 页号 示例值:1 |
PageSize | Integer | 页大小 示例值:10 |
TotalPageNumber | Integer | 总页数 示例值:1 |
DutyScheduleData
值班表列表
被如下接口引用:DescribeDutyScheduleList。
名称 | 类型 | 描述 |
---|---|---|
Id | Integer | 值班表Id 示例值:1 |
Name | String | 值班表名称 示例值:值班表A |
Creator | String | 创建人 示例值:12345 |
DutyScheduleDetailsInfo
值班信息表
被如下接口引用:DescribeDutyScheduleDetails。
名称 | 类型 | 描述 |
---|---|---|
Day | String | 值班日期 示例值:2022-02-01 |
Duty | Array of Duty | 值班信息 注意:此字段可能返回 null,表示取不到有效值。 |
EventBatchCaseDTO
事件连续时间实例信息
被如下接口引用:TriggerDsEvent。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CaseId | String | 否 | 事件实例id 示例值:233 |
Name | String | 否 | 事件名 示例值:event |
StartDimension | String | 否 | 事件触发起始时间 示例值:20240101 |
CreationTs | String | 否 | 创建时间 示例值:2024-01-01 11:00:00 |
ConsumerId | String | 否 | 消费者id 示例值:1485413914375667712 |
Description | String | 否 | 描述信息 示例值:描述信息 |
EndDimension | String | 否 | 事件触发结束时间 示例值:20240102 |
EventSubType | String | 否 | 事件周期 示例值:DAY |
EventCaseAuditLogOptDto
事件实例
被如下接口引用:DescribeEventCases。
名称 | 类型 | 描述 |
---|---|---|
CaseId | String | 事件实例ID 注意:此字段可能返回 null,表示取不到有效值。 |
EventName | String | 事件名称 注意:此字段可能返回 null,表示取不到有效值。 |
EventType | String | 事件类型 注意:此字段可能返回 null,表示取不到有效值。 |
EventSubType | String | 事件分割类型 注意:此字段可能返回 null,表示取不到有效值。 |
EventBroadcastType | String | 事件广播类型 注意:此字段可能返回 null,表示取不到有效值。 |
TTL | Integer | 事件实例存活时间 注意:此字段可能返回 null,表示取不到有效值。 |
TimeUnit | String | 事件实例存活时间单位 注意:此字段可能返回 null,表示取不到有效值。 |
Dimension | String | 数据时间 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 事件实例状态 注意:此字段可能返回 null,表示取不到有效值。 |
EventTriggerTimestamp | String | 事件实例触发时间戳 注意:此字段可能返回 null,表示取不到有效值。 |
LogTimestamp | String | 事件实例消费时间戳 注意:此字段可能返回 null,表示取不到有效值。 |
Description | String | 事件实例描述 注意:此字段可能返回 null,表示取不到有效值。 |
EventCaseAuditLogVOCollection
事件实例分页查询结果
被如下接口引用:DescribeEventCases。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 结果总数 注意:此字段可能返回 null,表示取不到有效值。 |
TotalPage | Integer | 总页数 注意:此字段可能返回 null,表示取不到有效值。 |
PageCount | Integer | 当前页记录数 注意:此字段可能返回 null,表示取不到有效值。 |
PageNumber | Integer | 页码 注意:此字段可能返回 null,表示取不到有效值。 |
PageSize | Integer | 分页大小 注意:此字段可能返回 null,表示取不到有效值。 |
Items | Array of EventCaseAuditLogOptDto | 分页数据 注意:此字段可能返回 null,表示取不到有效值。 |
EventCaseConsumeLogOptDto
事件消费记录
被如下接口引用:DescribeEventConsumeTasks。
名称 | 类型 | 描述 |
---|---|---|
ConsumeLogId | String | 消费ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:"111" |
EventCaseId | String | 事件案例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:"3e2921c4eb9b48769e2b7a2f75a90464" |
ConsumerId | String | 消费者ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:"20120304345623098" |
CreationTimestamp | String | 消费时间戳 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2021-01-02 14:53:00" |
ConsumerDetail | TaskOpsDto | 任务详情 注意:此字段可能返回 null,表示取不到有效值。 |
EventCaseConsumeLogOptDtoCollection
事件消费任务记录列表
被如下接口引用:DescribeEventConsumeTasks。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 结果总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
TotalPage | Integer | 结果总页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageCount | Integer | 当前页结果数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
PageNumber | Integer | 页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 每页数目 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Items | Array of EventCaseConsumeLogOptDto | 分页数据 注意:此字段可能返回 null,表示取不到有效值。 |
EventCaseDTO
事件实例信息
被如下接口引用:TriggerDsEvent。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CaseId | String | 否 | 事件实例id 示例值:123 |
Name | String | 否 | 事件名 示例值:event |
Dimension | String | 否 | 事件格式 示例值:20240101 |
CreationTs | String | 否 | 创建时间 示例值:wedata |
ConsumerId | String | 否 | 消费者id 示例值:1485413914375667712 |
Description | String | 否 | 描述信息 示例值:用于a任务 |
EventCaseOpsDto
EventCaseOpsDto
被如下接口引用:DescribeEvent。
名称 | 类型 | 描述 |
---|---|---|
CaseId | String | 案例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:"7b55e80c3a7949428c34b02ab82b09b7" |
Name | String | 案例名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"test_event_day" |
Dimension | String | 时间格式 注意:此字段可能返回 null,表示取不到有效值。 示例值:"20240409" |
CreationTimestamp | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2024-04-11T06:37:20.662Z" |
ConsumerId | String | 消费者id 注意:此字段可能返回 null,表示取不到有效值。 示例值:"20240302090100321" |
Description | String | 描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
EventListenerOpsDto
事件监听器
被如下接口引用:DescribeEvent。
名称 | 类型 | 描述 |
---|---|---|
EventName | String | 事件名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"test_day_event" |
Key | String | 关键字,如果是任务,则是任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:"20240411143958297" |
Type | String | 触发方式 注意:此字段可能返回 null,表示取不到有效值。 示例值:"REST_API" |
Properties | String | 事件属性 注意:此字段可能返回 null,表示取不到有效值。 示例值:"[ParamInfo(paramKey=maxWaitEventTimeUnit, paramValue=DAYS), ParamInfo(paramKey=maxWaitEventTime, paramValue=1)]" |
CreationTimestamp | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2024-04-11T06:37:20.662Z" |
EventOpsDto
事件详情
被如下接口引用:DescribeEvent。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 事件名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"test_day_event" |
EventType | String | 事件类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:"TIME_SERIES" |
EventSubType | String | 事件分割类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:"DAY" |
EventBroadcastType | String | 事件广播类型 注意:此字段可能返回 null,表示取不到有效值。 |
DimensionFormat | String | 数据时间格式 注意:此字段可能返回 null,表示取不到有效值。 示例值:"yyyyMMdd" |
TimeToLive | Integer | 存活时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:30 |
TimeUnit | String | 存活时间单位 注意:此字段可能返回 null,表示取不到有效值。 示例值:"DAYS" |
CreationTimestamp | String | 创建时间戳 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2024-04-11T06:37:20.662Z" |
Owner | String | 所属者 注意:此字段可能返回 null,表示取不到有效值。 示例值:"tom" |
Properties | String | 属性 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Description | String | 描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Listeners | Array of EventListenerOpsDto | 监听器 注意:此字段可能返回 null,表示取不到有效值。 |
EventCases | Array of EventCaseOpsDto | 事件案例 注意:此字段可能返回 null,表示取不到有效值。 |
ExtResourceFlagDto
扩展信息参数
被如下接口引用:DescribeAllByFolderNew, DescribeDependTaskLists, DescribeSuccessorOpsTaskInfos, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ParentTask | Boolean | 否 | 父任务信息获取标识 注意:此字段可能返回 null,表示取不到有效值。 |
EventListener | String | 否 | 生产事件获取标识 注意:此字段可能返回 null,表示取不到有效值。 |
DlcResourceConfig | String | 否 | Dlc相关配置获取标识 注意:此字段可能返回 null,表示取不到有效值。 |
Script | String | 否 | 脚本信息获取标识 注意:此字段可能返回 null,表示取不到有效值。 |
OfflineSyncTask | String | 否 | 离线任务信息获取标识 注意:此字段可能返回 null,表示取不到有效值。 |
FailMessage
错误处理结果信息
被如下接口引用:TriggerDsEvent。
名称 | 类型 | 描述 |
---|---|---|
Key | String | 数据唯一标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
ErrorMessage | String | 失败原因 注意:此字段可能返回 null,表示取不到有效值。 示例值:数据不存在 |
FieldConfig
字段变量
被如下接口引用:CreateRule, DescribeRule, DescribeRules, ModifyRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
FieldKey | String | 否 | 字段key 注意:此字段可能返回 null,表示取不到有效值。 示例值:table_n.column_n |
FieldValue | String | 否 | 字段值 注意:此字段可能返回 null,表示取不到有效值。 示例值:city |
FieldDataType | String | 否 | 字段值类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:string |
Filter
通用过滤器
被如下接口引用:DescribeAlarmEvents, DescribeColumnsMeta, DescribeDataSourceInfoList, DescribeDataSourceList, DescribeDatabaseInfoList, DescribeDatabaseMetas, DescribeDimensionScore, DescribeDutyScheduleDetails, DescribeFieldBasicInfo, DescribeIntegrationTasks, DescribeOrganizationalFunctions, DescribeQualityScore, DescribeQualityScoreTrend, DescribeRuleGroupExecResultsByPage, DescribeRuleGroupsByPage, DescribeRuleTemplatesByPage, DescribeRulesByPage, DescribeTableBasicInfo, DescribeTableInfoList, DescribeTableMetas, DescribeTablePartitions, DescribeTableQualityDetails, DescribeTaskAlarmRegulations, DescribeTaskTableMetricOverview。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 否 | 过滤字段名称 示例值:SearchWord |
Values | Array of String | 否 | 过滤值列表 示例值:default |
FilterOptional
通用过滤器
被如下接口引用:DescribeApproveList, DescribeProjectUsers。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 否 | 过滤字段名称 示例值:SearchWord |
Values | Array of String | 否 | 过滤值列表 示例值:default |
FolderDsDto
文件夹属性
被如下接口引用:FindAllFolder。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | String | 否 | 文件夹id 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
Name | String | 否 | 文件夹名称 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 否 | 所属项目id 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | String | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
ParentsFolderId | String | 否 | 父文件夹id 注意:此字段可能返回 null,表示取不到有效值。 |
Total | Integer | 否 | 工作流总数 注意:此字段可能返回 null,表示取不到有效值。 |
Workflows | Array of WorkflowCanvasOpsDto | 否 | 工作流列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalFolders | Integer | 否 | 子文件夹总数 注意:此字段可能返回 null,表示取不到有效值。 |
Folders | Array of FolderDsDto | 否 | 子文件夹列表 注意:此字段可能返回 null,表示取不到有效值。 |
FindType | String | 否 | 搜索类型 注意:此字段可能返回 null,表示取不到有效值。 |
FolderOpsDto
文件夹属性
被如下接口引用:DescribeAllByFolderNew。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | String | 否 | 文件夹id 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
Name | String | 否 | 文件夹名称 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 否 | 所属项目id 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | String | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
ParentsFolderId | String | 否 | 父文件夹id 注意:此字段可能返回 null,表示取不到有效值。 |
Total | Integer | 否 | 工作流总数 注意:此字段可能返回 null,表示取不到有效值。 |
Workflows | Array of WorkflowCanvasOpsDto | 否 | 工作流列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalFolders | Integer | 否 | 子文件夹总数 注意:此字段可能返回 null,表示取不到有效值。 |
FoldersList | String | 否 | 子文件夹列表 注意:此字段可能返回 null,表示取不到有效值。 |
FindType | String | 否 | 搜索类型 注意:此字段可能返回 null,表示取不到有效值。 |
FunctionResource
函数资源信息
被如下接口引用:SaveCustomFunction。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Path | String | 是 | 资源路径 注意:此字段可能返回 null,表示取不到有效值。 |
Name | String | 是 | 无 注意:此字段可能返回 null,表示取不到有效值。 |
Id | String | 否 | 资源唯一标识 |
Md5 | String | 否 | 资源 MD5 值 注意:此字段可能返回 null,表示取不到有效值。 |
Type | String | 否 | 默认是 hdfs 注意:此字段可能返回 null,表示取不到有效值。 示例值:cos / hdfs |
FunctionTypeOrKind
函数类型或函数分类
被如下接口引用:DescribeFunctionKinds, DescribeFunctionTypes。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 名称 示例值:TypeName |
ZhName | String | 函数分类英文名 示例值:analytical functions |
EnName | String | 函数分类中文名 示例值:分析函数 |
FunctionVersion
函数提交版本信息
被如下接口引用:DescribeOrganizationalFunctions。
名称 | 类型 | 描述 |
---|---|---|
Tag | String | 版本号:V0 V1 V2 示例值:V0 |
UserId | String | 提交人 ID |
Type | String | 变更类型:ADD、MODIFY 示例值:ADD |
Comment | String | 备注 |
Timestamp | String | 提交时间: UTC 秒数 |
UserName | String | 提交人名称 注意:此字段可能返回 null,表示取不到有效值。 |
Content | String | 版本内容:json string 格式 注意:此字段可能返回 null,表示取不到有效值。 |
GeneralTaskParam
Spark SQL配置参数
被如下接口引用:ModifyWorkflowInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Type | String | 是 | 通用任务参数类型,例:SPARK_SQL 示例值:SPARK_SQL |
Value | String | 是 | 通用任务参数内容,直接作用于任务的参数。不同参数用; 分割 |
GovDatasourceInfo
数据源信息
被如下接口引用:DescribeDatabaseMetas, DescribeTableMeta, DescribeTableMetas。
名称 | 类型 | 描述 |
---|---|---|
DatasourceId | String | 数据源id 注意:此字段可能返回 null,表示取不到有效值。 |
DatasourceName | String | 数据源名称 注意:此字段可能返回 null,表示取不到有效值。 |
DatasourceClusterId | String | 数据源集群ID 注意:此字段可能返回 null,表示取不到有效值。 |
DatasourceUrn | String | 数据源urn 注意:此字段可能返回 null,表示取不到有效值。 |
DatasourceEnv | String | 数据源环境 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceApiOpsRequest
实例查询类型
被如下接口引用:DagInstances, DescribeScheduleInstances, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Instance | InstanceOpsDto | 否 | 单个查询条件 |
SortCol | String | 否 | 排序字段,目前包含:重试次数,实例数据时间,运行耗时 |
TaskIdList | Array of String | 否 | 任务id列表 |
TaskNameList | Array of String | 否 | 按照taskName模糊查询 |
FolderList | Array of String | 否 | 文件夹列表 |
Sort | String | 否 | 升序或者降序 |
StateList | Array of Integer | 否 | 实例状态列表 |
TaskTypeList | Array of Integer | 否 | 实例类型列表 |
CycleList | Array of String | 否 | 周期类型 |
OwnerList | Array of String | 否 | 责任人 |
DateFrom | String | 否 | 数据时间 |
DateTo | String | 否 | 数据时间 |
CreateTimeFrom | String | 否 | 实例入库时间 |
CreateTimeTo | String | 否 | 实例入库时间 |
StartFrom | String | 否 | 开始执行时间 |
StartTo | String | 否 | 开始执行时间 |
WorkflowIdList | Array of String | 否 | 所属工作流 |
WorkflowNameList | Array of String | 否 | 按照workflowName模糊查询 |
Keyword | String | 否 | 关键字模糊查询 |
SearchColumns | Array of String | 否 | searchColumns是搜索的字段名列表 |
ProjectId | String | 否 | 项目id |
Limit | Integer | 否 | 限制 |
TaskTypeMap | Array of TaskTypeMap | 否 | 任务类型映射关系, 存储任务类型id和任务类型描述信息 |
InstanceType | String | 否 | 0 补录类型 1 周期实例 2 非周期实例 |
DagDeal | Boolean | 否 | 是否dag |
DagType | String | 否 | 1 父实例 2 子实例 |
DagDependent | String | 否 | 1 自依赖 2 任务依赖 3 所有依赖 |
DagDepth | Integer | 否 | dag深度 默认为1,取值 1-6 |
TenantId | String | 否 | 租户id |
DataTimeCycle | String | 否 | 根据当前数据时间或者是下一个数据时间查询, 默认当前数据时间 |
ExecutorGroupIdList | Array of String | 否 | 资源组id,多个资源组id用英文逗号分隔 |
OnlyRerun | Boolean | 否 | true 只过滤重跑过的实例,false 忽略此过滤条件,结果集过滤条件中不包括是否重跑 |
ScheduleTimeZone | String | 否 | 时区 示例值:UTC+7 |
InstanceCondition
实例检索条件
被如下接口引用:DescribeTaskRunHistory。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ExecutionSpace | String | 否 | 执行类型 |
ProductName | String | 否 | 任务产品类型 |
InstanceDownloadLogInfo
下载日志详情
被如下接口引用:DescribeInstanceLogFile。
名称 | 类型 | 描述 |
---|---|---|
FileName | String | 文件名 注意:此字段可能返回 null,表示取不到有效值。 |
FileUrl | String | 文件URL 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceLifeCycleOpsDto
实例生命周期详情
被如下接口引用:DagInstances, DescribeInstanceDetailInfo, DescribeScheduleInstances, DescribeTaskRunHistory, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 否 | 任务id 注意:此字段可能返回 null,表示取不到有效值。 |
TaskName | String | 否 | 任务名 注意:此字段可能返回 null,表示取不到有效值。 示例值:task name |
CurRunDate | String | 否 | 数据时间 注意:此字段可能返回 null,表示取不到有效值。 |
LifeRound | Integer | 否 | 实例生命次数 注意:此字段可能返回 null,表示取不到有效值。 |
RunType | String | 否 | 运行类型 重跑/补录/周期/非周期 注意:此字段可能返回 null,表示取不到有效值。 |
Tries | Integer | 否 | 重跑次数 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceLifeDetailDtoList | Array of InstanceLifeDetailDto | 否 | 实例生命周期 注意:此字段可能返回 null,表示取不到有效值。 |
RunnerState | String | 否 | Runner运行状态 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorDesc | String | 否 | 错误码 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorCodeLevel | String | 否 | 错误告警级别 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceLogListOpsDto | InstanceLogInfo | 否 | 实例日志简略信息 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceState | String | 否 | 实例状态 注意:此字段可能返回 null,表示取不到有效值。 |
ScheduleRunType | Integer | 否 | 调度运行方式, 0: 周期调度, 1: 空跑调度 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ExecutionJobId | String | 否 | 统一执行平台,下发执行Id 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceRunType | Integer | 否 | 实例运行类型: 0: 普通运行, 1: 空跑运行 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TotalLifeRound | Integer | 否 | 实例当前总生命周期数 示例值:5 |
TaskType | TaskTypeOpsDto | 否 | 任务类型 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceLifeDetailDto
实例生命周期detail
被如下接口引用:DescribeInstanceDetailInfo, DescribeInstanceLogDetail, DescribeInstanceLogFile。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
State | String | 否 | 实例状态 注意:此字段可能返回 null,表示取不到有效值。 |
StartTime | String | 否 | 该状态开始时间 注意:此字段可能返回 null,表示取不到有效值。 |
DetailState | String | 否 | 实例生命周期阶段状态 注意:此字段可能返回 null,表示取不到有效值。 |
EndTime | String | 否 | 该状态结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceList
离线运维实例列表
被如下接口引用:DescribeInstanceList。
名称 | 类型 | 描述 |
---|---|---|
CostTime | String | 耗费时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:00:01:07.000 |
CurRunDate | String | 数据时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-04-01 15:50:00 |
CycleType | String | 周期类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:MINUTE_CYCLE |
DoFlag | Integer | 是否补录 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
InCharge | String | 责任人 注意:此字段可能返回 null,表示取不到有效值。 示例值:user name |
LastLog | String | 日志 注意:此字段可能返回 null,表示取不到有效值。 示例值:20220408140507294_2024-04-01 15:50:00_202204-11 11:04:23 |
SchedulerDesc | String | 调度计划 注意:此字段可能返回 null,表示取不到有效值。 |
StartTime | String | 开始启动时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-04-11 11:04:29 |
State | String | 实例状态 EVENT_LISTENING|DEPENDENCE|BEFORE_ASPECT|ALLOCATED|LAUNCHED|KILL|SNAP_STATE_SAVING|ISSUED|RUNNING|AFTER_ASPECT|PENDING|KILLING|FINAL_STATE_SAVING|FAILED|KILL_FAILED| COMPLETED|EXPIRED|KILL_EXPIRED|DELETED 注意:此字段可能返回 null,表示取不到有效值。 示例值:COMPLETED |
TaskId | String | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:20220408140507294 |
TaskName | String | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:task test name |
TryLimit | Integer | 尝试运行次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
InstanceLogInfo
实例日志简述信息
被如下接口引用:DescribeInstanceDetailInfo, DescribeOpsInstanceLogList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 否 | 任务id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
CurRunDate | String | 否 | 数据时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-12-12 00:00:00 |
Tries | String | 否 | 尝试运行次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
LastUpdate | String | 否 | 日志更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-12-12 10:00:00 |
BrokerIp | String | 否 | 日志所在节点 注意:此字段可能返回 null,表示取不到有效值。 示例值:127.0.0.1 |
FileSize | String | 否 | 文件大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
OriginFileName | String | 否 | 文件名 含全路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:123_2022-12-12 00:00:00 |
CreateTime | String | 否 | 日志创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-12-12 00:00:00 |
InstanceLogType | String | 否 | 实例日志类型, run: 运行; kill: 终止 注意:此字段可能返回 null,表示取不到有效值。 示例值:run |
TaskName | String | 否 | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:测试 |
CostTime | String | 否 | 运行耗时 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
InstanceStatus | String | 否 | 实例状态 COMPLETED 完成 FAILED失败重试 EXPIRED失败 RUNNING运行中 注意:此字段可能返回 null,表示取不到有效值。 示例值:COMPLETED |
CodeFileName | String | 否 | 实例代码文件,为空表示对应代码文件不存在,可能是因为执行机未升级/对应类型任务无代码。 注意:此字段可能返回 null,表示取不到有效值。 |
ExtensionInfo | Array of AttributeItemDTO | 否 | 扩展属性 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionJobId | String | 否 | 统一执行平台,下发执行Id 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceLogInfoOpsDto
实例日志信息详情
被如下接口引用:DescribeInstanceLogDetail。
名称 | 类型 | 描述 |
---|---|---|
LogInfo | String | 实例运行日志 注意:此字段可能返回 null,表示取不到有效值。 |
YarnLogInfo | Array of String | 实例运行提交的yarn日志地址 注意:此字段可能返回 null,表示取不到有效值。 |
DataLogInfo | String | 实例运行产生的datax日志 注意:此字段可能返回 null,表示取不到有效值。 |
ThirdTaskRunLogInfo | String | 第三方任务运行日志 注意:此字段可能返回 null,表示取不到有效值。 |
ThirdTaskLogUrlDesc | String | 第三方任务日志链接描述 注意:此字段可能返回 null,表示取不到有效值。 |
LineCount | Integer | 日志行数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10000 |
ExtInfo | String | 统一执行平台日志分页查询参数 注意:此字段可能返回 null,表示取不到有效值。 |
IsEnd | Boolean | 日志分页查询,是否最后一页 注意:此字段可能返回 null,表示取不到有效值。 |
FileSize | String | 文件大小 注意:此字段可能返回 null,表示取不到有效值。 |
MatchedBrokerIp | String | 日志匹配节点信息 示例值:NA |
ExecutionExtendedProps | Array of PairDto | 执行平台通用协议 |
InstanceLogList
实例日志信息
被如下接口引用:DescribeInstanceLogList。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:"20220408130054538" |
CurRunDate | String | 数据时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2022-04-10 19:38:37" |
Tries | String | 重试次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:"null" |
LastUpdate | String | 最后更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2022-04-10 19:38:37" |
BrokerIp | String | 节点ip 注意:此字段可能返回 null,表示取不到有效值。 示例值:"172.1.1.1" |
FileSize | String | 文件大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:"10mb" |
OriginFileName | String | 原始文件名 注意:此字段可能返回 null,表示取不到有效值。 示例值:"ins-1" |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2022-04-10 19:38:37" |
InstanceLogType | String | 实例日志类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:"info" |
TaskName | String | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"1" |
CostTime | String | 耗费时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"123000" |
InstanceNodeInfo
查询实时任务实例当前的节点信息
被如下接口引用:DescribeRealTimeTaskInstanceNodeInfo。
名称 | 类型 | 描述 |
---|---|---|
NodeType | String | 读取节点SOURCE 写入节点SINK 注意:此字段可能返回 null,表示取不到有效值。 示例值:SOURCE |
NodeId | String | 节点id 注意:此字段可能返回 null,表示取不到有效值。 示例值:11745 |
NodeName | String | 节点名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:nodeTestName |
InstanceOpsDto
实例运维详情
被如下接口引用:DagInstances, DescribeOpsMakePlanInstances, DescribeScheduleInstances, DescribeTaskRunHistory, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 否 | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 |
TaskName | String | 否 | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowId | String | 否 | 工作流ID 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowName | String | 否 | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 |
InCharge | String | 否 | 负责人 注意:此字段可能返回 null,表示取不到有效值。 |
CycleType | String | 否 | 周期类型 注意:此字段可能返回 null,表示取不到有效值。 |
CurRunDate | String | 否 | 数据时间 注意:此字段可能返回 null,表示取不到有效值。 |
NextCurDate | String | 否 | 下一个数据时间 注意:此字段可能返回 null,表示取不到有效值。 |
RunPriority | Integer | 否 | 运行优先级 注意:此字段可能返回 null,表示取不到有效值。 |
TryLimit | Integer | 否 | 尝试运行次数 注意:此字段可能返回 null,表示取不到有效值。 |
Tries | Integer | 否 | 当前运行次数 注意:此字段可能返回 null,表示取不到有效值。 |
TotalRunNum | Integer | 否 | 重跑总次数 注意:此字段可能返回 null,表示取不到有效值。 |
DoFlag | Integer | 否 | 是否补录 注意:此字段可能返回 null,表示取不到有效值。 |
RedoFlag | Integer | 否 | 是否是重跑 注意:此字段可能返回 null,表示取不到有效值。 |
State | String | 否 | 实例状态 注意:此字段可能返回 null,表示取不到有效值。 |
RuntimeBroker | String | 否 | 运行节点 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorDesc | String | 否 | 失败的原因 注意:此字段可能返回 null,表示取不到有效值。 |
TaskType | TaskTypeOpsDto | 否 | 任务类型 注意:此字段可能返回 null,表示取不到有效值。 |
DependenceFulfillTime | String | 否 | 依赖判断完成时间 注意:此字段可能返回 null,表示取不到有效值。 |
FirstDependenceFulfillTime | String | 否 | 首次依赖判断通过时间 注意:此字段可能返回 null,表示取不到有效值。 |
FirstStartTime | String | 否 | 首次启动时间 注意:此字段可能返回 null,表示取不到有效值。 |
StartTime | String | 否 | 开始启动时间 注意:此字段可能返回 null,表示取不到有效值。 |
EndTime | String | 否 | 运行完成时间 注意:此字段可能返回 null,表示取不到有效值。 |
CostTime | String | 否 | 耗费时间 注意:此字段可能返回 null,表示取不到有效值。 |
CostMillisecond | Integer | 否 | 耗费时间(ms) 注意:此字段可能返回 null,表示取不到有效值。 |
MaxCostTime | Integer | 否 | 最大运行耗时 注意:此字段可能返回 null,表示取不到有效值。 |
MinCostTime | Integer | 否 | 最小运行耗时 注意:此字段可能返回 null,表示取不到有效值。 |
AvgCostTime | Float | 否 | 平均运行耗时 注意:此字段可能返回 null,表示取不到有效值。 |
LastLog | String | 否 | 最近日志 注意:此字段可能返回 null,表示取不到有效值。 |
SchedulerDateTime | String | 否 | 调度时间 注意:此字段可能返回 null,表示取不到有效值。 |
LastSchedulerDateTime | String | 否 | 上次调度时间 注意:此字段可能返回 null,表示取不到有效值。 |
LastUpdate | String | 否 | 最后更新事件 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
DependencyRel | String | 否 | 分支,依赖关系 and、or 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionSpace | String | 否 | 执行空间 注意:此字段可能返回 null,表示取不到有效值。 |
IgnoreEvent | Boolean | 否 | 忽略事件 注意:此字段可能返回 null,表示取不到有效值。 |
VirtualFlag | Boolean | 否 | 虚拟任务实例 注意:此字段可能返回 null,表示取不到有效值。 |
FolderId | String | 否 | 文件夹ID 注意:此字段可能返回 null,表示取不到有效值。 |
FolderName | String | 否 | 文件夹名称 注意:此字段可能返回 null,表示取不到有效值。 |
SonList | String | 否 | 递归实例信息 注意:此字段可能返回 null,表示取不到有效值。 |
ProductName | String | 否 | 产品业务名称 注意:此字段可能返回 null,表示取不到有效值。 |
ResourceGroup | String | 否 | 资源组 注意:此字段可能返回 null,表示取不到有效值。 |
ResourceInstanceId | String | 否 | 资源组指定执行节点 注意:此字段可能返回 null,表示取不到有效值。 |
YarnQueue | String | 否 | 资源队列 注意:此字段可能返回 null,表示取不到有效值。 |
SchedulerDesc | String | 否 | 调度计划 注意:此字段可能返回 null,表示取不到有效值。 |
FirstSubmitTime | String | 否 | 最近提交时间 注意:此字段可能返回 null,表示取不到有效值。 |
FirstRunTime | String | 否 | 首次执行时间 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 否 | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectIdent | String | 否 | 项目标识 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectName | String | 否 | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 |
TenantId | String | 否 | 租户id 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceKey | String | 否 | 实例标识 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutorGroupId | String | 否 | 资源组id 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutorGroupName | String | 否 | 资源组名称 注意:此字段可能返回 null,表示取不到有效值。 |
RelatedInstanceList | Array of InstanceOpsDto | 否 | 关联实例信息。 注意:此字段可能返回 null,表示取不到有效值。 |
RelatedInstanceSize | Integer | 否 | 关联实例信息数量,不和RelatedInstanceList强关联。 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerId | String | 否 | ownerId 注意:此字段可能返回 null,表示取不到有效值。 |
UserId | String | 否 | 用户id 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceLifeCycleOpsDto | InstanceLifeCycleOpsDto | 否 | 实例生命周期 注意:此字段可能返回 null,表示取不到有效值。 |
RetryAttempts | Integer | 否 | 自动重试次数 注意:此字段可能返回 null,表示取不到有效值。 |
DeletedFatherList | Array of String | 否 | 紧急去除的依赖父实例列表 注意:此字段可能返回 null,表示取不到有效值。 |
CirculateInstanceList | Array of InstanceOpsDto | 否 | 循环依赖关联的实例 注意:此字段可能返回 null,表示取不到有效值。 |
ConcurrentStrategy | Integer | 否 | 并发策略, 0: 等待并发, 1: kill自身 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ScheduleRunType | Integer | 否 | 调度运行方式, 0: 周期调度, 1: 空跑调度 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
InstanceOpsInfoPage
任务运行历史分页记录
被如下接口引用:DescribeTaskRunHistory。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总记录数 注意:此字段可能返回 null,表示取不到有效值。 |
Items | Array of InstanceOpsDto | 记录列表 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceSearchCondition
实例检索条件
被如下接口引用:DescribeTaskRunHistory。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CycleList | Array of String | 否 | 任务调度周期类型 |
DateFrom | String | 否 | 起始时间 |
DateTo | String | 否 | 截止时间 |
Instance | InstanceCondition | 否 | 实例过滤条件 |
Keyword | String | 否 | 模糊查询关键字 |
Sort | String | 否 | 排序方式 |
SortCol | String | 否 | 排序字段 |
StateList | Array of String | 否 | 实例状态类型 |
InstanceStatisticInfo
运维大屏实例状态统计和实例状态趋势
被如下接口引用:DescribeStatisticInstanceStatusTrendOps。
名称 | 类型 | 描述 |
---|---|---|
CountList | Array of Integer | 实例状态趋势状态统计 注意:此字段可能返回 null,表示取不到有效值。 示例值:[0,1,3,4] |
TimeList | Array of String | 实例状态趋势时间分割 注意:此字段可能返回 null,表示取不到有效值。 示例值:["2022-02-26 07:00:00","2022-02-26 08:00:00"] |
InstanceStatus | String | 实例状态标识:WAITING_RUNNING、KILLING、FAILED、FAILED_TRYING、SUCCEED 分别表示等待执行、正在终止、失败、失败重试、成功,用于实例状态分布和实例状态趋势 示例值:WAITING_RUNNING |
InstanceCount | Integer | 用于实例状态分布计数 示例值:34 |
ShowTime | String | 当前展示时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2022-03-03 14:25:28" |
ReportTime | String | 1 注意:此字段可能返回 null,表示取不到有效值。 |
Count | Integer | 1 注意:此字段可能返回 null,表示取不到有效值。 |
IntegrationInstanceLog
实例日志信息
被如下接口引用:DescribeInstanceLog。
名称 | 类型 | 描述 |
---|---|---|
LogInfo | String | 任务日志信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:"[INFO][请求id]任务日志信息" |
IntegrationNodeDetail
集成节点详情
被如下接口引用:ModifyTaskScript。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 否 | 集成节点名称 示例值:test |
NodeType | String | 否 | 集成节点类型 示例值:INPUT |
DataSourceType | String | 否 | 节点数据源类型 示例值:MYSQL |
Description | String | 否 | 节点描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
DatasourceId | String | 否 | 数据源id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
Config | Array of RecordField | 否 | 节点配置信息 注意:此字段可能返回 null,表示取不到有效值。 |
ExtConfig | Array of RecordField | 否 | 节点扩展配置信息 注意:此字段可能返回 null,表示取不到有效值。 |
Schema | Array of IntegrationNodeSchema | 否 | 节点schema 注意:此字段可能返回 null,表示取不到有效值。 |
NodeMapping | IntegrationNodeMapping | 否 | 节点映射 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerUin | String | 否 | owner uin 示例值:123 |
IntegrationNodeInfo
集成任务节点
被如下接口引用:CreateIntegrationNode, CreateIntegrationTask, DescribeIntegrationNode, DescribeIntegrationTask, DescribeIntegrationTasks, DescribeIntegrationVersionNodesInfo, ModifyIntegrationNode, ModifyIntegrationTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | String | 否 | 集成节点id 注意:此字段可能返回 null,表示取不到有效值。 示例值:130973 |
TaskId | String | 否 | 集成节点所属任务id 示例值:n11a6d01c-0ec6-4efc-bd14-97a921d01d3f |
Name | String | 否 | 集成节点名称 示例值:nodeTestName |
NodeType | String | 否 | 集成节点类型,INPUT: 输入节点,OUTPUT:输出节点 示例值:INPUT |
DataSourceType | String | 否 | 节点数据源类型:MYSQL|POSTGRE|ORACLE|SQLSERVER|FTP|HIVE|HDFS|ICEBERG|KAFKA|HBASE|SPARK|VIRTUAL|TBASE|DB2|DM|GAUSSDB|GBASE|IMPALA|ES|S3_DATAINSIGHT|GREENPLUM|PHOENIX|SAP_HANA|SFTP|OCEANBASE|CLICKHOUSE|KUDU|VERTICA|REDIS|COS|DLC|DLCV1|DORIS|CKAFKA|DTS_KAFKA|S3|CDW|LOCAL|TDSQLC|TDSQL|TDSQL_MYSQL|MONGODB|INFORMIX|SYBASE|REST_API|SuperSQL|PRESTO|DR_SUM|TiDB|StarRocks|Trino|Kyuubi|GDB|TCHOUSE_X|TCHOUSE_P|TDSQL_POSTGRE 示例值:MYSQL |
Description | String | 否 | 节点描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:testdesc |
DatasourceId | String | 否 | 数据源id 注意:此字段可能返回 null,表示取不到有效值。 示例值:914840 |
Config | Array of RecordField | 否 | 节点配置信息 注意:此字段可能返回 null,表示取不到有效值。 |
ExtConfig | Array of RecordField | 否 | 节点扩展配置信息 注意:此字段可能返回 null,表示取不到有效值。 |
Schema | Array of IntegrationNodeSchema | 否 | 节点schema 注意:此字段可能返回 null,表示取不到有效值。 |
NodeMapping | IntegrationNodeMapping | 否 | 节点映射 注意:此字段可能返回 null,表示取不到有效值。 |
AppId | String | 否 | 归属用户AppId,展示字段 非传入 示例值:1315051999 |
ProjectId | String | 否 | 项目id 示例值:1486446569620893696 |
CreatorUin | String | 否 | 创建人uin,展示字段 非传入 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028644005 |
OperatorUin | String | 否 | 操作人uin,展示字段 非传入 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028644005 |
OwnerUin | String | 否 | owner uin 展示字段 非传入 示例值:100028644005 |
CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:yyyy-MM-dd HH:mm:ss |
UpdateTime | String | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:yyyy-MM-dd HH:mm:ss |
IntegrationNodeMapping
集成节点映射
被如下接口引用:CreateIntegrationNode, CreateIntegrationTask, DescribeIntegrationNode, DescribeIntegrationTask, DescribeIntegrationTasks, DescribeIntegrationVersionNodesInfo, ModifyIntegrationNode, ModifyIntegrationTask, ModifyTaskScript。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SourceId | String | 否 | 源节点id 示例值:130973 |
SinkId | String | 否 | 目标节点id 示例值:130972 |
SourceSchema | Array of IntegrationNodeSchema | 否 | 源节点schema 注意:此字段可能返回 null,表示取不到有效值。 |
SchemaMappings | Array of IntegrationNodeSchemaMapping | 否 | 节点schema映射 注意:此字段可能返回 null,表示取不到有效值。 |
ExtConfig | Array of RecordField | 否 | 节点映射扩展信息 注意:此字段可能返回 null,表示取不到有效值。 |
IntegrationNodeSchema
集成节点schema
被如下接口引用:CreateIntegrationNode, CreateIntegrationTask, DescribeIntegrationNode, DescribeIntegrationTask, DescribeIntegrationTasks, DescribeIntegrationVersionNodesInfo, GetIntegrationNodeColumnSchema, ModifyIntegrationNode, ModifyIntegrationTask, ModifyTaskScript。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | String | 是 | schema id 随机唯一 示例值:597853056 |
Name | String | 是 | schema名称 示例值:name |
Type | String | 是 | schema类型 示例值:String |
Value | String | 否 | schema值 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
Properties | Array of RecordField | 否 | schema拓展属性 注意:此字段可能返回 null,表示取不到有效值。 |
Alias | String | 否 | schema别名 注意:此字段可能返回 null,表示取不到有效值。 示例值:name |
Comment | String | 否 | 字段备注 注意:此字段可能返回 null,表示取不到有效值。 示例值:名称 |
Category | String | 否 | category 注意:此字段可能返回 null,表示取不到有效值。 示例值:tag |
IntegrationNodeSchemaMapping
集成节点schema映射
被如下接口引用:CreateIntegrationNode, CreateIntegrationTask, DescribeIntegrationNode, DescribeIntegrationTask, DescribeIntegrationTasks, DescribeIntegrationVersionNodesInfo, ModifyIntegrationNode, ModifyIntegrationTask, ModifyTaskScript。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SourceSchemaId | String | 是 | 任务节点的源schema id 示例值:597853056 |
SinkSchemaId | String | 是 | 任务节点目标schema id 示例值:616042880 |
IntegrationStatisticsTrendResult
数据集成大屏趋势图统计结果
被如下接口引用:DescribeIntegrationStatisticsInstanceTrend, DescribeIntegrationStatisticsRecordsTrend, DescribeIntegrationStatisticsTaskStatusTrend。
名称 | 类型 | 描述 |
---|---|---|
StatisticName | Array of String | 统计属性名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:[ "00:30","01:00"] |
StatisticValue | Array of Integer | 统计值 注意:此字段可能返回 null,表示取不到有效值。 示例值:[1,1] |
StatisticType | String | 统计项目 注意:此字段可能返回 null,表示取不到有效值。 示例值:"FAILED" |
IntegrationTaskInfo
集成任务
被如下接口引用:CreateIntegrationTask, DescribeIntegrationTask, DescribeIntegrationTasks, ModifyIntegrationTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskName | String | 否 | 任务名称 示例值:testtaskname |
Description | String | 否 | 任务描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:testdesc |
SyncType | Integer | 否 | 同步类型1.解决方案(整库迁移),2.单表同步 示例值:默认:2 同步类型: 1. all database, 2. single table, 3. log collect |
TaskType | Integer | 否 | 201.实时,202.离线 示例值:默认:201 任务类型:201. 实时同步, 202. 离线同步 |
WorkflowId | String | 否 | 任务所属工作流id 注意:此字段可能返回 null,表示取不到有效值。 |
TaskId | String | 否 | 任务id 注意:此字段可能返回 null,表示取不到有效值。 示例值:n11a6d01c-0ec6-4efc-bd14-97a921d01d3f |
ScheduleTaskId | String | 否 | 任务调度id(oceanus or us等作业id),非填项 注意:此字段可能返回 null,表示取不到有效值。 示例值:cql-hjlx38yl |
TaskGroupId | String | 否 | inlong任务id 注意:此字段可能返回 null,表示取不到有效值。 示例值:a5d814828-452c-46f6-b128-19c1a3249bf0 |
ProjectId | String | 否 | 项目id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1486446569620893696 |
CreatorUin | String | 否 | 创建人uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:100022187073 |
OperatorUin | String | 否 | 操作人uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:100022187073 |
OwnerUin | String | 否 | owner uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:100022187073 |
AppId | String | 否 | 应用id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1257305888 |
Status | Integer | 否 | 0:新建(任务开发态默认状态)|1:未开始|2:操作中|3:运行中|4:暂停|5:任务停止中|6:停止|7:执行失败|20:异常|21:未知| 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
Nodes | Array of IntegrationNodeInfo | 否 | 节点列表 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutorId | String | 否 | 执行资源id 注意:此字段可能返回 null,表示取不到有效值。 示例值:20220331190555092303 |
Config | Array of RecordField | 否 | 任务配置信息 注意:此字段可能返回 null,表示取不到有效值。 |
ExtConfig | Array of RecordField | 否 | 任务扩展配置信息 注意:此字段可能返回 null,表示取不到有效值。 |
ExecuteContext | Array of RecordField | 否 | 任务执行context信息 注意:此字段可能返回 null,表示取不到有效值。 |
Mappings | Array of IntegrationNodeMapping | 否 | 节点映射 注意:此字段可能返回 null,表示取不到有效值。 |
TaskMode | String | 否 | 任务配置模式,0:画布 1:表单 3:脚本 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Incharge | String | 否 | 责任人 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028625403 |
OfflineTaskAddEntity | OfflineTaskAddParam | 否 | 离线新增参数 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutorGroupName | String | 否 | group name 注意:此字段可能返回 null,表示取不到有效值。 示例值:资源组01 |
InLongManagerUrl | String | 否 | inlong manager url 注意:此字段可能返回 null,表示取不到有效值。 示例值:172.16.64.68:8083 |
InLongStreamId | String | 否 | stream id 注意:此字段可能返回 null,表示取不到有效值。 示例值:f8317843e-68f9-4373-914f-241d7200a9a4 |
InLongManagerVersion | String | 否 | version 注意:此字段可能返回 null,表示取不到有效值。 示例值:v17 |
DataProxyUrl | Array of String | 否 | inlong dataproxy url 注意:此字段可能返回 null,表示取不到有效值。 示例值:["172.16.64.68:8086"] |
Submit | Boolean | 否 | 任务版本是否已提交运维 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
InputDatasourceType | String | 否 | 数据源类型:MYSQL|POSTGRE|ORACLE|SQLSERVER|FTP|HIVE|HDFS|ICEBERG|KAFKA|HBASE|SPARK|VIRTUAL|TBASE|DB2|DM|GAUSSDB|GBASE|IMPALA|ES|S3_DATAINSIGHT|GREENPLUM|PHOENIX|SAP_HANA|SFTP|OCEANBASE|CLICKHOUSE|KUDU|VERTICA|REDIS|COS|DLC|DLCV1|DORIS|CKAFKA|DTS_KAFKA|S3|CDW|LOCAL|TDSQLC|TDSQL|TDSQL_MYSQL|MONGODB|INFORMIX|SYBASE|REST_API|SuperSQL|PRESTO|DR_SUM|TiDB|StarRocks|Trino|Kyuubi|GDB|TCHOUSE_X|TCHOUSE_P|TDSQL_POSTGRE 注意:此字段可能返回 null,表示取不到有效值。 示例值:MYSQL |
OutputDatasourceType | String | 否 | 数据源类型:MYSQL|POSTGRE|ORACLE|SQLSERVER|FTP|HIVE|HDFS|ICEBERG|KAFKA|HBASE|SPARK|VIRTUAL|TBASE|DB2|DM|GAUSSDB|GBASE|IMPALA|ES|S3_DATAINSIGHT|GREENPLUM|PHOENIX|SAP_HANA|SFTP|OCEANBASE|CLICKHOUSE|KUDU|VERTICA|REDIS|COS|DLC|DLCV1|DORIS|CKAFKA|DTS_KAFKA|S3|CDW|LOCAL|TDSQLC|TDSQL|TDSQL_MYSQL|MONGODB|INFORMIX|SYBASE|REST_API|SuperSQL|PRESTO|DR_SUM|TiDB|StarRocks|Trino|Kyuubi|GDB|TCHOUSE_X|TCHOUSE_P|TDSQL_POSTGRE 注意:此字段可能返回 null,表示取不到有效值。 示例值:DLC |
NumRecordsIn | Integer | 否 | 读取条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
NumRecordsOut | Integer | 否 | 写入条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
ReaderDelay | Float | 否 | 读取延迟 注意:此字段可能返回 null,表示取不到有效值。 示例值:5.0 |
NumRestarts | Integer | 否 | 重启次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
CreateTime | String | 否 | 任务创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-05-07 10:13:21 |
UpdateTime | String | 否 | 任务更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-05-07 10:13:21 |
LastRunTime | String | 否 | 任务最后一次运行时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-05-07 10:13:21 |
StopTime | String | 否 | 任务停止时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-05-07 10:13:21 |
HasVersion | Boolean | 否 | 作业是否已提交 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
Locked | Boolean | 否 | 任务是否被锁定 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
Locker | String | 否 | 任务锁定人 注意:此字段可能返回 null,表示取不到有效值。 示例值:100022187073 |
RunningCu | Float | 否 | 耗费资源量 注意:此字段可能返回 null,表示取不到有效值。 示例值:2.0 |
TaskAlarmRegularList | Array of String | 否 | 该任务关联的告警规则 注意:此字段可能返回 null,表示取不到有效值。 示例值:1769,1768 |
SwitchResource | Integer | 否 | 实时任务资源分层情况: 0:进行中,1:成功 ,2:失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ReadPhase | Integer | 否 | 实时任务读取阶段:0:全部全量,1:部分全量,2:全部增量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
InstanceVersion | Integer | 否 | 实时任务版本号 注意:此字段可能返回 null,表示取不到有效值。 示例值:12 |
ArrangeSpaceTaskId | String | 否 | 离线任务导入到编排空间的任务id 注意:此字段可能返回 null,表示取不到有效值。 示例值:20230112170349643 |
OfflineTaskStatus | Integer | 否 | 离线任务状态区分1.未提交2.已提交3.已导出 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TaskImportInfo | TaskImportInfo | 否 | 导入到编排空间配置 注意:此字段可能返回 null,表示取不到有效值。 |
BusinessLatency | Integer | 否 | 业务延迟 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
CurrentSyncPosition | Integer | 否 | 当前同步位点 注意:此字段可能返回 null,表示取不到有效值。 示例值:170000010000 |
LifecycleInfo
表生命周期相关信息
被如下接口引用:DescribeTableMeta。
名称 | 类型 | 描述 |
---|---|---|
Lifecycle | Integer | 生命周期值 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Columns | Array of String | 列名 注意:此字段可能返回 null,表示取不到有效值。 示例值:dt |
DateFormat | Array of String | 日期格式 注意:此字段可能返回 null,表示取不到有效值。 示例值:yyyy-MM-dd |
LineageParamRecord
血缘参数记录
被如下接口引用:DescribeColumnLineage, DescribeTableLineage, DescribeTableLineageInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 字段名 |
Value | String | 是 | 字段值 注意:此字段可能返回 null,表示取不到有效值。 示例值:yy |
LinkOpsDto
任务依赖边详情
被如下接口引用:DescribeAllByFolderNew, DescribeDependTaskLists, DescribeSuccessorOpsTaskInfos, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | String | 是 | 边的id 注意:此字段可能返回 null,表示取不到有效值。 |
LinkKey | String | 是 | 边的key 注意:此字段可能返回 null,表示取不到有效值。 |
TaskFrom | String | 是 | 边的源节点 注意:此字段可能返回 null,表示取不到有效值。 |
TaskTo | String | 是 | 边的目标节点 注意:此字段可能返回 null,表示取不到有效值。 |
InCharge | String | 是 | 责任人 注意:此字段可能返回 null,表示取不到有效值。 |
LinkDependencyType | String | 是 | 父子任务之间的依赖关系 注意:此字段可能返回 null,表示取不到有效值。 |
Offset | String | 是 | 父子任务之间依赖偏移量 注意:此字段可能返回 null,表示取不到有效值。 |
LinkType | String | 是 | 边的类型 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowId | String | 是 | 工作流id 注意:此字段可能返回 null,表示取不到有效值。 |
LogContent
实时任务日志内容
被如下接口引用:TaskLog。
名称 | 类型 | 描述 |
---|---|---|
Time | Integer | 日志时间戳,单位毫秒 注意:此字段可能返回 null,表示取不到有效值。 示例值:1659345269008 |
PkgId | String | 日志包id 注意:此字段可能返回 null,表示取不到有效值。 示例值:593BC8F76290D10F-42 |
Log | String | 日志内容 示例值:jobmanager-future-thread-4 |
LogContentInfo
日志内容实体
被如下接口引用:DescribeStreamTaskLogList。
名称 | 类型 | 描述 |
---|---|---|
Log | String | 日志内容 注意:此字段可能返回 null,表示取不到有效值。 示例值:"日志内容" |
PkgId | String | 日志组Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:"1" |
PkgLogId | String | 日志Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:"1" |
Time | Integer | 时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1712803796000 |
ContainerName | String | 日志所属的容器名 注意:此字段可能返回 null,表示取不到有效值。 示例值:"pod" |
MakePlanInstanceOpsDtoCollection
补录计划实例集合
被如下接口引用:DescribeOpsMakePlanInstances。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录总数 注意:此字段可能返回 null,表示取不到有效值。 |
TotalPage | Integer | 记录总页数 注意:此字段可能返回 null,表示取不到有效值。 |
PageCount | Integer | 当前页记录数 注意:此字段可能返回 null,表示取不到有效值。 |
PageNumber | Integer | 页码 注意:此字段可能返回 null,表示取不到有效值。 |
PageSize | Integer | 页大小 注意:此字段可能返回 null,表示取不到有效值。 |
Items | Array of InstanceOpsDto | 记录列表 注意:此字段可能返回 null,表示取不到有效值。 |
MakePlanOpsDto
补录计划
被如下接口引用:DescribeOpsMakePlans。
名称 | 类型 | 描述 |
---|---|---|
PlanId | String | 补录计划ID 注意:此字段可能返回 null,表示取不到有效值。 |
MakeName | String | 补录计划名称 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 |
CheckParent | Boolean | 补录是否检查父任务状态 注意:此字段可能返回 null,表示取不到有效值。 |
SameSelfDependType | Boolean | 是否使用任务原有自依赖配置 注意:此字段可能返回 null,表示取不到有效值。 |
ParallelNum | Integer | 并行度,在SameSelfDependType为false时生效 注意:此字段可能返回 null,表示取不到有效值。 |
SameCycle | Boolean | 补录实例生成周期是否修改 注意:此字段可能返回 null,表示取不到有效值。 |
SourceTaskCycle | String | 调度周期转换方式-原始周期类型 注意:此字段可能返回 null,表示取不到有效值。 |
TargetTaskCycle | String | 调度周期转换方式-目标周期类型 注意:此字段可能返回 null,表示取不到有效值。 |
TargetTaskAction | Integer | 调度周期转换方式-目标周期类型指定时间 注意:此字段可能返回 null,表示取不到有效值。 |
MapParamList | Array of StrToStrMap | 补录实例自定义参数 注意:此字段可能返回 null,表示取不到有效值。 |
CreatorId | String | 创建人ID 注意:此字段可能返回 null,表示取不到有效值。 |
Creator | String | 创建人 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
TaskIdList | Array of String | 补录任务ID集合 注意:此字段可能返回 null,表示取不到有效值。 |
MakeDatetimeList | Array of CreateMakeDatetimeInfo | 补录计划日期范围 注意:此字段可能返回 null,表示取不到有效值。 |
Remark | String | 补录计划说明 注意:此字段可能返回 null,表示取不到有效值。 |
SchedulerResourceGroup | String | 补录指定的调度资源组(ID) 注意:此字段可能返回 null,表示取不到有效值。 |
SchedulerResourceGroupName | String | 补录指定的调度资源组名称 注意:此字段可能返回 null,表示取不到有效值。 |
IntegrationResourceGroup | String | 补录指定的集成资源组(ID) 注意:此字段可能返回 null,表示取不到有效值。 |
IntegrationResourceGroupName | String | 补录指定的集成资源组名称 注意:此字段可能返回 null,表示取不到有效值。 |
TaskCount | Integer | 补录计划任务数量 注意:此字段可能返回 null,表示取不到有效值。 |
CompletePercent | Integer | 补录计划实例完成百分数 注意:此字段可能返回 null,表示取不到有效值。 |
SuccessPercent | Integer | 补录计划实例成功百分数 注意:此字段可能返回 null,表示取不到有效值。 |
CheckParentType | String | 补录检查父任务类型。取值范围: 注意:此字段可能返回 null,表示取不到有效值。 |
SameSelfWorkflowDependType | Boolean | 是否和原任务保持相同工作流自依赖属性 注意:此字段可能返回 null,表示取不到有效值。 |
SelfWorkflowDependency | String | 工作流自依赖类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:yes/no |
MakeDataTimeOrder | String | 补录时间顺序 NORMAL: 正常 ORDER : 按照实例时间顺序执行 REVERSE: 实例数据时间逆序 示例值:NORMAL |
ScheduleTimeZone | String | 补录时间范围的时区 示例值:UTC+8 |
AppParam | String | 执行应用参数 示例值:-executor-cores 2 --executor-memory 2g --conf spark.task.maxFailures=3 |
MakePlanOpsDtoCollection
补录计划集合
被如下接口引用:DescribeOpsMakePlans。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录总数 注意:此字段可能返回 null,表示取不到有效值。 |
TotalPage | Integer | 记录总页数 注意:此字段可能返回 null,表示取不到有效值。 |
PageCount | Integer | 当前页记录数 注意:此字段可能返回 null,表示取不到有效值。 |
PageNumber | Integer | 页码 注意:此字段可能返回 null,表示取不到有效值。 |
PageSize | Integer | 页大小 注意:此字段可能返回 null,表示取不到有效值。 |
Items | Array of MakePlanOpsDto | 记录列表 注意:此字段可能返回 null,表示取不到有效值。 |
MakePlanTaskOpsDto
补录计划任务
被如下接口引用:DescribeOpsMakePlanTasks。
名称 | 类型 | 描述 |
---|---|---|
TaskBaseInfo | TaskOpsDto | 任务基本信息 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceCount | Integer | 补录该任务当前已生成的实例数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
CompletePercent | Integer | 补录任务实例完成百分数 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
SuccessPercent | Integer | 补录任务实例成功百分数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
InstanceTotalCount | Integer | 预计生成的总实例个数,由于是异步生成,-1代表实例还未完完全生成 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
MakePlanTaskOpsDtoCollection
补录计划任务集合
被如下接口引用:DescribeOpsMakePlanTasks。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:35 |
TotalPage | Integer | 记录总页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:4 |
PageCount | Integer | 当前页记录数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
PageNumber | Integer | 页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageSize | Integer | 页大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Items | Array of MakePlanTaskOpsDto | 记录列表 注意:此字段可能返回 null,表示取不到有效值。 |
OfflineInstance
离线实例
被如下接口引用:GetOfflineDIInstanceList, GetOfflineInstanceList。
名称 | 类型 | 描述 |
---|---|---|
CreateUin | String | 创建账号sub uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028644555 |
OperatorUin | String | 操作账号sub uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028644555 |
OwnerUin | String | 主账号 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028644555 |
AppId | String | 账号 注意:此字段可能返回 null,表示取不到有效值。 示例值:1315051999 |
WorkspaceId | String | 项目Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1486446569620893696 |
TaskId | String | 任务Id 示例值:20220403160554926 |
CurRunDate | String | 数据时间 示例值:2022-04-01 15:50:00 |
IssueId | String | 下发时间 示例值:2022-04-19 10:16:33 |
InlongTaskId | String | 下发资源组id,非传入项 注意:此字段可能返回 null,表示取不到有效值。 示例值:uf2863331-0cb5-4a23-ae25-a9f970bcb18a |
ResourceGroup | String | 资源组 注意:此字段可能返回 null,表示取不到有效值。 示例值:20221220114407994449 |
TaskRunType | Integer | 任务类型(1 调试运行,2 调度执行) 示例值:1 |
State | String | 实例状态 EVENT_LISTENING|DEPENDENCE|BEFORE_ASPECT|ALLOCATED|LAUNCHED|KILL|SNAP_STATE_SAVING|ISSUED|RUNNING|AFTER_ASPECT|PENDING|KILLING|FINAL_STATE_SAVING|FAILED|KILL_FAILED| COMPLETED|EXPIRED|KILL_EXPIRED|DELETED 示例值:COMPLETED |
StartTime | String | 开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-04-11 11:04:29 |
EndTime | String | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-04-11 12:04:29 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-04-01 11:04:29 |
UpdateTime | String | 最后更新时间 示例值:2022-04-14 11:04:29 |
InstanceKey | String | 唯一key 注意:此字段可能返回 null,表示取不到有效值。 |
OfflineTaskAddParam
离线任务新增参数
被如下接口引用:CreateIntegrationTask, DescribeIntegrationTask, DescribeIntegrationTasks, ModifyIntegrationTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
WorkflowName | String | 是 | 名称 |
DependencyWorkflow | String | 是 | 依赖:yes、no 示例值:no |
StartTime | String | 是 | 任务开始数据时间。非空。默认当前时间 示例值:2022-04-10 00:00:00 |
EndTime | String | 是 | 任务结束数据时间。非空。默认当前时间 示例值:2099-12-31 00:00:00 |
CycleType | Integer | 是 | 周期类型。一次性任务:6、分钟任务:1、小时任务:2、天任务:3、周任务:4、月任务:5、crontab任务:0 示例值:1 |
CycleStep | Integer | 是 | 间隔,可选,默认1。非空。默认 1 示例值:1 |
DelayTime | Integer | 是 | 延时执行时间,单位分钟 示例值:0 |
CrontabExpression | String | 是 | 任务cron表达式,仅cron任务使用,其他时候默认为空 注意:此字段可能返回 null,表示取不到有效值。 示例值: 0 5 0,5 * * ? |
RetryWait | Integer | 是 | 重试等待 示例值:3 |
Retriable | Integer | 是 | 是否可以重试 示例值:1 |
TryLimit | Integer | 是 | 重试限制 示例值:3 |
RunPriority | Integer | 是 | 优先级 示例值:6 |
ProductName | String | 是 | 产品名称 示例值:DATA_INTEGRATION |
SelfDepend | Integer | 是 | 1 有序串行 一次一个,排队 orderly 2 无序串行 一次一个,不排队 serial 3 并行 一次多个 parallel 示例值:3 |
TaskAction | String | 否 | 时间指定,如月任务指定1,3号,则填入 1,3。非空。默认 "" 月任务:如具体1,3号则写 "1,3",指定月末不可和具体号数一起输入,仅能为 "L" 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ExecutionEndTime | String | 否 | 调度执行结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:23:59 |
ExecutionStartTime | String | 否 | 调度执行开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:00:00 |
TaskAutoSubmit | Boolean | 否 | 是否自动提交 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
InstanceInitStrategy | String | 否 | 实例生成方式,T_PLUS_0 当天任务当天调度 / T_PLUS_1 当天任务后一天调度 注意:此字段可能返回 null,表示取不到有效值。 示例值:T+0 |
OperationOpsDto
操作返回结果
被如下接口引用:BatchStopWorkflowsByIds, DeleteWorkflowById, FreezeTasksByWorkflowIds, RunTasksByMultiWorkflow。
名称 | 类型 | 描述 |
---|---|---|
Result | Boolean | 操作是否成功 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
ResultMsg | String | 操作结果详情 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorId | String | 操作失败类型 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorDesc | String | 操作失败描述 注意:此字段可能返回 null,表示取不到有效值。 |
AsyncActionId | String | 异步操作记录id |
OpsTaskCanvasDto
任务信息
被如下接口引用:DescribeDependOpsTasks。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:"111" |
TaskName | String | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"周期任务" |
WorkflowId | String | 工作流id 注意:此字段可能返回 null,表示取不到有效值。 示例值:"xxxxx-yyyy" |
WorkflowName | String | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"工作流名称" |
ProjectName | String | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"项目名称" |
ProjectIdent | String | 项目标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:"项目标识" |
Status | String | 任务状态,'Y','F','O','T','INVALID' 分别表示调度中、已停止、已暂停、停止中、已失效 注意:此字段可能返回 null,表示取不到有效值。 示例值:"Y" |
TaskTypeId | Integer | 任务类型id 注意:此字段可能返回 null,表示取不到有效值。 示例值:"12" |
TaskTypeDesc | String | 任务类型描述,其中任务类型id和任务类型描述的对应的关系为 20 通用数据同步任务 21 JDBC SQL 22 Tbase 25 数据ETL 30 Python 31 PySpark 34 Hive SQL 35 Shell 36 Spark SQL 37 HDFS到HBase 38 SHELL 39 Spark 45 DATA_QUALITY 55 THIVE到MYSQL 56 THIVE到PG 66 HDFS到PG 67 HDFS到Oracle 68 HDFS到MYSQL 69 FTP到HDFS 70 HIVE SQL 72 HIVE到HDFS 75 HDFS到HIVE 81 PYTHONSQL脚本 82 SPARKSCALA计算 83 虫洞任务 84 校验对账文件 85 HDFS到THIVE 86 TDW到HDFS 87 HDFS到TDW 88 校验对账文件 91 FLINK任务 92 MapReduce 98 custom topology 99 kafkatoHDFS 100 kafkatoHbase 101 MYSQL导入至HIVE(DX) 104 MYSQL到HIVE 105 HIVE到MYSQL 106 SQL SERVER到HIVE 107 HIVE到SQL SERVER 108 ORACLE到HIVE 109 HIVE到ORACLE 111 HIVE到MYSQL(NEW) 112 HIVE到PG 113 HIVE到PHOENIX 118 MYSQL到HDFS 119 PG到HDFS 120 ORACLE到HDFS 121 数据质量 10000 自定义业务 注意:此字段可能返回 null,表示取不到有效值。 示例值:"shell" |
ProjectId | String | 项目id 注意:此字段可能返回 null,表示取不到有效值。 示例值:"12" |
FolderName | String | 文件夹名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"测试文件夹" |
FolderId | String | 文件夹id 注意:此字段可能返回 null,表示取不到有效值。 示例值:"12" |
FirstSubmitTime | String | 最近提交时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-09-08 12:00:00 |
FirstRunTime | String | 首次运行时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-09-08 12:00:00 |
ScheduleDesc | String | 调度计划展示描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:从2022-09-08 12:00:00 开始 ,间隔1天执行一次 |
InCharge | String | 负责人 注意:此字段可能返回 null,表示取不到有效值。 示例值:wang;ling; |
CycleUnit | String | 调度周期类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:"O" |
LeftCoordinate | Float | 画布x轴坐标点 注意:此字段可能返回 null,表示取不到有效值。 示例值:234.34 |
TopCoordinate | Float | 画布y轴坐标点 注意:此字段可能返回 null,表示取不到有效值。 示例值:345.23 |
VirtualFlag | Boolean | 跨工作流虚拟任务标识;true标识跨工作流任务;false标识本工作流任务 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
TaskAction | String | 弹性周期配置 注意:此字段可能返回 null,表示取不到有效值。 示例值:"3" |
DelayTime | Integer | 延迟时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ExecutionStartTime | String | 执行开始时间 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionEndTime | String | 执行结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
Layer | String | 层级 注意:此字段可能返回 null,表示取不到有效值。 |
SourceServiceId | String | 来源数据源ID 注意:此字段可能返回 null,表示取不到有效值。 |
SourceServiceType | String | 来源数据源类型 注意:此字段可能返回 null,表示取不到有效值。 |
TargetServiceId | String | 目标数据源ID 注意:此字段可能返回 null,表示取不到有效值。 |
TargetServiceType | String | 目标数据源类型 注意:此字段可能返回 null,表示取不到有效值。 |
AlarmType | String | 任务告警类型 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 任务创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
OpsTaskCanvasInfoList
画布所需的信息
被如下接口引用:DescribeDependOpsTasks。
名称 | 类型 | 描述 |
---|---|---|
TasksList | Array of OpsTaskCanvasDto | 画布任务信息 |
LinksList | Array of OpsTaskLinkInfoDto | 画布任务链接信息 |
CirculateTaskList | Array of OpsTaskCanvasDto | 画布循环依赖任务信息 注意:此字段可能返回 null,表示取不到有效值。 |
OpsTaskInfoPage
任务分页查询
被如下接口引用:DescribeOperateOpsTasks。
名称 | 类型 | 描述 |
---|---|---|
PageNumber | Integer | 页号 示例值:1 |
PageSize | Integer | 页大小 示例值:15 |
Items | Array of TaskOpsDto | 任务列表信息 |
TotalPage | Integer | 总页数 示例值:10 |
PageCount | Integer | 页数 示例值:1 |
TotalCount | Integer | 总条数 示例值:10 |
OpsTaskLinkInfoDto
任务依赖的边信息
被如下接口引用:DescribeDependOpsTasks。
名称 | 类型 | 描述 |
---|---|---|
TaskTo | String | 下游任务id 示例值:"111111" |
TaskFrom | String | 上游任务id 示例值:"222222" |
LinkType | String | 依赖边类型 1、“real_real”表示任务->任务;2、"virtual_real" 跨工作流任务->任务 示例值:"real_real" |
LinkId | String | 依赖边id 示例值:"121212" |
LinkStyle | String | 为了区分新增的循环依赖新增的类型。默认是normal,循环依赖则是circulate 注意:此字段可能返回 null,表示取不到有效值。 示例值:normal,circulate |
OrderField
通用排序字段
被如下接口引用:DescribeAlarmEvents, DescribeColumnsMeta, DescribeDataSourceInfoList, DescribeDataSourceList, DescribeDatabaseMetas, DescribeFieldBasicInfo, DescribeIntegrationTasks, DescribeOrganizationalFunctions, DescribeRuleGroupExecResultsByPage, DescribeRuleGroupsByPage, DescribeRuleTemplatesByPage, DescribeRulesByPage, DescribeTableBasicInfo, DescribeTableMetas, DescribeTablePartitions, DescribeTableQualityDetails, DescribeTaskAlarmRegulations。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 排序字段名称 示例值:Name |
Direction | String | 是 | 排序方向:ASC|DESC 示例值:ASC |
OrderFieldOptional
通用排序字段
被如下接口引用:DescribeApproveList, DescribeProjectUsers。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 否 | 排序字段名称 示例值:Name |
Direction | String | 否 | 排序方向:ASC|DESC 示例值:ASC |
OrderFields
排序
被如下接口引用:DescribeTaskTableMetricOverview。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 否 | 字段 示例值:1 |
Direction | String | 否 | 排序 示例值:desc |
OrganizationalFunction
包含层级信息的函数
被如下接口引用:DescribeOrganizationalFunctions。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 名称 |
DisplayName | String | 展示名称 |
LayerPath | String | 层级路径 示例值:/SPARK/CUSTOM |
ParentLayerPath | String | 上级层级路径 示例值:/SPARK |
Type | String | 函数类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:HIVE、SPARK |
Kind | String | 函数分类:窗口函数、聚合函数、日期函数...... 注意:此字段可能返回 null,表示取不到有效值。 示例值:ANALYSIS、ENCRYPTION |
Category | String | 函数种类:系统函数、自定义函数 注意:此字段可能返回 null,表示取不到有效值。 示例值:BUILD_IN、CUSTOM |
Status | String | 函数状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:NEW、SAVED |
Description | String | 函数说明 注意:此字段可能返回 null,表示取不到有效值。 |
Usage | String | 函数用法 注意:此字段可能返回 null,表示取不到有效值。 |
ParamDesc | String | 函数参数说明 注意:此字段可能返回 null,表示取不到有效值。 |
ReturnDesc | String | 函数返回值说明 注意:此字段可能返回 null,表示取不到有效值。 |
Example | String | 函数示例 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterIdentifier | String | 集群实例引擎 ID 注意:此字段可能返回 null,表示取不到有效值。 |
FuncId | String | 函数 ID 注意:此字段可能返回 null,表示取不到有效值。 |
ClassName | String | 函数类名 注意:此字段可能返回 null,表示取不到有效值。 |
ResourceList | Array of FunctionVersion | 函数资源列表 注意:此字段可能返回 null,表示取不到有效值。 |
OperatorUserIds | Array of Integer | 操作人 ID 列表 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerUserIds | Array of Integer | 公有云 Owner ID 列表 注意:此字段可能返回 null,表示取不到有效值。 |
DbName | String | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 |
SubmitErrorMsg | String | 提交失败错误信息 注意:此字段可能返回 null,表示取不到有效值。 |
SchemaName | String | 模式名 注意:此字段可能返回 null,表示取不到有效值。 |
CommandFormat | String | 函数命令格式 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerName | String | 名称 注意:此字段可能返回 null,表示取不到有效值。 |
SubmitTimestamp | String | 时间戳 注意:此字段可能返回 null,表示取不到有效值。 |
Tag | String | 函数tag 注意:此字段可能返回 null,表示取不到有效值。 示例值:createSource=DLC&virtualFunctionId=id |
OperatorUserIdsStr | Array of String | 操作人 ID 列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:["123456"] |
OwnerUserIdsStr | Array of String | 公有云 Owner ID 列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:["123456"] |
EnvType | String | 数据库环境 注意:此字段可能返回 null,表示取不到有效值。 示例值:DEV;PROD |
FunctionResourceFileType | String | 函数资源文件类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:JAR;PYTHON |
Pair
键值对
被如下接口引用:DescribeColumnsMeta。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 是 | 键名 示例值:name |
Value | String | 是 | 值 示例值:Tom |
Id | String | 否 | 唯一标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
PairDto
键值对
被如下接口引用:DescribeInstanceLogDetail, DescribeWorkflowTaskCount。
名称 | 类型 | 描述 |
---|---|---|
Key | String | 键名 注意:此字段可能返回 null,表示取不到有效值。 示例值:Name |
Value | String | 值 注意:此字段可能返回 null,表示取不到有效值。 示例值:Tom |
Description | String | 描述 示例值:yarn id |
ParamInfo
参数参数
被如下接口引用:DeleteFilePath, GetFileInfo, ModifyTaskInfo, ModifyWorkflowInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ParamKey | String | 是 | 参数名 |
ParamValue | String | 是 | 参数值 |
ParamInfoDs
参数参数
被如下接口引用:DescribeAllByFolderNew, DescribeDependTaskLists, DescribeSuccessorOpsTaskInfos, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ParamKey | String | 是 | 参数名 |
ParamValue | String | 是 | 参数值 |
Partition
分区参数
被如下接口引用:GenHiveTableDDLSql。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Transform | String | 否 | 分区转换策略 示例值:10 |
Name | String | 否 | 分区字段名 示例值:aa |
TransformArgs | Array of String | 否 | 策略参数 |
PathNodeDsVO
数据开发-统一树结构返回属性
被如下接口引用:DescribeDsFolderTree, DescribeDsParentFolderTree。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | String | 否 | PathNode ID 注意:此字段可能返回 null,表示取不到有效值。 |
Title | String | 否 | PathNode 名称 注意:此字段可能返回 null,表示取不到有效值。 |
Type | String | 否 | PathNode 类型 注意:此字段可能返回 null,表示取不到有效值。 |
ParentId | String | 否 | 父节点唯一标识 注意:此字段可能返回 null,表示取不到有效值。 |
IsLeaf | Boolean | 否 | 是否叶子节点 注意:此字段可能返回 null,表示取不到有效值。 |
Children | Array of PathNodeDsVO | 否 | 子节点列表 注意:此字段可能返回 null,表示取不到有效值。 |
Params | String | 否 | 业务参数 ,base64编译的json串,获取具体参数需要base64反编译 注意:此字段可能返回 null,表示取不到有效值。 |
ProdSchedulerTask
数据质量生产调度任务业务实体
被如下接口引用:CreateRule, DescribeExecStrategy, DescribeRule, DescribeRuleGroup, DescribeRules, ModifyExecStrategy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
WorkflowId | String | 是 | 生产调度任务工作流ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TaskId | String | 否 | 生产调度任务Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TaskName | String | 否 | 生产调度任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:task1 |
CycleType | Integer | 否 | 生产调度任务任务类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:6 |
Project
项目信息
被如下接口引用:DescribeProject。
名称 | 类型 | 描述 |
---|---|---|
TenantId | String | 项目的所在租户ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ProjectId | String | 项目id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ProjectName | String | 项目标识,英文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:testpj |
DisplayName | String | 项目显示名称,可以为中文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:项目a |
Region | String | 地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:beijing |
Description | String | 备注 注意:此字段可能返回 null,表示取不到有效值。 示例值:备注 |
CreateTime | Timestamp ISO8601 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2014-08-03T12:00:00+08:00 |
Creator | BaseUser | 创建者 注意:此字段可能返回 null,表示取不到有效值。 |
Tenant | BaseTenant | 租户信息 注意:此字段可能返回 null,表示取不到有效值。 |
AdminUsers | Array of BaseUser | 项目的管理员 注意:此字段可能返回 null,表示取不到有效值。 |
Clusters | Array of BaseClusterInfo | 项目关联的集群信息 注意:此字段可能返回 null,表示取不到有效值。 |
Params | String | 项目的额外配置参数 注意:此字段可能返回 null,表示取不到有效值。 示例值:{etr='a'} |
Status | Integer | 项目状态:0:禁用,1:启用,-3:禁用中,2:启用中 示例值:1 |
Model | String | 项目类型,SIMPLE:简单模式 STANDARD:标准模式 注意:此字段可能返回 null,表示取不到有效值。 示例值:STANDARD |
SecondModuleList | Array of String | 二级菜单 注意:此字段可能返回 null,表示取不到有效值。 示例值:[101101,101102] |
ProjectBaseInfoOpsRequest
基础信息
被如下接口引用:DagInstances, DescribeAllByFolderNew, DescribeScheduleInstances, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ProjectId | String | 否 | 项目Id |
ProjectIdent | String | 否 | 项目标识 |
ProjectName | String | 否 | 项目名称 |
IsAdmin | Boolean | 否 | 是否admin |
ProjectUserRole
项目的用户对象
被如下接口引用:DescribeProjectUsers。
名称 | 类型 | 描述 |
---|---|---|
Roles | Array of SystemRole | 用户角色对象 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
UserName | String | mc 注意:此字段可能返回 null,表示取不到有效值。 示例值:名称 |
UserId | String | 用户id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Creator | Boolean | 是否创建者 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
DisplayName | String | 显示名称 注意:此字段可能返回 null,表示取不到有效值。 |
IsProjectAdmin | Boolean | 是否项目管理员 注意:此字段可能返回 null,表示取不到有效值。 |
PhoneNum | String | 手机号 注意:此字段可能返回 null,表示取不到有效值。 |
String | 邮箱 注意:此字段可能返回 null,表示取不到有效值。 |
|
OwnerUin | String | 主账号id 注意:此字段可能返回 null,表示取不到有效值。 |
AppId | String | 租户iD 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectUsersPage
项目下的用户集合
被如下接口引用:DescribeProjectUsers。
名称 | 类型 | 描述 |
---|---|---|
Rows | Array of ProjectUserRole | 用户集合 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
PageSize | Integer | 分页大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
PageNumber | Integer | 分页页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TotalCount | Integer | 总数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TotalPageNumber | Integer | 总分页页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Property
dlc建表属性
被如下接口引用:GenHiveTableDDLSql, SubmitTaskTestRun。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 是 | key值 示例值:aa |
Value | String | 是 | value值 示例值:bb |
QualityScore
质量评分
被如下接口引用:DescribeQualityScore。
名称 | 类型 | 描述 |
---|---|---|
CompositeScore | Float | 综合分数 注意:此字段可能返回 null,表示取不到有效值。 示例值:12.0 |
ScoringDistribution | Array of TableScoreStatisticsInfo | 评分分布 注意:此字段可能返回 null,表示取不到有效值。 |
TotalTableNumber | Integer | 总表数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
QualityScoreTrend
质量评分趋势
被如下接口引用:DescribeQualityScoreTrend, DescribeTableScoreTrend。
名称 | 类型 | 描述 |
---|---|---|
AverageScore | Float | 周期平均分 注意:此字段可能返回 null,表示取不到有效值。 示例值:12.12 |
DailyScoreList | Array of DailyScoreInfo | 日评分列表 注意:此字段可能返回 null,表示取不到有效值。 |
QuietPeriod
数据集成 - 告警免打扰时间
被如下接口引用:BatchCreateIntegrationTaskAlarms, CreateTaskAlarmRegular, DescribeTaskAlarmRegulations, ModifyTaskAlarmRegular。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DaysOfWeek | Array of Integer | 否 | 代表一周里的哪些天,1代表周一,7代表周日,以此类推 注意:此字段可能返回 null,表示取不到有效值。 示例值:[1,2] |
StartTime | String | 否 | 开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:10:00:00 |
EndTime | String | 否 | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:12:00:00 |
RealTimeTaskInstanceNodeInfo
实时任务实例当前的节点信息
被如下接口引用:DescribeRealTimeTaskInstanceNodeInfo。
名称 | 类型 | 描述 |
---|---|---|
TaskName | String | 任务名 注意:此字段可能返回 null,表示取不到有效值。 示例值:taskTestName |
TaskId | String | 任务id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1e12a7d0-81a6-4b36-90f9-deabefb0dc7a |
InstanceNodeInfoList | Array of InstanceNodeInfo | 实时任务实例节点信息列表 注意:此字段可能返回 null,表示取不到有效值。 |
RealTimeTaskSpeed
实时任务同步速度趋势
被如下接口引用:DescribeRealTimeTaskSpeed。
名称 | 类型 | 描述 |
---|---|---|
RecordsSpeedList | Array of RecordsSpeed | 同步速度条/s列表 |
BytesSpeedList | Array of BytesSpeed | 同步速度字节/s列表 |
RecordField
通用记录字段,与服务端约定传入合法的键值对
被如下接口引用:BatchStartIntegrationTasks, CommitIntegrationTask, CreateIntegrationNode, CreateIntegrationTask, DescribeColumnLineage, DescribeIntegrationNode, DescribeIntegrationTask, DescribeIntegrationTasks, DescribeIntegrationVersionNodesInfo, DescribeTableLineage, DescribeTableLineageInfo, GetIntegrationNodeColumnSchema, ModifyIntegrationNode, ModifyIntegrationTask, ModifyTaskScript, ResumeIntegrationTask, StartIntegrationTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 否 | 字段名称,拓展字段名称 示例值:"concurrency" |
Value | String | 否 | 字段值,拓展字段值 示例值:"1" |
RecordsSpeed
实时任务同步速度 条/s
被如下接口引用:DescribeRealTimeTaskSpeed。
名称 | 类型 | 描述 |
---|---|---|
NodeType | String | 节点类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:SOURCE |
NodeName | String | 节点名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:mysql读取节点 |
Values | Array of SpeedValue | 速度值列表 注意:此字段可能返回 null,表示取不到有效值。 |
ResourcePathTree
资源管理目录树节点
被如下接口引用:DescribeResourceManagePathTrees。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 资源名字 注意:此字段可能返回 null,表示取不到有效值。 示例值:demo.zip |
IsLeaf | Boolean | 是否为叶子节点 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
ResourceId | String | 资源ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:03343a77-b586-4b78-8e3e-222222222 |
LocalPath | String | 本地路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:/datastudio/resource/1171938333333/demo/1-201111193502.zip |
RemotePath | String | 远程路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:/datastudio/resource/1171938333333/demo/1-201111193502.zip |
FileExtensionType | String | 文件类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:zip |
Size | Integer | 文件大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
Md5Value | String | 文件MD5值 注意:此字段可能返回 null,表示取不到有效值。 示例值:md5Demo |
OwnerName | String | 文件拥有者名字 注意:此字段可能返回 null,表示取不到有效值。 示例值:demoUser |
UpdateUser | String | 更新人 注意:此字段可能返回 null,表示取不到有效值。 示例值:demoUser |
UpdateUserId | String | 文件更新人uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:125733333 |
CreateTime | Integer | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1663299308000 |
UpdateTime | Integer | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1663299308000 |
CosBucket | String | Cos存储桶名 注意:此字段可能返回 null,表示取不到有效值。 示例值:demo-125733333 |
CosRegion | String | Cos地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou |
ExtraInfo | String | 额外信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:null |
RobLockState
抢锁状态:是否可以抢锁和当前持锁人
被如下接口引用:RobAndLockIntegrationTask。
名称 | 类型 | 描述 |
---|---|---|
IsRob | Boolean | 是否可以抢锁 示例值:false |
Locker | String | 当前持锁人 示例值:100022256608 |
RolePrivilege
角色权限对象
被如下接口引用:DescribeProjectUsers。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
PrivilegeId | String | 否 | id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PrivilegeName | String | 否 | 名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:名称 |
RestPath | String | 否 | 路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:路径 |
RestMethod | String | 否 | 方法 注意:此字段可能返回 null,表示取不到有效值。 示例值:方法 |
Description | String | 否 | 描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:描述 |
ModuleId | String | 否 | 模块id 注意:此字段可能返回 null,表示取不到有效值。 示例值:模块id |
Type | String | 否 | 权限类型 N、R、RW、RWD 注意:此字段可能返回 null,表示取不到有效值。 示例值:RWD |
Rule
数据质量规则
被如下接口引用:CreateRule, DescribeRule, DescribeRules, DescribeRulesByPage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleId | Integer | 否 | 规则ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
RuleGroupId | Integer | 否 | 规则组ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TableId | String | 否 | 数据表Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
Name | String | 否 | 规则名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:rule1 |
Type | Integer | 否 | 规则类型 1.系统模版, 2.自定义模版, 3.自定义SQL 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RuleTemplateId | Integer | 否 | 规则模板Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
RuleTemplateContent | String | 否 | 规则模板概述 注意:此字段可能返回 null,表示取不到有效值。 示例值:准确性:表行数,与固定值比较 |
QualityDim | Integer | 否 | 规则所属质量维度 1:准确性,2:唯一性,3:完整性,4:一致性,5:及时性,6:有效性 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
SourceObjectType | Integer | 否 | 规则适用的源数据对象类型(1:常量,2:离线表级,3:离线字段级别) 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
SourceObjectDataType | Integer | 否 | 规则适用的源数据对象类型(1:数值,2:字符串) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
SourceObjectDataTypeName | String | 否 | 源字段详细类型,INT、STRING 注意:此字段可能返回 null,表示取不到有效值。 示例值:int |
SourceObjectValue | String | 否 | 源字段名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Name |
ConditionType | Integer | 否 | 检测范围 1.全表, 2.条件扫描 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
ConditionExpression | String | 否 | 条件扫描WHERE条件表达式 注意:此字段可能返回 null,表示取不到有效值。 示例值:dt=1 |
CustomSql | String | 否 | 自定义SQL 注意:此字段可能返回 null,表示取不到有效值。 示例值:select count(*) from person |
CompareRule | CompareRule | 否 | 报警触发条件 注意:此字段可能返回 null,表示取不到有效值。 |
AlarmLevel | Integer | 否 | 报警触发级别 1.低, 2.中, 3.高 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Description | String | 否 | 规则描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:demo |
Operator | String | 否 | 规则配置人 注意:此字段可能返回 null,表示取不到有效值。 示例值:park |
TargetDatabaseId | String | 否 | 目标库Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TargetDatabaseName | String | 否 | 目标库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TargetTableId | String | 否 | 目标表Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TargetTableName | String | 否 | 目标表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TargetConditionExpr | String | 否 | 目标字段过滤条件表达式 注意:此字段可能返回 null,表示取不到有效值。 示例值:dt=${yyyymmdd} |
RelConditionExpr | String | 否 | 源字段与目标字段关联条件on表达式 注意:此字段可能返回 null,表示取不到有效值。 示例值:a.age=b.age |
FieldConfig | RuleFieldConfig | 否 | 自定义模版sql表达式参数 注意:此字段可能返回 null,表示取不到有效值。 |
MultiSourceFlag | Boolean | 否 | 是否关联多表 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
WhereFlag | Boolean | 否 | 是否where参数 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
TemplateSql | String | 否 | 模版原始SQL 注意:此字段可能返回 null,表示取不到有效值。 示例值:select count(1) from ${table_1} |
SubQualityDim | Integer | 否 | 模版子维度:0.父维度类型,1.一致性: 枚举范围一致性,2.一致性:数值范围一致性,3.一致性:字段数据相关性 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TargetObjectType | Integer | 否 | 规则适用的目标数据对象类型(1:常量,2:离线表级,3:离线字段级别) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TargetObjectDataType | Integer | 否 | 规则适用的目标数据对象类型(1:数值,2:字符串) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TargetObjectDataTypeName | String | 否 | 目标字段详细类型,INT、STRING 注意:此字段可能返回 null,表示取不到有效值。 示例值:INT |
TargetObjectValue | String | 否 | 目标字段名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
SourceEngineTypes | Array of Integer | 否 | 源端对应的引擎类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:[1] |
TableName | String | 否 | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:table |
TableOwnerName | String | 否 | 表负责人名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:tableowner |
ExecStrategy | RuleGroupExecStrategy | 否 | 执行策略信息 注意:此字段可能返回 null,表示取不到有效值。 |
Subscription | RuleGroupSubscribe | 否 | 订阅信息 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-07-20 12:22:22 |
DatasourceId | Integer | 否 | 数据源 id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatabaseId | String | 否 | 数据库 id 注意:此字段可能返回 null,表示取不到有效值。 示例值:databaseId1 |
MonitorStatus | Integer | 否 | 监控是否开启.0false,1true 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TriggerCondition | String | 否 | 触发条件 注意:此字段可能返回 null,表示取不到有效值。 示例值:波动率上升大于等于10% 或 下降小于等于10% 或 下降在[10%,20%)区间内 |
DsEnvType | Integer | 否 | 0或者未返回或者null:未定义,1:生产,2:开发 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatasourceType | Integer | 否 | 数据源类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
SchemaName | String | 否 | 模式名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
TargetSchemaName | String | 否 | 目标模式名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
ProjectId | String | 否 | 项目id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
ProjectName | String | 否 | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:projectName |
RuleConfig
规则配置
被如下接口引用:CommitRuleGroupTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleId | Integer | 否 | 规则ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
ConditionType | Integer | 否 | 规则检测范围类型 1.全表 2.条件扫描 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Condition | String | 否 | 检测范围表达式 注意:此字段可能返回 null,表示取不到有效值。 示例值:dt=1 |
TargetCondition | String | 否 | 目标检测范围表达式 注意:此字段可能返回 null,表示取不到有效值。 示例值:st=1 |
RuleDimCnt
RuleDimCnt 规则维度统计
被如下接口引用:DescribeRuleDimStat。
名称 | 类型 | 描述 |
---|---|---|
Dim | Integer | 1:准确性,2:唯一性,3:完整性,4:一致性,5:及时性,6:有效性 示例值:1 |
Cnt | Integer | count 数 示例值:1 |
RuleDimStat
规则维度数统计
被如下接口引用:DescribeRuleDimStat。
名称 | 类型 | 描述 |
---|---|---|
TotalCnt | Integer | 总数 示例值:1 |
DimCntList | Array of RuleDimCnt | 维度统计数 |
RuleExecConfig
规则执行配置
被如下接口引用:CommitRuleGroupTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
QueueName | String | 否 | 计算队列名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Default |
ExecutorGroupId | String | 否 | 执行资源组 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
EngineType | String | 否 | 运行的执行引擎,不传时会请求该数据源下默认的执行引擎 注意:此字段可能返回 null,表示取不到有效值。 示例值:HIVE |
DlcGroupName | String | 否 | DLC执行引擎资源组 注意:此字段可能返回 null,表示取不到有效值。 示例值:default |
RuleExecDateStat
概览趋势结果
被如下接口引用:DescribeTrendStat。
名称 | 类型 | 描述 |
---|---|---|
StatDate | String | 统计日期 示例值:2022-01-12 |
AlarmCnt | Integer | 告警数 示例值:1 |
PipelineCnt | Integer | 阻塞数 示例值:1 |
RuleExecLog
规则执行日志
被如下接口引用:DescribeRuleExecLog。
名称 | 类型 | 描述 |
---|---|---|
Finished | Boolean | 是否完成 注意:此字段可能返回 null,表示取不到有效值。 |
Log | String | 内容 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RuleExecResult
规则执行结果
被如下接口引用:CommitRuleGroupTask, DescribeRuleExecDetail, DescribeRuleExecResults, DescribeRuleGroupExecResultsByPage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleExecId | Integer | 否 | 规则执行ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
RuleGroupExecId | Integer | 否 | 规则组执行ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
RuleGroupId | Integer | 否 | 规则组ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
RuleId | Integer | 否 | 规则ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
RuleName | String | 否 | 规则名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:rule1 |
RuleType | Integer | 否 | 规则类型 1.系统模版, 2.自定义模版, 3.自定义SQL 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
SourceObjectDataTypeName | String | 否 | 源字段详细类型,int string 注意:此字段可能返回 null,表示取不到有效值。 示例值:int |
SourceObjectValue | String | 否 | 源字段名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Name |
ConditionExpression | String | 否 | 条件扫描WHERE条件表达式 注意:此字段可能返回 null,表示取不到有效值。 示例值:dt=1 |
ExecResultStatus | Integer | 否 | 检测结果(1:检测通过,2:触发规则,3:检测失败) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TriggerResult | String | 否 | 触发结果,告警发送成功, 阻断任务成功 注意:此字段可能返回 null,表示取不到有效值。 示例值:告警发送成功, 阻断任务成功 |
CompareResult | CompareResult | 否 | 对比结果 注意:此字段可能返回 null,表示取不到有效值。 |
TemplateName | String | 否 | 模版名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Name |
QualityDim | Integer | 否 | 质量维度 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TargetDBTableName | String | 否 | 目标表-库表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:defaule.person |
TargetObjectValue | String | 否 | 目标表-字段名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:city |
TargetObjectDataType | String | 否 | 目标表-字段类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:string |
FieldConfig | RuleFieldConfig | 否 | 自定义模版sql表达式参数 注意:此字段可能返回 null,表示取不到有效值。 |
RelConditionExpr | String | 否 | 源字段与目标字段关联条件on表达式 注意:此字段可能返回 null,表示取不到有效值。 示例值:a=b |
StartTime | String | 否 | 执行时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-09-10 01:00:00 |
AlarmLevel | Integer | 否 | 1/2/3:低/中/高 注意:此字段可能返回 null,表示取不到有效值。 示例值:告警级别 |
TriggerCondition | String | 否 | 触发条件 注意:此字段可能返回 null,表示取不到有效值。 示例值:固定值>1 |
RuleExecResultDetail
规则执行结果详情
被如下接口引用:DescribeRuleExecDetail。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DatasourceId | Integer | 否 | 数据源id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
DatasourceName | String | 否 | 数据源名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Default |
DatabaseId | String | 否 | 数据库guid 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
DatabaseName | String | 否 | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Default |
InstanceId | String | 否 | 实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TableId | String | 否 | 表guid 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TableName | String | 否 | 表名 注意:此字段可能返回 null,表示取不到有效值。 示例值:person |
RuleExecResult | RuleExecResult | 否 | 规则执行记录 注意:此字段可能返回 null,表示取不到有效值。 |
TableOwnerUserId | Integer | 否 | 表负责人userId 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
DatasourceType | Integer | 否 | 2.HIVE 3.DLC 注意:此字段可能返回 null,表示取不到有效值。 示例值:数据源类型 |
ClusterDeployType | String | 否 | 集群部署类型,CVM/TKE 注意:此字段可能返回 null,表示取不到有效值。 示例值:CVM |
RuleExecResultPage
规则执行结果分页
被如下接口引用:DescribeRuleExecResults。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Items | Array of RuleExecResult | 规则执行结果 |
RuleExecStat
规则运行情况结果
被如下接口引用:DescribeRuleExecStat。
名称 | 类型 | 描述 |
---|---|---|
TotalCnt | Integer | 规则运行总数 示例值:1 |
LastTotalCnt | Integer | 环比规则运行总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TotalCntRatio | Float | 规则运行总数占比 示例值:1 |
LastTotalCntRatio | Float | 规则运行总数环比变化 注意:此字段可能返回 null,表示取不到有效值。 示例值:0,4 |
TriggerCnt | Integer | 规则触发数 示例值:1 |
LastTriggerCnt | Integer | 环比规则触发数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TriggerCntRatio | Float | 触发占总数占比 示例值:0.6 |
LastTriggerCntRatio | Float | 环比规则触发数变化 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.6 |
AlarmCnt | Integer | 规则报警数 示例值:1 |
LastAlarmCnt | Integer | 环比规则报警数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AlarmCntRatio | Float | 报警占总数占比 示例值:0.6 |
LastAlarmCntRatio | Float | 环比报警数变化 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.6 |
PipelineCnt | Integer | 阻塞发生数 示例值:1 |
LastPipelineCnt | Integer | 环比阻塞发生数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PipelineCntRatio | Float | 阻塞占总数占比 示例值:0.6 |
LastPipelineCntRatio | Float | 环比阻塞发生数变化 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.6 |
RuleFieldConfig
规则变量替换
被如下接口引用:CommitRuleGroupTask, CreateRule, DescribeRule, DescribeRuleExecDetail, DescribeRuleExecResults, DescribeRuleGroupExecResultsByPage, DescribeRules, ModifyRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
WhereConfig | Array of FieldConfig | 否 | where变量 注意:此字段可能返回 null,表示取不到有效值。 |
TableConfig | Array of TableConfig | 否 | 库表变量 注意:此字段可能返回 null,表示取不到有效值。 |
RuleGroup
数据质量规则组
被如下接口引用:DescribeRuleGroup, DescribeRuleGroupsByPage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleGroupId | Integer | 否 | 规则组Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
DatasourceId | String | 否 | 数据源Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
DatasourceName | String | 否 | 数据源名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:mysql_test |
DatasourceType | Integer | 否 | 数据源类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
MonitorType | Integer | 否 | 监控类型 1.未配置, 2.关联生产调度, 3.离线周期检测 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
UpdateTime | String | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-02-08 14:30:30 |
TableName | String | 否 | 关联数据表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:person |
TableId | String | 否 | 关联数据表Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TableOwnerName | String | 否 | 关联数据表负责人 注意:此字段可能返回 null,表示取不到有效值。 示例值:park |
ExecStrategy | RuleGroupExecStrategy | 否 | 执行策略 注意:此字段可能返回 null,表示取不到有效值。 |
Subscription | RuleGroupSubscribe | 否 | 执行策略 注意:此字段可能返回 null,表示取不到有效值。 |
DatabaseId | String | 否 | 数据库id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
DatabaseName | String | 否 | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:base1 |
SchemaName | String | 否 | 模式名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
Permission | Boolean | 否 | 是否有权限 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
RuleCount | Integer | 否 | 已经配置的规则数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:12 |
MonitorStatus | Boolean | 否 | 监控状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
TableOwnerUserId | Integer | 否 | 表负责人UserId 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
InstanceId | String | 否 | 实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:qxd324 |
CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-08-01 00:00:00 |
StrategyConfig | Boolean | 否 | 是否已配置执行策略 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
SubscribeConfig | Boolean | 否 | 是否已配置执行策略 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
DsEnvType | Integer | 否 | 数据源环境:0或者未返回.未定义,1.生产 2.开发 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ClusterDeployType | String | 否 | EMR集群部署方式:CVM/TKE 注意:此字段可能返回 null,表示取不到有效值。 示例值:CVM |
RuleGroupExecResult
规则组执行结果
被如下接口引用:CommitRuleGroupTask, DescribeRuleGroupExecResultsByPage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleGroupExecId | Integer | 否 | 规则组执行ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
RuleGroupId | Integer | 否 | 规则组ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TriggerType | Integer | 否 | 执行触发类型(1:手动触发, 2:调度事中触发,3:周期调度触发) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ExecTime | String | 否 | 执行时间 yyyy-MM-dd HH:mm:ss 注意:此字段可能返回 null,表示取不到有效值。 示例值:yyyy-MM-dd HH:mm:ss |
Status | Integer | 否 | 执行状态(1.已提交 2.检测中 3.正常 4.异常) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AlarmRuleCount | Integer | 否 | 异常规则数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
TotalRuleCount | Integer | 否 | 总规则数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
TableOwnerName | String | 否 | 源表负责人 注意:此字段可能返回 null,表示取不到有效值。 示例值:park |
TableName | String | 否 | 源表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:person |
TableId | String | 否 | 表id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
DatabaseId | String | 否 | 数据库id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
DatasourceId | String | 否 | 数据源ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
Permission | Boolean | 否 | 有无权限 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
ExecDetail | String | 否 | 执行详情,调度计划或者关联生产任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:调度计划 |
EngineType | String | 否 | 实际执行引擎 注意:此字段可能返回 null,表示取不到有效值。 |
RuleExecResultVOList | Array of RuleExecResult | 否 | 规则执行结果 注意:此字段可能返回 null,表示取不到有效值。 |
DatabaseName | String | 否 | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:testA |
RuleGroupTableId | String | 否 | 本地规则表id 注意:此字段可能返回 null,表示取不到有效值。 示例值:11 |
ClusterDeployType | String | 否 | 集群部署类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:CVM |
InstanceId | String | 否 | 实例id 注意:此字段可能返回 null,表示取不到有效值。 示例值:12346u |
DsEnvType | String | 否 | 数据库所属环境,0.未定义,1.生产 2.开发 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ProjectId | String | 否 | 项目id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
ProjectName | String | 否 | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:项目1 |
InstanceStatus | String | 否 | 实例状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:INITIAL |
StartTime | String | 否 | 实例运行的开始时间 示例值:yyyy-MM-dd HH:mm:ss |
FinishTime | String | 否 | 实例运行的结束时间 示例值:yyyy-MM-dd HH:mm:ss |
RuleGroupExecResultPage
规则组执行结果分页
被如下接口引用:DescribeRuleGroupExecResultsByPage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TotalCount | Integer | 否 | 记录数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Items | Array of RuleGroupExecResult | 否 | 规则组执行结果 注意:此字段可能返回 null,表示取不到有效值。 |
RuleGroupExecStrategy
质量规则执行策略
被如下接口引用:CreateRule, DescribeExecStrategy, DescribeRule, DescribeRuleGroup, DescribeRules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleGroupId | Integer | 否 | 规则组Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
MonitorType | Integer | 否 | 监控类型 1.未配置, 2.关联生产调度, 3.离线周期检测 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ExecQueue | String | 否 | 计算队列 注意:此字段可能返回 null,表示取不到有效值。 示例值:Default |
ExecutorGroupId | String | 否 | 执行资源组ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
ExecutorGroupName | String | 否 | 执行资源组名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:group1 |
Tasks | Array of ProdSchedulerTask | 否 | 关联的生产调度任务列表 注意:此字段可能返回 null,表示取不到有效值。 |
StartTime | String | 否 | 周期开始时间 注意:此字段可能返回 null,表示取不到有效值。 |
EndTime | String | 否 | 周期结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
CycleType | String | 否 | 调度周期类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:H |
DelayTime | Integer | 否 | 延迟调度时间 注意:此字段可能返回 null,表示取不到有效值。 |
CycleStep | Integer | 否 | 间隔 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TaskAction | String | 否 | 时间指定 注意:此字段可能返回 null,表示取不到有效值。 |
ExecEngineType | String | 否 | 运行的执行引擎,不传时会请求该数据源下默认的执行引擎 注意:此字段可能返回 null,表示取不到有效值。 示例值:HIVE |
ExecPlan | String | 否 | 执行计划 注意:此字段可能返回 null,表示取不到有效值。 |
RuleId | Integer | 否 | 规则id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
RuleName | String | 否 | 规则名称 注意:此字段可能返回 null,表示取不到有效值。 |
TriggerTypes | Array of String | 否 | 触发类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:["CYCLE"] |
DlcGroupName | String | 否 | DLC资源组 注意:此字段可能返回 null,表示取不到有效值。 示例值:dlc_group |
RuleGroupPage
规则组分页
被如下接口引用:DescribeRuleGroupsByPage。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录数 注意:此字段可能返回 null,表示取不到有效值。 示例值:50 |
Items | Array of RuleGroup | 规则组列表 注意:此字段可能返回 null,表示取不到有效值。 |
RuleGroupSchedulerInfo
规则组调度信息
被如下接口引用:DescribeRuleGroupTable。
名称 | 类型 | 描述 |
---|---|---|
Id | Integer | 规则组ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
MonitorType | Integer | 1:未配置 2:关联生产调度 3:离线周期检测 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
StartTime | String | 开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
EndTime | String | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CycleType | String | 循环类型简写 注意:此字段可能返回 null,表示取不到有效值。 示例值:H |
CycleStep | Integer | 循环步长 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CycleDesc | String | 循环类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:DAY_CYCLE |
TaskAction | String | 离线周期检测下指定时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DelayTime | Integer | 离线周期检测下延迟时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CycleTaskId | String | 离线周期检测下注册到任务调度的任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AssociateTaskIds | Array of String | 关联生产调度下关联的任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RuleGroupSubscribe
数据质量规则组订阅信息
被如下接口引用:CreateRule, DescribeRule, DescribeRuleGroup, DescribeRuleGroupSubscription, DescribeRuleGroupTable, DescribeRules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RuleGroupId | Integer | 否 | 规则组Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
Receivers | Array of SubscribeReceiver | 否 | 订阅接收人列表 注意:此字段可能返回 null,表示取不到有效值。 |
SubscribeType | Array of Integer | 否 | 订阅方式 1.邮件email 2.短信sms 注意:此字段可能返回 null,表示取不到有效值。 示例值:[1,2] |
WebHooks | Array of SubscribeWebHook | 否 | 群机器人配置的webhook信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{"hookType":"feishu","hookAddress":"http://xxxxxxxx"}] |
RuleId | Integer | 否 | 规则Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
RuleName | String | 否 | 规则名称 注意:此字段可能返回 null,表示取不到有效值。 |
RuleGroupTable
表绑定规则组信息
被如下接口引用:DescribeRuleGroupTable。
名称 | 类型 | 描述 |
---|---|---|
TableInfo | RuleGroupTableInnerInfo | 表信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RuleGroups | Array of RuleGroupSchedulerInfo | 规则组调度信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Subscriptions | Array of RuleGroupSubscribe | 订阅者信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RuleGroupTableInnerInfo
规则组关联表信息
被如下接口引用:DescribeRuleGroupTable。
名称 | 类型 | 描述 |
---|---|---|
TableId | String | 表ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TableName | String | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
InstanceId | String | 实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatasourceId | String | 数据源ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatasourceName | String | 数据源名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatasourceType | Integer | 数据源类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatabaseId | String | 数据库ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatabaseName | String | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ProjectId | Integer | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:项目ID |
UserId | Integer | 责任人ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RulePage
数据质量规则分页
被如下接口引用:DescribeRulesByPage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TotalCount | Integer | 否 | 记录数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Items | Array of Rule | 否 | 规则列表 注意:此字段可能返回 null,表示取不到有效值。 |
RuleTemplate
规则模版
被如下接口引用:DescribeRuleTemplate, DescribeRuleTemplates, DescribeRuleTemplatesByPage。
名称 | 类型 | 描述 |
---|---|---|
RuleTemplateId | Integer | 规则模版ID 示例值:1 |
Name | String | 规则模版名称 示例值:表行数 |
Description | String | 规则模版描述 示例值:计算表的行数 |
Type | Integer | 模版类型(1:系统模版,2:自定义) 示例值:1 |
SourceObjectType | Integer | 规则适用的源数据对象类型(1:常量,2:离线表级,3:离线字段级别) 示例值:2 |
SourceObjectDataType | Integer | 规则适用的源数据对象类型(1:数值,2:字符串) 示例值:1 |
SourceContent | String | 规则模版源侧内容,区分引擎,JSON 结构 注意:此字段可能返回 null,表示取不到有效值。 示例值:{} |
SourceEngineTypes | Array of Integer | 源数据适用类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
QualityDim | Integer | 规则所属质量维度(1:准确性,2:唯一性,3:完整性,4:一致性,5:及时性,6:有效性) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CompareType | Integer | 规则支持的比较方式类型(1:固定值比较,大于、小于,大于等于等 2:波动值比较,绝对值、上升、下降) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CitationCount | Integer | 引用次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
UserId | Integer | 创建人id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
UserName | String | 创建人昵称 注意:此字段可能返回 null,表示取不到有效值。 示例值:wedata |
UpdateTime | String | 更新时间yyyy-MM-dd HH:mm:ss 注意:此字段可能返回 null,表示取不到有效值。 示例值:yyyy-MM-dd HH:mm:ss |
WhereFlag | Boolean | 是否添加where参数 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
MultiSourceFlag | Boolean | 是否关联多个库表 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
SqlExpression | String | 自定义模板SQL表达式 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
SubQualityDim | Integer | 模版子维度,0.父维度类型,1.一致性: 枚举范围一致性,2.一致性:数值范围一致性,3.一致性:字段数据相关性 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ResolvedSqlExpression | SqlExpression | sql表达式解析对象 注意:此字段可能返回 null,表示取不到有效值。 |
DatasourceTypes | Array of Integer | 支持的数据源类型 注意:此字段可能返回 null,表示取不到有效值。 |
UserIdStr | String | 创建人IdStr 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2345678" |
RuleTemplatePage
RuleTemplatePage 结果
被如下接口引用:DescribeRuleTemplatesByPage。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录数 示例值:10 |
Items | Array of RuleTemplate | 模版列表 |
RuntimeInstanceCntTop
指定时间窗口实例耗时排行
被如下接口引用:DescribeSchedulerRunTimeInstanceCntByStatus。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TaskName | String | 1 注意:此字段可能返回 null,表示取不到有效值。 |
InCharge | String | 责任人 注意:此字段可能返回 null,表示取不到有效值。 |
CycleUnit | String | 任务周期类型 注意:此字段可能返回 null,表示取不到有效值。 |
State | String | 实例状态 注意:此字段可能返回 null,表示取不到有效值。 |
RunTime | Integer | 耗时 注意:此字段可能返回 null,表示取不到有效值。 |
CurRunTime | String | 实例运行时间 注意:此字段可能返回 null,表示取不到有效值。 |
WaitScheduleTime | Integer | 等待调度耗时 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectName | String | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 |
SchedulerTaskInstanceInfo
集成离线任务实例信息
被如下接口引用:BatchForceSuccessIntegrationTaskInstances, BatchKillIntegrationTaskInstances, BatchRerunIntegrationTaskInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 是 | 任务id 示例值:"20220506145218687" |
CurRunDate | String | 是 | 实例运行时间 示例值:"2022-04-12 17:00:15" |
SchemaDetail
元数据字段信息
被如下接口引用:DescribeTableSchemaInfo。
名称 | 类型 | 描述 |
---|---|---|
ColumnKey | String | 列 注意:此字段可能返回 null,表示取不到有效值。 示例值:"ColumnKey" |
Description | String | 描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:"Description" |
Name | String | 名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"Name" |
Type | String | 类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:"Mysql" |
ScreenInstanceInfo
实例统计信息展示
被如下接口引用:DescribeSchedulerInstanceStatus。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CountTag | Integer | 否 | 统计标示 0:全部、1:当前天、2:昨天 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TotalNum | Integer | 否 | 总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
RunningNum | Integer | 否 | 运行中 注意:此字段可能返回 null,表示取不到有效值。 示例值:12 |
WaitRunningNum | Integer | 否 | 等待运行 注意:此字段可能返回 null,表示取不到有效值。 示例值:12 |
DependencyNum | Integer | 否 | 等待上游 注意:此字段可能返回 null,表示取不到有效值。 示例值:12 |
WaitEventNum | String | 否 | 等待事件 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
StoppingNum | Integer | 否 | 正在终止 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
SucceedNum | Integer | 否 | 成功 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
FailedNum | Integer | 否 | 失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
SkipRunningNum | Integer | 否 | 跳过运行总数 示例值:1 |
ScreenTaskInfo
运维大屏任务展示
被如下接口引用:DescribeSchedulerTaskCntByStatus。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CountTag | Integer | 否 | 统计标示 0:全部、1:当前天、2:昨天 示例值:0 |
TotalNum | Integer | 否 | 总数 注意:此字段可能返回 null,表示取不到有效值。 |
RunningNum | Integer | 否 | 运行中 注意:此字段可能返回 null,表示取不到有效值。 |
StoppingNum | Integer | 否 | 停止中 注意:此字段可能返回 null,表示取不到有效值。 |
StoppedNum | Integer | 否 | 已停止 注意:此字段可能返回 null,表示取不到有效值。 |
FrozenNum | Integer | 否 | 暂停 注意:此字段可能返回 null,表示取不到有效值。 |
InvalidNum | Integer | 否 | 无效任务数 注意:此字段可能返回 null,表示取不到有效值。 |
YearNum | Integer | 否 | 年任务 注意:此字段可能返回 null,表示取不到有效值。 |
MonthNum | Integer | 否 | 月任务 注意:此字段可能返回 null,表示取不到有效值。 |
WeekNum | Integer | 否 | 周任务 注意:此字段可能返回 null,表示取不到有效值。 |
DayNum | Integer | 否 | 天任务 注意:此字段可能返回 null,表示取不到有效值。 |
HourNum | Integer | 否 | 小时任务 注意:此字段可能返回 null,表示取不到有效值。 |
MinuteNum | Integer | 否 | 分钟任务 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptInfoResponse
开发空间-脚本相关响应
被如下接口引用:UploadContent。
名称 | 类型 | 描述 |
---|---|---|
ResourceId | String | 资源id 注意:此字段可能返回 null,表示取不到有效值。 |
FileName | String | 脚本名称 注意:此字段可能返回 null,表示取不到有效值。 |
FileExtensionType | String | 文件扩展名类型 注意:此字段可能返回 null,表示取不到有效值。 |
Type | String | 文件类型 注意:此字段可能返回 null,表示取不到有效值。 |
Md5Value | String | md5值 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
Size | Float | 文件大小 注意:此字段可能返回 null,表示取不到有效值。 |
LocalPath | String | 本地路径 注意:此字段可能返回 null,表示取不到有效值。 |
RemotePath | String | 远程路径 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerName | String | 用户名称 注意:此字段可能返回 null,表示取不到有效值。 |
Owner | String | 用户id 注意:此字段可能返回 null,表示取不到有效值。 |
PathDepth | Integer | 路径深度 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 项目id 注意:此字段可能返回 null,表示取不到有效值。 |
ExtraInfo | String | 附加信息 注意:此字段可能返回 null,表示取不到有效值。 |
LocalTempPath | String | 本地临时文件路径 注意:此字段可能返回 null,表示取不到有效值。 |
ZipPath | String | 本地压缩文件路径 注意:此字段可能返回 null,表示取不到有效值。 |
Bucket | String | cos桶名 注意:此字段可能返回 null,表示取不到有效值。 |
Region | String | cos地区 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptRequestInfo
开发空间-上传脚本请求
被如下接口引用:UploadContent。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
FilePath | String | 否 | 脚本路径 项目区1470575647377821696项目,f1目录下: /datastudio/project/1470575647377821696/f1/sql1234.sql 个人区: /datastudio/personal/sqlTTT.sql 示例值:/datastudio/personal/sqlTTT.sql |
ProjectId | String | 否 | 项目id |
Version | String | 否 | 脚本版本 |
Operation | String | 否 | 操作类型 |
ExtraInfo | String | 否 | 额外信息 |
BucketName | String | 否 | 桶名称 |
Region | String | 否 | 所属地区 |
FileExtensionType | String | 否 | 文件扩展类型 |
SearchColumnDocVO
表字段信息
被如下接口引用:DescribeTableMeta, DescribeTableMetas。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 字段名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:table1 |
ChineseName | String | 字段中文名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:表1 |
Type | String | 字段类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:int |
Length | Integer | 字段类型长度 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
Precision | Integer | 字段类型精度 注意:此字段可能返回 null,表示取不到有效值。 |
Scale | Integer | 字段类型scale 注意:此字段可能返回 null,表示取不到有效值。 |
DefaultValue | String | 字段默认值 注意:此字段可能返回 null,表示取不到有效值。 |
Description | String | 字段描述 注意:此字段可能返回 null,表示取不到有效值。 |
Position | Integer | 字段的顺序 注意:此字段可能返回 null,表示取不到有效值。 |
IsPartition | Boolean | 是否为分区字段 注意:此字段可能返回 null,表示取不到有效值。 |
ColumnKey | String | 列上的索引类型 主键: PRI,唯一索引: UNI,一般索引: MUL 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
ModifiedTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
SearchCondition
查询实例条件
被如下接口引用:GetOfflineInstanceList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Instance | SearchConditionInstanceNew | 是 | 查询框架,必选 |
Keyword | String | 否 | 查询关键字(任务Id精确匹配,任务名称模糊匹配),可选 |
Sort | String | 否 | 排序顺序(asc,desc) |
SortCol | String | 否 | 排序列(costTime 运行耗时,startTime 开始时间,state 实例状态,curRunDate 数据时间) |
SearchConditionInstanceNew
搜索条件
被如下接口引用:GetOfflineDIInstanceList, GetOfflineInstanceList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ExecutionSpace | String | 是 | 执行空间,可选 "DRY_RUN" 示例值:DRY_RUN |
ProductName | String | 否 | 业务产品,可选: <data_dev data_quality="" data_integration,默认data_dev。非空。默认="" 自身项目<br="">示例值:DATA_INTEGRATION |
ResourceGroup | String | 否 | 资源组信息,可选 示例值:20220228110048059 |
SearchConditionNew
查询实例条件(新)
被如下接口引用:GetOfflineDIInstanceList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Instance | SearchConditionInstanceNew | 是 | 查询框架,必选 |
Keyword | String | 否 | 查询关键字(任务Id精确匹配,任务名称模糊匹配),可选 示例值:"keyword" |
Sort | String | 否 | 排序顺序(asc,desc) 示例值:"asc" |
SortCol | String | 否 | 排序列(costTime 运行耗时,startTime 开始时间,state 实例状态,curRunDate 数据时间) 示例值:"costTime" |
SimpleColumnInfo
血缘列描述
被如下接口引用:DescribeColumnLineage。
名称 | 类型 | 描述 |
---|---|---|
Id | String | 列ID 注意:此字段可能返回 null,表示取不到有效值。 |
QualifiedName | String | 限定名 注意:此字段可能返回 null,表示取不到有效值。 |
ColumnName | String | 列名 注意:此字段可能返回 null,表示取不到有效值。 |
ColumnNameCn | String | 列中文名 注意:此字段可能返回 null,表示取不到有效值。 |
ColumnType | String | 列类型 注意:此字段可能返回 null,表示取不到有效值。 |
Description | String | 列描述 注意:此字段可能返回 null,表示取不到有效值。 |
PrefixPath | String | 前缀路径 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
ModifyTime | String | 修改时间 注意:此字段可能返回 null,表示取不到有效值。 |
DatasourceId | String | 数据源ID 注意:此字段可能返回 null,表示取不到有效值。 |
DownStreamCount | Integer | 下游数量 注意:此字段可能返回 null,表示取不到有效值。 |
UpStreamCount | Integer | 上游数量 注意:此字段可能返回 null,表示取不到有效值。 |
RelationParams | String | 关系参数 注意:此字段可能返回 null,表示取不到有效值。 |
Params | String | 参数 注意:此字段可能返回 null,表示取不到有效值。 |
Tasks | Array of String | 任务集合 注意:此字段可能返回 null,表示取不到有效值。 |
SimpleTaskInfo
简单Task信息
被如下接口引用:FreezeOpsTasks。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 是 | 任务ID |
TaskName | String | 是 | 任务名 |
SourceFieldInfo
上游节点字段信息
被如下接口引用:GenHiveTableDDLSql。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
FieldName | String | 否 | 字段名称 示例值:123 |
FieldType | String | 否 | 字段类型 示例值:int |
Alias | String | 否 | 字段别名 示例值:123 |
Comment | String | 否 | 字段描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:aa |
SpeedValue
速度值对象
被如下接口引用:DescribeRealTimeTaskSpeed。
名称 | 类型 | 描述 |
---|---|---|
Time | Integer | 带毫秒的时间戳 注意:此字段可能返回 null,表示取不到有效值。 示例值:1712910802000 |
Speed | Float | 无 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
SqlExpression
数据质量自定义规则时的sql表达式解析对象
被如下接口引用:DescribeRuleTemplate, DescribeRuleTemplates。
名称 | 类型 | 描述 |
---|---|---|
TableExpressions | Array of SqlExpressionTable | sql表达式表名 注意:此字段可能返回 null,表示取不到有效值。 |
ParamExpressions | Array of String | sql表达式字段名 注意:此字段可能返回 null,表示取不到有效值。 示例值:param_1 |
SqlExpressionTable
数据质量自定义规则时的sql表达式解析表对象
被如下接口引用:DescribeRuleTemplate, DescribeRuleTemplates。
名称 | 类型 | 描述 |
---|---|---|
TableExpression | String | sql表达式表名 注意:此字段可能返回 null,表示取不到有效值。 示例值:table_1 |
ColumnExpression | Array of String | sql表达式字段名 注意:此字段可能返回 null,表示取不到有效值。 示例值:column_1 |
StageCloudApiRequest
无
被如下接口引用:SubmitTaskTestRun。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ClusterId | String | 否 | 无 |
StageId | String | 否 | 无 |
JobId | String | 否 | 无 |
StageName | String | 否 | 无 |
Type | String | 否 | 无 |
Mode | String | 否 | 无 |
Version | String | 否 | 无 |
Queue | String | 否 | 无 |
Content | String | 否 | 无 |
Parameters | Array of Property | 否 | 无 |
Description | String | 否 | 无 |
ProjectId | String | 否 | 无 |
JobType | String | 否 | 无 |
WorkFlowId | String | 否 | 无 |
StartTaskInfo
批量运行集成任务配置
被如下接口引用:BatchStartIntegrationTasks。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Event | String | 否 | 批量运行任务类型,比如START,TIMESTAMP,RESTORE,RESUME等 注意:此字段可能返回 null,表示取不到有效值。 示例值:START |
TaskIds | Array of String | 否 | 任务Id列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:["20220506145218687"] |
Config | Array of RecordField | 否 | 批量运行任务配置,目前仅用与实时集成基于时间位点启动。基于时间位点启动,需要设置一个name=timestamp, value=具体时间戳的RecordField的配置 注意:此字段可能返回 null,表示取不到有效值。 |
Description | String | 否 | 操作类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:"test descript"" |
StrToStrMap
map
被如下接口引用:CreateOpsMakePlan, DescribeOpsMakePlans。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
K | String | 否 | k 注意:此字段可能返回 null,表示取不到有效值。 |
V | String | 否 | v 注意:此字段可能返回 null,表示取不到有效值。 |
SubmitWorkflow
提交工作流实体
被如下接口引用:SubmitWorkflow。
名称 | 类型 | 描述 |
---|---|---|
TaskIds | Array of String | 被提交的任务id集合 注意:此字段可能返回 null,表示取不到有效值。 |
Result | Boolean | 执行结果 |
ErrorDesc | String | 执行情况备注 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorId | String | 执行情况id 注意:此字段可能返回 null,表示取不到有效值。 |
SubscribeReceiver
订阅接收人
被如下接口引用:CreateRule, DescribeRule, DescribeRuleGroupSubscription, DescribeRules, ModifyRuleGroupSubscription。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ReceiverUserId | Integer | 否 | 接收人Uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
ReceiverName | String | 否 | 接收人名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:park |
ReceiverUserIdStr | String | 否 | 接收人Uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:"345678764567" |
SubscribeWebHook
群机器人订阅配置
被如下接口引用:CreateRule, DescribeRule, DescribeRuleGroupSubscription, DescribeRules, ModifyRuleGroupSubscription。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
HookType | String | 否 | 群机器人类型,当前支持飞书 注意:此字段可能返回 null,表示取不到有效值。 示例值:feishu |
HookAddress | String | 否 | 群机器人webhook地址,配置方式参考https://cloud.tencent.com/document/product/1254/70736 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://open.feishu.cn/open-apis/bot/v2/hook/11111111 |
SystemRole
角色对象
被如下接口引用:DescribeProjectUsers。
名称 | 类型 | 描述 |
---|---|---|
RoleId | String | 角色id 示例值:1 |
Name | String | 角色名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Name |
NameCn | String | 角色昵称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Name |
Description | String | 描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:描述 |
Privileges | Array of RolePrivilege | 角色权限 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
MethodPaths | Array of String | 方法路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
RoleType | String | 角色类型, 分为System,Tenant,Project,Commercial 注意:此字段可能返回 null,表示取不到有效值。 |
SystemInit | Boolean | 是否系统默认 注意:此字段可能返回 null,表示取不到有效值。 |
Params | String | 自定义参数 注意:此字段可能返回 null,表示取不到有效值。 |
Table
Table
被如下接口引用:DiagnosePro。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Column | Array of ColumnItem | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Data | Array of ColumnData | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TableBaseInfo
建dlc表所需信息
被如下接口引用:GenHiveTableDDLSql。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DatabaseName | String | 否 | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:aa |
TableName | String | 否 | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:bb |
DatasourceConnectionName | String | 否 | 数据表所属数据源名字 注意:此字段可能返回 null,表示取不到有效值。 示例值:cc |
TableComment | String | 否 | 表备注 注意:此字段可能返回 null,表示取不到有效值。 示例值:aa |
Type | String | 否 | 类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:aa |
TableFormat | String | 否 | 数据格式类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:iceberg |
UserAlias | String | 否 | 用户昵称 注意:此字段可能返回 null,表示取不到有效值。 示例值:aa |
UserSubUin | String | 否 | 建表用户ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:aaa |
GovernPolicy | DlcDataGovernPolicy | 否 | 数据治理配置项 注意:此字段可能返回 null,表示取不到有效值。 |
DbGovernPolicyIsDisable | String | 否 | 库数据治理是否关闭,关闭:true,开启:false 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
TableBasicInfo
表的元数据信息
被如下接口引用:DescribeTableBasicInfo。
名称 | 类型 | 描述 |
---|---|---|
TableId | String | 表的全局唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:12345 |
DatasourceId | String | 数据源全局唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:111 |
DatasourceName | String | 数据源名 注意:此字段可能返回 null,表示取不到有效值。 示例值:emr-xx.default |
DatabaseId | String | 数据库ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DatabaseName | String | 数据库名 注意:此字段可能返回 null,表示取不到有效值。 示例值:Default |
TableName | String | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:student |
EngineType | String | 引擎/存储类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:hive/mysql/doris/hbase/kafka/squirrel/es |
TableType | String | 表类型,视图,外部表等 注意:此字段可能返回 null,表示取不到有效值。 示例值:MANAGED_TABLE、EXTERNAL_TABLE、VIRTUAL_VIEW、ALIAS_TABLE |
ProjectId | String | 项目Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
ProjectName | String | 所属项目英文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:school |
ProjectDisplayName | String | 所属项目英中文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:学校 |
TableOwnerId | String | 责任人ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
TableOwnerName | String | 责任人名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:zhang |
StorageLocation | Integer | 存储位置 注意:此字段可能返回 null,表示取不到有效值。 示例值:hdfs |
Description | String | 表描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:这是学生信息表 |
IsPartitionTable | Integer | 是否分区表,0-全量表 1-分区表 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
PartitionColumns | Array of String | 分区字段list 注意:此字段可能返回 null,表示取不到有效值。 示例值:[a,b,c] |
StorageFormat | String | 存储格式 注意:此字段可能返回 null,表示取不到有效值。 示例值:text |
StorageSize | Integer | 存储量,字节数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10241 |
StorageSizeWithUnit | String | 存储量,单位 注意:此字段可能返回 null,表示取不到有效值。 示例值:bytes |
TotalSizeMb | Integer | 累计存储【MB】 注意:此字段可能返回 null,表示取不到有效值。 示例值:mb |
ReplicaCount | Integer | 副本数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
FileCount | Integer | 文件数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PartitionCount | Integer | 分区总数(包含hive,iceberg) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PartitionFieldCount | Integer | 分区字段数量(包含hive,iceberg) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PartitionExpireDays | Integer | 生命周期-分区保留天数【分区保留策略时有效】 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01'T'00:00:00+0800 |
UpdateTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01'T'00:00:00+0800 |
Location | String | 存储位置 注意:此字段可能返回 null,表示取不到有效值。 |
TableConfig
规则表变量替换
被如下接口引用:CreateRule, DescribeRule, DescribeRules, ModifyRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DatabaseId | String | 否 | 数据库Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
DatabaseName | String | 否 | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TableId | String | 否 | 表Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TableName | String | 否 | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
TableKey | String | 否 | 表Key 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
FieldConfig | Array of FieldConfig | 否 | 字段变量 注意:此字段可能返回 null,表示取不到有效值。 |
TableHeat
过去七天(不算当天)表的热度值
被如下接口引用:DescribeTableMeta, DescribeTableMetas。
名称 | 类型 | 描述 |
---|---|---|
TableId | String | 表ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:12345 |
DayTime | Timestamp ISO8601 | 统计日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:2004-05-03T17:30:08+08:00 |
Heat | Float | 表热度 注意:此字段可能返回 null,表示取不到有效值。 示例值:222.0 |
MaxHeat | Float | 表热度最大值 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000.0 |
TableInfo
元数据表详细信息
被如下接口引用:DescribeTableInfoList。
名称 | 类型 | 描述 |
---|---|---|
TableId | String | 表Id 注意:此字段可能返回 null,表示取不到有效值。 |
TableName | String | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test name |
TableType | String | 表类型,view/table 注意:此字段可能返回 null,表示取不到有效值。 示例值:数据表类型 |
OriginDatabaseName | String | 表databaseName 注意:此字段可能返回 null,表示取不到有效值。 示例值:database test name |
OriginSchemaName | String | 表schemaName 注意:此字段可能返回 null,表示取不到有效值。 示例值:schema test name |
TableLineageBaseInfo
表血缘详细信息
被如下接口引用:DescribeTableLineageInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
MetastoreType | String | 是 | 元数据类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:HIVE |
PrefixPath | String | 是 | 由中心节点到该节点的路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:a,b,c |
ProjectId | String | 否 | 空间id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
DatasourceId | String | 否 | 数据源id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
TableId | String | 否 | 表id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
Params | Array of LineageParamRecord | 否 | 表血缘参数 注意:此字段可能返回 null,表示取不到有效值。 |
ParentSet | String | 否 | 父节点列表 注意:此字段可能返回 null,表示取不到有效值。 |
ChildSet | String | 否 | 子节点列表 注意:此字段可能返回 null,表示取不到有效值。 |
ExtParams | Array of RecordField | 否 | 额外参数 注意:此字段可能返回 null,表示取不到有效值。 |
Id | String | 否 | 血缘id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
MetastoreTypeName | String | 否 | 元数据类型名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Hive |
TableName | String | 否 | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc123 |
QualifiedName | String | 否 | 表全称 注意:此字段可能返回 null,表示取不到有效值。 示例值:a.abc123 |
DownStreamCount | Integer | 否 | 血缘下游节点数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
UpStreamCount | Integer | 否 | 血缘上游节点数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Description | String | 否 | 血缘描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
CreateTime | String | 否 | 血缘创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01 00:00:00 |
ModifyTime | String | 否 | 血缘更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01 00:00:00 |
Tasks | Array of String | 否 | 修改血缘的任务id列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
TableLineageInfo
表血缘详细信息
被如下接口引用:DescribeTableLineage, DescribeTableLineageInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
MetastoreType | String | 是 | 元数据类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:HIVE |
ProjectId | String | 否 | 空间id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
DatasourceId | String | 否 | 数据源id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
TableId | String | 否 | 表id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
Params | Array of LineageParamRecord | 否 | 表血缘参数 注意:此字段可能返回 null,表示取不到有效值。 |
ParentSet | String | 否 | 父节点列表 注意:此字段可能返回 null,表示取不到有效值。 |
ChildSet | String | 否 | 子节点列表 注意:此字段可能返回 null,表示取不到有效值。 |
ExtParams | Array of RecordField | 否 | 额外参数 注意:此字段可能返回 null,表示取不到有效值。 |
Id | String | 否 | 血缘id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
MetastoreTypeName | String | 否 | 元数据类型名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Hive |
TableName | String | 否 | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc123 |
QualifiedName | String | 否 | 表全称 注意:此字段可能返回 null,表示取不到有效值。 示例值:a.abc123 |
DownStreamCount | Integer | 否 | 血缘下游节点数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
UpStreamCount | Integer | 否 | 血缘上游节点数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Description | String | 否 | 血缘描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
PrefixPath | String | 否 | 由中心节点到该节点的路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:a,b,c |
CreateTime | String | 否 | 血缘创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01 00:00:00 |
ModifyTime | String | 否 | 血缘更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01 00:00:00 |
Tasks | Array of String | 否 | 修改血缘的任务id列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
ChannelType | String | 否 | 模块/应用类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:DATASERVICE |
DisplayType | String | 否 | 展示类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:TDSQL-PostgreSQL |
EngineType | String | 否 | 表类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:VIEW |
TableType | String | 否 | 表类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:VIEW |
DatasourceName | String | 否 | datasourceName 注意:此字段可能返回 null,表示取不到有效值。 示例值:datasourceName |
DatabaseName | String | 否 | DatabaseName 注意:此字段可能返回 null,表示取不到有效值。 示例值:DatabaseName |
DatabaseId | String | 否 | DatabaseId 注意:此字段可能返回 null,表示取不到有效值。 示例值:DatabaseId |
TableMeta
表的元数据信息
被如下接口引用:DescribeTableMeta, DescribeTableMetas。
名称 | 类型 | 描述 |
---|---|---|
TableId | String | 表的全局唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:3sURDHOlTaSQyx7lfuILJg |
TableName | String | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:student |
TableOwnerName | String | 责任人 注意:此字段可能返回 null,表示取不到有效值。 示例值:zh |
DatasourceId | Integer | 数据源全局唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:9263 |
ClusterName | String | 所属集群名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:23 |
DatasourceName | String | 数据源名 注意:此字段可能返回 null,表示取不到有效值。 示例值:emr-xx.default |
DatabaseName | String | 数据库名 注意:此字段可能返回 null,表示取不到有效值。 示例值:Default |
TablePath | String | 表路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:hdfs://xxx |
TableNameCn | String | 表中文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:学生表 |
MetastoreId | Integer | 元数据租户ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:integer(int64) |
MetastoreType | String | 技术类型,可用值:HIVE,MYSQL,KAFKA, HBASE 注意:此字段可能返回 null,表示取不到有效值。 示例值:HIVE |
Description | String | 表描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:这是学生信息表 |
ColumnSeparator | String | 列分隔符 注意:此字段可能返回 null,表示取不到有效值。 示例值:, |
StorageFormat | String | 存储格式 注意:此字段可能返回 null,表示取不到有效值。 示例值:text |
StorageSize | Integer | 存储量,字节数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10241 |
TableType | String | 表类型,如hive MANAGED_TABLE;EXTERNAL_TABLE 注意:此字段可能返回 null,表示取不到有效值。 示例值:MANAGED_TABLE |
CreateTime | Timestamp ISO8601 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01'T'00:00:00+0800 |
ModifyTime | Timestamp ISO8601 | 最近数据变更时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01'T'00:00:00+0800 |
DdlModifyTime | Timestamp ISO8601 | 最近DDL变更时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01'T'00:00:00+0800 |
LastAccessTime | Timestamp ISO8601 | 数据最后访问时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01'T'00:00:00+0800 |
ProjectName | String | 所属项目英文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:school |
BizCatalogIds | Array of String | 所属数据目录id(可能多个) 注意:此字段可能返回 null,表示取不到有效值。 示例值:["1","2"] |
BizCatalogNames | Array of String | 所属数据目录(可能多个) 注意:此字段可能返回 null,表示取不到有效值。 示例值:["支付","金融"] |
HasFavorite | Boolean | true已收藏/false表示未收藏状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
LifeCycleTime | Integer | 生命周期 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
StorageSizeWithUnit | String | 存储量,已转为适合的单位展示 注意:此字段可能返回 null,表示取不到有效值。 示例值:9.13TB |
InstanceId | String | 数据源引擎的实例ID:如EMR集群实例ID/数据源实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1333 |
TechnologyType | String | 数据来源技术类型:HIVE/MYSQL/HBASE/KAFKA等 注意:此字段可能返回 null,表示取不到有效值。 示例值:HIVE |
TableNameEn | String | 表英文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:student |
ProjectId | String | 项目Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
Partitions | String | Kafka Topic 分区数 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
ReplicationFactor | String | Kafka Topic 副本数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
ProjectDisplayName | String | 所属项目英中文名 注意:此字段可能返回 null,表示取不到有效值。 示例值:学校 |
DataModifyTime | Timestamp ISO8601 | 数据最后修改时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-07-01'T'00:00:00+0800 |
ClusterId | String | 集群ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:tbds-hoplnvlm |
HasAdminAuthority | Boolean | 当前用户是否有管理员权限 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
DatasourceDisplayName | String | 数据源展示名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:emrziyong.default |
DatabaseId | String | 数据库ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
FavoriteCount | Integer | 租户下对表的收藏总次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:11 |
LikeCount | Integer | 租户下对表的点赞总次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
HasLike | Boolean | true已点赞/false表示未点赞状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
TablePropertyScore | TablePropertyScore | 表的资产评分 注意:此字段可能返回 null,表示取不到有效值。 |
TableHeat | TableHeat | 表的热度值 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerProjectId | String | 数据源ownerProjectId 注意:此字段可能返回 null,表示取不到有效值。 |
TableOwnerId | String | 表负责人ID 注意:此字段可能返回 null,表示取不到有效值。 |
DataSourceCategory | String | 系统源-CLUSTER, DB-自定义源 注意:此字段可能返回 null,表示取不到有效值。 |
Columns | Array of SearchColumnDocVO | 表字段信息 注意:此字段可能返回 null,表示取不到有效值。 |
MetaCrawlType | String | 表采集类型 TABLE, VIEW, MANAGED_TABLE(Hive管理表), EXTERNAL_TABLE(Hive外部表), VIRTUAL_VIEW(虚拟视图), MATERIALIZED_VIEW(物化视图), LATERAL_VIEW, INDEX_TABLE(索引表), END_SELECT(查询结构), INSTANCE(中间临时表类型(数据血缘)), CDW(CDW表类型) 注意:此字段可能返回 null,表示取不到有效值。 示例值:VIEW |
IsView | Boolean | 是否视图 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
Location | String | 存储位置 注意:此字段可能返回 null,表示取不到有效值。 |
IsPartitionTable | Integer | 判断是否是分区表1 是 0否 注意:此字段可能返回 null,表示取不到有效值。 |
PartitionColumns | Array of String | 分区字段 key 注意:此字段可能返回 null,表示取不到有效值。 |
PartitionExpireDays | Integer | 生命周期-分区保留天数【分区保留策略时有效】 注意:此字段可能返回 null,表示取不到有效值。 |
TableProperties | Array of TableMetaProperty | 表附属信息 注意:此字段可能返回 null,表示取不到有效值。 |
Environment | String | 环境,取值 prod或者 dev 注意:此字段可能返回 null,表示取不到有效值。 |
Schema | String | 数据库模式 注意:此字段可能返回 null,表示取不到有效值。 |
CollectDatasourceList | Array of GovDatasourceInfo | 关联数据眼信息 注意:此字段可能返回 null,表示取不到有效值。 |
CollectJobId | String | 采集任务id 注意:此字段可能返回 null,表示取不到有效值。 |
CollectJobName | String | 采集任务名称 注意:此字段可能返回 null,表示取不到有效值。 |
Urn | String | 数据源urn 注意:此字段可能返回 null,表示取不到有效值。 |
HasBizPermission | Boolean | 是否有修改业务权限 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerByEngine | String | 引擎侧创建人 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorTips | String | 用户无映射账户,请先完成账户映射后再来申请。 注意:此字段可能返回 null,表示取不到有效值。 |
IfSupportCreateAndDDL | CreateAndDDLSupport | 是否支持select or ddl 注意:此字段可能返回 null,表示取不到有效值。 |
TableMetaProperty
表附加信息
被如下接口引用:DescribeTableMeta, DescribeTableMetas。
名称 | 类型 | 描述 |
---|---|---|
Key | String | 属性的key 注意:此字段可能返回 null,表示取不到有效值。 |
Value | String | 属性的值 注意:此字段可能返回 null,表示取不到有效值。 |
TableNameFilter
按表名查询的查询条件
被如下接口引用:DescribeTableMeta。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
MsType | String | 否 | 数据源类型 |
DatasourceId | Integer | 否 | 数据源id |
DatabaseName | String | 否 | 数据库名称 |
SchemaName | String | 否 | schema |
Name | String | 否 | 表名 |
TablePartition
表的分区数据
被如下接口引用:DescribeTablePartitions。
名称 | 类型 | 描述 |
---|---|---|
PartitionName | String | 分区名称 示例值:dt=20220128 |
RecordCount | Integer | 分区记录数 示例值:111 |
StorageSize | String | 分区数据存储大小,字节数 示例值:10241 |
CreateTime | Timestamp ISO8601 | 分区创建时间 示例值:2020-09-22T00:00:00+00:00 |
ModifiedTime | Timestamp ISO8601 | 分区修改时间 示例值:2020-09-22T00:00:00+00:00 |
StorageSizeWithUnit | String | 分区数据存储大小,已转为适合的单位 示例值:9.13TB |
NumFiles | Integer | 文件数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AverageFileSizeWithUnit | String | 平均文件大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:1MB |
TablePropertyScore
按天更新的表的资产评分
被如下接口引用:DescribeTableMeta, DescribeTableMetas。
名称 | 类型 | 描述 |
---|---|---|
TableId | String | 表ID 示例值:12345 |
DayTime | Timestamp ISO8601 | 统计日期 示例值:2004-05-03T17:30:08+08:00 |
Integrity | Float | 表完整性评分 示例值:98.15 |
Safety | Float | 表保障性评分 示例值:98.15 |
Timeliness | Float | 表及时性评分 示例值:98.15 |
Stability | Float | 表稳定性评分 示例值:98.15 |
Normative | Float | 表规范性评分 示例值:98.15 |
Average | Float | 资产评分平均分 示例值:98.15 |
TableQualityDetail
表质量详情
被如下接口引用:DescribeTableQualityDetails。
名称 | 类型 | 描述 |
---|---|---|
DatabaseId | String | 数据库id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
DatabaseName | String | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
TableId | String | 表id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
TableName | String | 表名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
OwnerUserId | Integer | 表责任人ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1234 |
OwnerUserName | String | 表责任人名 注意:此字段可能返回 null,表示取不到有效值。 示例值:小明 |
DatabaseScore | Float | 库得分 注意:此字段可能返回 null,表示取不到有效值。 示例值:12.21 |
TableScore | Float | 表得分 注意:此字段可能返回 null,表示取不到有效值。 示例值:12.21 |
LastPeriodRatio | Float | 表环比 注意:此字段可能返回 null,表示取不到有效值。 示例值:12.1 |
DsEnvType | Integer | 0或者未返回或者null:未定义,1:生产,2:开发 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
SchemaName | String | 模式名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
RuleGroupTableId | String | 规则表 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TableQualityDetailPage
表质量分分页结果
被如下接口引用:DescribeTableQualityDetails。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
Items | Array of TableQualityDetail | 表质量列表 注意:此字段可能返回 null,表示取不到有效值。 |
TableScoreStatisticsInfo
表评分统计信息
被如下接口引用:DescribeQualityScore。
名称 | 类型 | 描述 |
---|---|---|
Level | Integer | 等级 1、2、3、4、5 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Scale | Integer | 占比 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TableNumber | Integer | 表数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TagVoteSum
基于表的标签统计信息
被如下接口引用:DescribeTableMeta。
名称 | 类型 | 描述 |
---|---|---|
TagId | Integer | 标签id 示例值:12 |
VoteSum | Integer | 该表该标签投票次数 示例值:1 |
Status | Boolean | 当前用户对这张表是否加了该标签 true 已添加 false 未添加 示例值:true |
TagName | String | 标签名 示例值:标签名 |
TaskAlarmInfo
任务告警信息
被如下接口引用:BatchCreateIntegrationTaskAlarms, CreateTaskAlarmRegular, DescribeTaskAlarmRegulations, ModifyTaskAlarmRegular。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 是 | 任务ID 示例值:3cd6b1b3-76a0-4147-8f0e-6df206bc58c0 |
RegularName | String | 是 | 规则名称 示例值:测试规则 |
RegularStatus | Integer | 是 | 规则状态(0表示关闭,1表示打开) 示例值:1 |
AlarmLevel | Integer | 是 | 告警级别(0表示普通,1表示重要,2表示紧急) 示例值:0 |
AlarmWay | String | 是 | 告警方式,多个用逗号隔开(1:邮件,2:短信,3:微信,4:语音,5:代表企业微信,6:http) 示例值:1 |
TaskType | Integer | 是 | 任务类型(201表示实时,202表示离线) 示例值:201 |
Id | String | 否 | ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1289287 |
RegularId | String | 否 | 规则ID 示例值:1769 |
AlarmIndicator | Integer | 否 | 告警指标,0表示任务失败,1表示任务运行超时,2表示任务停止,3表示任务暂停 ,4写入速度,5读取速度,6读取吞吐,7写入吞吐, 8脏数据字节数,9脏数据条数 示例值:1 |
TriggerType | Integer | 否 | 指标阈值(1表示离线任务第一次运行失败,2表示离线任务所有重试完成后失败) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
EstimatedTime | Integer | 否 | 预计的超时时间(分钟级别) 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
AlarmRecipientId | String | 否 | 告警接收人ID,多个用逗号隔开 示例值:100028448903 |
ProjectId | String | 否 | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1486446569620893696 |
Creater | String | 否 | 创建人 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028448903 |
AlarmRecipientName | String | 否 | 告警接收人昵称,多个用逗号隔开 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028448903 |
AlarmIndicatorDesc | String | 否 | 告警指标描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:任务失败 |
Operator | Integer | 否 | 实时任务告警需要的参数,1是大于2是小于 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028448903 |
NodeId | String | 否 | 节点id,多个逗号分隔 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
NodeName | String | 否 | 节点名称,多个逗号分隔 注意:此字段可能返回 null,表示取不到有效值。 示例值:toNode |
AlarmIndicatorInfos | Array of AlarmIndicatorInfo | 否 | 指标列表 注意:此字段可能返回 null,表示取不到有效值。 |
AlarmRecipientType | Integer | 否 | 告警接收人类型,0指定人员;1任务责任人 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
QuietPeriods | Array of QuietPeriod | 否 | 免打扰时间 注意:此字段可能返回 null,表示取不到有效值。 |
WeComHook | String | 否 | 企业微信群Hook地址,多个hook地址使用,隔开 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://www.feishu.cn/ |
UpdateTime | String | 否 | 最近操作时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028448903 |
OperatorUin | String | 否 | 最近操作人Uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:100028448903 |
TaskCount | Integer | 否 | 关联任务数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
MonitorType | Integer | 否 | 监控对象类型,1:所有任务,2:指定任务,3:指定责任人 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
MonitorObjectIds | Array of String | 否 | 监控对象列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
LatestAlarmInstanceId | String | 否 | 最近一次告警的实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:3047 |
LatestAlarmTime | String | 否 | 最近一次告警时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-04-11 10:49:56 |
Description | String | 否 | 告警规则描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:"test-regule" |
LarkWebHooks | String | 否 | 飞书群Hook地址,多个hook地址使用,隔开 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://www.feishu.cn/ |
DingDingWebHooks | String | 否 | 钉钉群Hook地址,多个hook地址使用,隔开 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://www.dingtalk.com/ |
BusinessType | Integer | 否 | 业务类型, 0-非默认, 1-默认 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TaskByCycle
周期单位统计
被如下接口引用:DescribeInstanceByCycle, DescribeTaskByCycle。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Number | Integer | 否 | num 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CycleUnit | String | 否 | 周期单位 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 否 | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 |
TaskByStatus
状态趋势统计
被如下接口引用:DescribeTaskByCycleReport, DescribeTaskByStatusReport。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CountGroup | String | 否 | 统计值 注意:此字段可能返回 null,表示取不到有效值。 示例值:[19, 19] |
ShowTimeGroup | String | 否 | 日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:[2023030605, 2023030606] |
Status | String | 否 | 状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:F |
CycleUnit | String | 否 | 周期单位 注意:此字段可能返回 null,表示取不到有效值。 示例值:I |
ReportTime | String | 否 | 1 |
Count | Integer | 否 | 1 |
TaskExtInfo
任务扩展信息
被如下接口引用:CreateTask, ModifyTaskInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 否 | 键 |
Value | String | 否 | 值 |
TaskImportInfo
集成任务导入到编排空间配置
被如下接口引用:CreateIntegrationTask, CreateOfflineTask, DescribeIntegrationTask, DescribeIntegrationTasks, ModifyIntegrationTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
IsImport | Boolean | 否 | 是否导入编排空间 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
IsNewWorkFlow | Boolean | 否 | 是否新建工作流 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
WorkFlowFolderId | String | 否 | 工作流所属目录id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
WorkFlowFolderName | String | 否 | 工作流所属目录名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:名称 |
WorkFlowId | String | 否 | 工作流id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
WorkFlowName | String | 否 | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:工作流名称示例 |
TaskNameExistMode | Integer | 否 | 重名任务处理策略, 0:跳过,不导入; 1: 重命名 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TaskInnerInfo
任务属性
被如下接口引用:ModifyTaskInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 是 | 任务ID |
TaskName | String | 是 | 任务名 |
WorkflowId | String | 是 | 工作流id |
CycleType | Integer | 是 | 周期类型 0:crontab类型, 1:分钟,2:小时,3:天,4:周,5:月,6:一次性,7:用户驱动,10:弹性周期 周,11:弹性周期 月,12:年,13:即时触发Instant类型,与正常周期调度任务逻辑隔离 |
VirtualTaskId | String | 否 | 虚拟任务id 注意:此字段可能返回 null,表示取不到有效值。 |
VirtualFlag | Boolean | 否 | 虚拟任务标记 注意:此字段可能返回 null,表示取不到有效值。 |
RealWorkflowId | String | 否 | 真实任务工作流id 注意:此字段可能返回 null,表示取不到有效值。 |
TaskInstanceCountDto
任务实例状态统计
被如下接口引用:CountOpsInstanceState。
名称 | 类型 | 描述 |
---|---|---|
Success | Integer | 成功的实例数 示例值:0 |
Running | Integer | 执行中实例数 示例值:0 |
Waiting | Integer | 等待中的实例数 示例值:0 |
Depend | Integer | 等待上游实例数 示例值:0 |
Failed | Integer | 失败实例数 示例值:0 |
Stopped | Integer | 永久终止实例数 示例值:0 |
TaskLineageInfo
任务集成信息
被如下接口引用:DescribeTaskLineage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 否 | 任务 ID 注意:此字段可能返回 null,表示取不到有效值。 |
TaskName | String | 否 | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 |
TableName | String | 否 | 表名称 注意:此字段可能返回 null,表示取不到有效值。 |
TableUri | String | 否 | 表 URI,格式:dsn.name 注意:此字段可能返回 null,表示取不到有效值。 |
Type | Integer | 否 | 表方向类型 - 0 - table作为源表 - 1 - table作为目标表 注意:此字段可能返回 null,表示取不到有效值。 |
DataSourceId | Integer | 否 | 数据源ID 注意:此字段可能返回 null,表示取不到有效值。 |
DataSourceType | String | 否 | 数据源类型 注意:此字段可能返回 null,表示取不到有效值。 |
DatabaseName | String | 否 | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 |
SchemaName | String | 否 | 模型名称 注意:此字段可能返回 null,表示取不到有效值。 |
TaskLineageInfoPair
任务血缘信息,包括源表和目标表
被如下接口引用:DescribeTaskLineage。
名称 | 类型 | 描述 |
---|---|---|
SourceTable | TaskLineageInfo | 表血缘-源表 注意:此字段可能返回 null,表示取不到有效值。 |
TargetTable | TaskLineageInfo | 表血缘-目标表 注意:此字段可能返回 null,表示取不到有效值。 |
TaskLockStatus
任务锁的状态
被如下接口引用:DescribeTaskLockStatus。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务id 示例值:123 |
Locker | String | 持锁者 示例值:123 |
IsLocker | Integer | 当前操作用户是否为持锁者,1表示为持锁者,0表示为不为持锁者 示例值:1 |
IsRob | Integer | 是否可以抢锁,1表示可以抢锁,0表示不可以抢锁 示例值:1 |
TaskOpsDto
任务运维详情
被如下接口引用:DescribeAllByFolderNew, DescribeDependTaskLists, DescribeEventConsumeTasks, DescribeOperateOpsTasks, DescribeOpsMakePlanTasks, DescribeSuccessorOpsTaskInfos, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TaskId | String | 是 | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 |
VirtualTaskId | String | 是 | 虚拟任务id 注意:此字段可能返回 null,表示取不到有效值。 |
VirtualFlag | Boolean | 是 | 虚拟任务标记 注意:此字段可能返回 null,表示取不到有效值。 |
TaskName | String | 是 | 任务名 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowId | String | 是 | 工作流id 注意:此字段可能返回 null,表示取不到有效值。 |
RealWorkflowId | String | 是 | 任务为虚拟任务时,任务所在的真实工作流Id 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowName | String | 是 | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 |
FolderId | String | 是 | 文件夹id 注意:此字段可能返回 null,表示取不到有效值。 |
FolderName | String | 是 | 文件夹名字 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 是 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
LastUpdate | String | 是 | 最近更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 是 | 任务状态 注意:此字段可能返回 null,表示取不到有效值。 |
InCharge | String | 是 | 责任人 注意:此字段可能返回 null,表示取不到有效值。 |
InChargeId | String | 是 | 责任人用户id 注意:此字段可能返回 null,表示取不到有效值。 |
StartTime | String | 是 | 调度生效日期 注意:此字段可能返回 null,表示取不到有效值。 |
EndTime | String | 是 | 调度结束日期 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionStartTime | String | 是 | 执行时间左闭区间 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionEndTime | String | 是 | 执行时间右闭区间 注意:此字段可能返回 null,表示取不到有效值。 |
CycleType | String | 是 | 周期类型 注意:此字段可能返回 null,表示取不到有效值。 |
CycleStep | Integer | 是 | 步长 注意:此字段可能返回 null,表示取不到有效值。 |
CrontabExpression | String | 是 | 调度cron表达式 注意:此字段可能返回 null,表示取不到有效值。 |
DelayTime | Integer | 是 | 延时执行时间,unit=分钟 注意:此字段可能返回 null,表示取不到有效值。 |
StartupTime | Integer | 是 | 开始执行时间 注意:此字段可能返回 null,表示取不到有效值。 |
RetryWait | Integer | 是 | 重试等待时间, unit=分钟 注意:此字段可能返回 null,表示取不到有效值。 |
RetryAble | Integer | 是 | 是否可重试,1 代表可以重试 注意:此字段可能返回 null,表示取不到有效值。 |
TaskAction | String | 是 | 调度配置-弹性周期配置,小时/周/月/年调度才有,小时任务指定每天的0点3点4点跑,则为'0,3,4' 注意:此字段可能返回 null,表示取不到有效值。 |
TryLimit | Integer | 是 | 运行次数限制 注意:此字段可能返回 null,表示取不到有效值。 |
RunPriority | Integer | 是 | 运行优先级 注意:此字段可能返回 null,表示取不到有效值。 |
TaskType | TaskTypeOpsDto | 是 | 任务类型 注意:此字段可能返回 null,表示取不到有效值。 |
BrokerIp | String | 是 | 指定的运行节点 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterId | String | 是 | 集群name 注意:此字段可能返回 null,表示取不到有效值。 |
MinDateTime | String | 是 | 最小数据时间 注意:此字段可能返回 null,表示取不到有效值。 |
MaxDateTime | String | 是 | 最大数据时间 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionTTL | Integer | 是 | 运行耗时超时时间 注意:此字段可能返回 null,表示取不到有效值。 |
SelfDepend | String | 是 | 自依赖类型 注意:此字段可能返回 null,表示取不到有效值。 |
LeftCoordinate | Float | 是 | 左侧坐标 注意:此字段可能返回 null,表示取不到有效值。 |
TopCoordinate | Float | 是 | 顶部坐标 注意:此字段可能返回 null,表示取不到有效值。 |
Notes | String | 是 | 任务备注 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceInitStrategy | String | 是 | 任务初始化策略 注意:此字段可能返回 null,表示取不到有效值。 |
YarnQueue | String | 是 | 计算队列 注意:此字段可能返回 null,表示取不到有效值。 |
LastSchedulerCommitTime | String | 是 | 最新调度提交时间 注意:此字段可能返回 null,表示取不到有效值。 |
NormalizedJobStartTime | String | 是 | 按cron表达式计算的任务开始执行时间 注意:此字段可能返回 null,表示取不到有效值。 |
SchedulerDesc | String | 是 | 调度计划描述 注意:此字段可能返回 null,表示取不到有效值。 |
ResourceGroup | String | 是 | 计算资源组 注意:此字段可能返回 null,表示取不到有效值。 |
Creator | String | 是 | 任务创建人 注意:此字段可能返回 null,表示取不到有效值。 |
DependencyRel | String | 是 | 任务依赖类型 and、or 注意:此字段可能返回 null,表示取不到有效值。 |
DependencyWorkflow | String | 是 | 任务工作流依赖 yes、no 注意:此字段可能返回 null,表示取不到有效值。 |
EventListenerConfig | String | 是 | 事件监听配置 注意:此字段可能返回 null,表示取不到有效值。 |
EventPublisherConfig | String | 是 | 事件驱动配置 注意:此字段可能返回 null,表示取不到有效值。 |
VirtualTaskStatus | String | 是 | 虚拟任务状态 注意:此字段可能返回 null,表示取不到有效值。 |
TaskLinkInfo | LinkOpsDto | 是 | 任务依赖边详情 注意:此字段可能返回 null,表示取不到有效值。 |
ProductName | String | 是 | 任务产品类型 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 是 | 项目id 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectIdent | String | 是 | 项目标识 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectName | String | 是 | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 |
OwnId | String | 是 | 主账户userId 注意:此字段可能返回 null,表示取不到有效值。 |
UserId | String | 是 | 用户userId 注意:此字段可能返回 null,表示取不到有效值。 |
TenantId | String | 是 | 租户id 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateUser | String | 是 | 更新人昵称 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | String | 是 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateUserId | String | 是 | 更新人userId 注意:此字段可能返回 null,表示取不到有效值。 |
TaskTypeId | Integer | 是 | 任务类型id 注意:此字段可能返回 null,表示取不到有效值。 |
TaskTypeDesc | String | 是 | 任务类型描述 注意:此字段可能返回 null,表示取不到有效值。 |
ShowWorkflow | Boolean | 是 | 是否展示工作流 注意:此字段可能返回 null,表示取不到有效值。 |
FirstSubmitTime | String | 是 | 首次提交时间 注意:此字段可能返回 null,表示取不到有效值。 |
FirstRunTime | String | 是 | 首次运行时间 注意:此字段可能返回 null,表示取不到有效值。 |
ScheduleDesc | String | 是 | 调度描述 注意:此字段可能返回 null,表示取不到有效值。 |
CycleNum | Integer | 是 | 周期 注意:此字段可能返回 null,表示取不到有效值。 |
Crontab | String | 是 | 表达式 注意:此字段可能返回 null,表示取不到有效值。 |
StartDate | String | 是 | 开始日期 注意:此字段可能返回 null,表示取不到有效值。 |
EndDate | String | 是 | 结束日期 注意:此字段可能返回 null,表示取不到有效值。 |
CycleUnit | String | 是 | 周期单位 注意:此字段可能返回 null,表示取不到有效值。 |
InitStrategy | String | 是 | 初始化策略 注意:此字段可能返回 null,表示取不到有效值。 |
Layer | String | 是 | 层级 注意:此字段可能返回 null,表示取不到有效值。 |
SourceServiceId | String | 是 | 来源数据源ID 注意:此字段可能返回 null,表示取不到有效值。 |
SourceServiceType | String | 是 | 来源数据源类型 注意:此字段可能返回 null,表示取不到有效值。 |
TargetServiceId | String | 是 | 目标数据源ID 注意:此字段可能返回 null,表示取不到有效值。 |
TargetServiceType | String | 是 | 目标数据源类型 注意:此字段可能返回 null,表示取不到有效值。 |
TasksStr | String | 是 | 子任务列表 注意:此字段可能返回 null,表示取不到有效值。 |
Submit | Boolean | 是 | 任务版本是否已提交 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutorGroupId | String | 否 | 资源组id 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutorGroupName | String | 否 | 资源组名称 注意:此字段可能返回 null,表示取不到有效值。 |
TaskExtInfo | String | 否 | 任务扩展信息(目前返沪离线同步的任务详情) 注意:此字段可能返回 null,表示取不到有效值。 |
EventListenerInfos | Array of AiOpsEventListenerDTO | 否 | 任务绑定的事件信息 注意:此字段可能返回 null,表示取不到有效值。 |
ScriptInfo | AiopsScriptInfo | 否 | 脚本信息 注意:此字段可能返回 null,表示取不到有效值。 |
DLCResourceConfig | AiopsDLCResourceConfigDto | 否 | DLC资源配置 注意:此字段可能返回 null,表示取不到有效值。 |
ParentTaskInfos | AiopsSimpleTaskDto | 否 | 父任务simple信息 注意:此字段可能返回 null,表示取不到有效值。 |
ExtResourceFlag | ExtResourceFlagDto | 否 | 资源获取标识 注意:此字段可能返回 null,表示取不到有效值。 |
NewParentTaskInfos | Array of AiopsSimpleTaskDto | 否 | 父任务simple信息(新) 注意:此字段可能返回 null,表示取不到有效值。 |
SelfWorkFlowDependType | String | 否 | 任务自依赖类型: yes: 任务需满足自依赖 no:任务无需满足自依赖 注意:此字段可能返回 null,表示取不到有效值。 |
TaskScriptContent
任务执行脚本
被如下接口引用:DescribeTaskScript。
名称 | 类型 | 描述 |
---|---|---|
ScriptContent | String | 脚本内容 base64编码 注意:此字段可能返回 null,表示取不到有效值。 |
TaskSubmitPreCheckDetailInfo
任务提交预校验详细信息
被如下接口引用:DescribePendingSubmitTaskList。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务编号 注意:此字段可能返回 null,表示取不到有效值。 示例值:1111 |
TaskName | String | 任务名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:task_p1 |
ProjectId | String | 项目编号 注意:此字段可能返回 null,表示取不到有效值。 示例值:1111 |
ProjectName | String | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:proj_test_01 |
InChargeId | String | 责任人编号 注意:此字段可能返回 null,表示取不到有效值。 示例值:1111 |
InCharge | String | 责任人名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:user_01 |
TaskTableMetricInfo
任务表粒度指标信息
被如下接口引用:DescribeTaskTableMetricOverview。
名称 | 类型 | 描述 |
---|---|---|
DatabaseName | String | 数据库名称 注意:此字段可能返回 null,表示取不到有效值。 |
TableName | String | 表名称 注意:此字段可能返回 null,表示取不到有效值。 |
TotalRecordNum | Integer | 总记录数 注意:此字段可能返回 null,表示取不到有效值。 |
TotalRecordByteNum | Integer | 总字节数 注意:此字段可能返回 null,表示取不到有效值。 |
TotalDirtyRecordNum | Integer | 总脏记录数 注意:此字段可能返回 null,表示取不到有效值。 |
SchemaName | String | Schema名称 注意:此字段可能返回 null,表示取不到有效值。 |
Topic | String | topic名称 注意:此字段可能返回 null,表示取不到有效值。 |
Collection | String | Collection名称 注意:此字段可能返回 null,表示取不到有效值。 |
DataSourceName | String | 数据源名称 示例值:测试数据源 |
NodeId | String | 节点id 示例值:1212 |
LogicDatabase | String | 逻辑库名 注意:此字段可能返回 null,表示取不到有效值。 示例值:database1 |
LogicTable | String | 逻辑表名 注意:此字段可能返回 null,表示取不到有效值。 示例值:table1 |
LogicSchema | String | 逻辑schema名 注意:此字段可能返回 null,表示取不到有效值。 |
TaskTableMetricInfos | Array of TaskTableMetricInfo | 物理表信息 注意:此字段可能返回 null,表示取不到有效值。 |
SyncStatus | Integer | 同步状态,0-未知,1-正常, 2-异常 注意:此字段可能返回 null,表示取不到有效值。 |
TargetDatabaseName | String | Target数据库名称 注意:此字段可能返回 null,表示取不到有效值。 |
TargetTableName | String | Target表名称 注意:此字段可能返回 null,表示取不到有效值。 |
WriteTotalRecordNum | Integer | Write总记录数 注意:此字段可能返回 null,表示取不到有效值。 |
WriteTotalRecordByteNum | String | Write总字节数 注意:此字段可能返回 null,表示取不到有效值。 |
TargetSchemaName | String | TargetSchema名称 注意:此字段可能返回 null,表示取不到有效值。 |
TargetTopic | String | Targettopic名称 注意:此字段可能返回 null,表示取不到有效值。 |
TargetCollection | String | TargetCollection名称 注意:此字段可能返回 null,表示取不到有效值。 |
TargetDataSourceName | String | 数据源名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:测试数据源 |
TargetNodeId | String | 节点id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1212 |
TotalRecordSpeed | Float | 读取条数的速度 注意:此字段可能返回 null,表示取不到有效值。 |
WriteTotalRecordSpeed | Float | 写入条数的速度 注意:此字段可能返回 null,表示取不到有效值。 |
ExceptionReason | String | 异常原因 注意:此字段可能返回 null,表示取不到有效值。 示例值:1,2 |
TaskTag
任务标签,可用于检索任务的条件
被如下接口引用:DescribeOperateOpsTasks。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TagName | String | 是 | 标签名称 示例值:Database |
TagValues | Array of String | 是 | 标签值列表 示例值:[default,testdb] |
TaskTypeCnt
TaskTypeCnt
被如下接口引用:DescribeSchedulerTaskTypeCnt。
名称 | 类型 | 描述 |
---|---|---|
Number | String | 统计值 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TaskType | String | 任务类型 注意:此字段可能返回 null,表示取不到有效值。 |
TypeName | String | 类型名称 注意:此字段可能返回 null,表示取不到有效值。 |
TaskTypeMap
任务类型map
被如下接口引用:DagInstances, DescribeScheduleInstances, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | Integer | 否 | key |
Value | String | 否 | value |
TaskTypeOpsDto
任务类型基本信息
被如下接口引用:DagInstances, DescribeAllByFolderNew, DescribeDependTaskLists, DescribeInstanceDetailInfo, DescribeScheduleInstances, DescribeSuccessorOpsTaskInfos, DescribeTaskRunHistory, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TypeDesc | String | 否 | 任务类型描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:shell任务 |
TypeId | Integer | 否 | 任务类型id 注意:此字段可能返回 null,表示取不到有效值。 示例值:35 |
TypeSort | String | 否 | 任务类型归类 注意:此字段可能返回 null,表示取不到有效值。 示例值:数据计算 |
TaskVersionInstance
任务实例基本信息
被如下接口引用:DescribeIntegrationTask。
名称 | 类型 | 描述 |
---|---|---|
InstanceVersion | Integer | 实例版本号 注意:此字段可能返回 null,表示取不到有效值。 示例值:12 |
VersionDesc | String | 实例描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:版本 |
ChangeType | Integer | 0, "新增",1, "修改" 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
SubmitterUin | String | 版本提交人UIN 注意:此字段可能返回 null,表示取不到有效值。 示例值:100006908545 |
InstanceDate | String | 提交日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-09-29 16:40:38 |
InstanceStatus | Integer | 0, "未启用",1, "启用(生产态)" 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ThresholdValue
数据质量阈值
被如下接口引用:CommitRuleGroupTask, CreateRule, DescribeRule, DescribeRuleExecDetail, DescribeRuleExecResults, DescribeRuleGroupExecResultsByPage, DescribeRules, ModifyRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ValueType | Integer | 否 | 阈值类型 1.低阈值 2.高阈值 3.普通阈值 4.枚举值 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Value | String | 否 | 阈值 注意:此字段可能返回 null,表示取不到有效值。 示例值:12 |
TopTableStat
质量概览表排行结果
被如下接口引用:DescribeTopTableStat。
名称 | 类型 | 描述 |
---|---|---|
AlarmTables | Array of TopTableStatItem | 告警表列表 |
PipelineTables | Array of TopTableStatItem | 阻塞表列表 |
TopTableStatItem
质量概览表排行元素
被如下接口引用:DescribeTopTableStat。
名称 | 类型 | 描述 |
---|---|---|
TableId | String | 表Id |
TableName | String | 表名 注意:此字段可能返回 null,表示取不到有效值。 |
Cnt | Integer | 数 示例值:1 |
UploadResourceRequestInfo
资管管理-上传资源请求
被如下接口引用:UploadResource。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ProjectId | String | 是 | 项目id |
FilePath | String | 是 | 资源路径 |
BucketName | String | 是 | 桶名称 |
Region | String | 是 | 所属地区 |
NewFile | Boolean | 是 | 是否为新资源 |
FileList | Array of String | 否 | 资源列表 |
FileSizeList | Array of String | 否 | 资源大小列表 |
FileMd5 | String | 否 | File Md5(适配私有化,公有云可以不传) |
UserFileDTONew
用户文件信息
被如下接口引用:UploadResource。
名称 | 类型 | 描述 |
---|---|---|
ResourceId | String | 资源ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:111111 |
FileName | String | 文件名 注意:此字段可能返回 null,表示取不到有效值。 示例值:1111 |
FileExtensionType | String | 文件类型,如 jar zip 等 注意:此字段可能返回 null,表示取不到有效值。 示例值:jar |
Type | String | 文件上传类型,资源管理为 resource 注意:此字段可能返回 null,表示取不到有效值。 示例值:resouce |
Md5Value | String | 文件MD5值 注意:此字段可能返回 null,表示取不到有效值。 示例值:aaaaa |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-02-27 00:00:00 |
UpdateTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-02-27 00:00:00 |
Size | Integer | 文件大小,单位为字节 注意:此字段可能返回 null,表示取不到有效值。 示例值:123123 |
LocalPath | String | 本地路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:/datastudio/resource/jaydenjhu/xxxx/wedata-spark-1.0-SNAPSHOT.ja |
LocalTempPath | String | 本地临时路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:/tmp/datastudio/resource/1171938931991703552/jaydenjhu/xxxx/wed |
RemotePath | String | 远程路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:/datastudio/resource/1171938931991703552/jaydenjhu/xxxx/wedata-s |
OwnerName | String | 文件拥有者名字 注意:此字段可能返回 null,表示取不到有效值。 示例值:fe |
Owner | String | 文件拥有者uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:100022256608 |
PathDepth | String | 文件深度 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ProjectId | String | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1111 |
ExtraInfo | String | 附加信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxxx |
ZipPath | String | 本地临时压缩文件绝对路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
Bucket | String | 文件所属存储桶 注意:此字段可能返回 null,表示取不到有效值。 示例值:agent-test-1257305158 |
Region | String | 文件所属存储桶的地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou |
DeleteName | String | 删除用户名称 注意:此字段可能返回 null,表示取不到有效值。 |
DeleteOwner | String | 删除用户id 注意:此字段可能返回 null,表示取不到有效值。 |
Operator | String | 操作者id 注意:此字段可能返回 null,表示取不到有效值。 |
OperatorName | String | 操作者名称 注意:此字段可能返回 null,表示取不到有效值。 |
FullPath | String | 全路径 注意:此字段可能返回 null,表示取不到有效值。 |
UserFileInfo
开发空间-获取数据开发脚本信息响应体
被如下接口引用:DeleteFilePath, GetFileInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ResourceId | String | 否 | 资源ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:111111 |
FileName | String | 否 | 文件名 注意:此字段可能返回 null,表示取不到有效值。 示例值:1111 |
FileExtensionType | String | 否 | 文件类型,如 jar zip 等 注意:此字段可能返回 null,表示取不到有效值。 示例值:jar |
Type | String | 否 | 文件上传类型,资源管理为 resource 注意:此字段可能返回 null,表示取不到有效值。 示例值:resouce |
Md5Value | String | 否 | 文件MD5值 注意:此字段可能返回 null,表示取不到有效值。 示例值:aaaaa |
CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-02-27 00:00:00 |
UpdateTime | String | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-02-27 00:00:00 |
Size | Integer | 否 | 文件大小,单位为字节 注意:此字段可能返回 null,表示取不到有效值。 示例值:123123 |
LocalPath | String | 否 | 本地路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:/datastudio/resource/jaydenjhu/xxxx/wedata-spark-1.0-SNAPSHOT.ja |
LocalTempPath | String | 否 | 本地临时路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:/tmp/datastudio/resource/1171938931991703552/jaydenjhu/xxxx/wed |
RemotePath | String | 否 | 远程路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:/datastudio/resource/1171938931991703552/jaydenjhu/xxxx/wedata-s |
OwnerName | String | 否 | 文件拥有者名字 注意:此字段可能返回 null,表示取不到有效值。 示例值:fe |
Owner | String | 否 | 文件拥有者uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:100022256608 |
PathDepth | Integer | 否 | 文件深度 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ProjectId | String | 否 | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1111 |
ExtraInfo | Array of ParamInfo | 否 | 附加信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxxx |
ZipPath | String | 否 | 本地临时压缩文件绝对路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
Bucket | String | 否 | 文件所属存储桶 注意:此字段可能返回 null,表示取不到有效值。 示例值:agent-test-1257305158 |
Region | String | 否 | 文件所属存储桶的地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou |
DeleteName | String | 否 | 无 注意:此字段可能返回 null,表示取不到有效值。 |
DeleteOwner | String | 否 | 无 注意:此字段可能返回 null,表示取不到有效值。 |
Operator | String | 否 | 无 注意:此字段可能返回 null,表示取不到有效值。 |
OperatorName | String | 否 | 无 注意:此字段可能返回 null,表示取不到有效值。 |
EncodeExtraInfo | String | 否 | 附加信息 base64编码 注意:此字段可能返回 null,表示取不到有效值。 |
WeightInfo
权重信息
被如下接口引用:ModifyDimensionWeight。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Weight | Integer | 是 | 权重 示例值:12 |
QualityDim | Integer | 是 | 维度类型 1:准确性,2:唯一性,3:完整性,4:一致性,5:及时性,6:有效性 示例值:1 |
WorkFlowExecuteDto
工作流运行信息
被如下接口引用:DescribeWorkflowExecuteById。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
StartTime | String | 否 | 开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-02-31 00:00:00 |
EndTime | String | 否 | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-02-31 01:01:11 |
Status | Integer | 否 | 工作流运行状态 0:等待运行、1:运行中、2:运行完成、3:运行出错 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
WorkFlowExecuteDtoByPage
分页查询工作流画布运行起止时间
被如下接口引用:DescribeWorkflowExecuteById。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TotalCount | Integer | 否 | 总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Items | Array of WorkFlowExecuteDto | 否 | data 注意:此字段可能返回 null,表示取不到有效值。 |
PageSize | Integer | 否 | 分页大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Workflow
工作流信息
被如下接口引用:DescribeFolderWorkflowList。
名称 | 类型 | 描述 |
---|---|---|
WorkflowId | String | 工作流id |
Owner | String | 责任人 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerId | String | 责任人Id 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 项目id |
ProjectIdent | String | 项目标识 |
ProjectName | String | 项目名称 |
WorkflowDesc | String | 备注 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowName | String | 工作流名称 |
FolderId | String | 所属文件夹id |
UserGroupId | String | 工作流所属用户分组id 若有多个,分号隔开: a;b;c 注意:此字段可能返回 null,表示取不到有效值。 |
UserGroupName | String | 工作流所属用户分组名称 若有多个,分号隔开: a;b;c 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowCanvasOpsDto
工作流画布详情
被如下接口引用:DescribeAllByFolderNew, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId, FindAllFolder。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
WorkflowId | String | 否 | 工作流id 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowDesc | String | 否 | 工作流详情描述 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowName | String | 否 | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 |
FolderId | String | 否 | 所属文件夹id 注意:此字段可能返回 null,表示取不到有效值。 |
FolderIds | Array of String | 否 | 所属文件夹ids 注意:此字段可能返回 null,表示取不到有效值。 |
Tasks | Array of TaskOpsDto | 否 | 任务列表 注意:此字段可能返回 null,表示取不到有效值。 |
Links | Array of LinkOpsDto | 否 | 任务依赖边列表 注意:此字段可能返回 null,表示取不到有效值。 |
UserGroupId | String | 否 | 工作流所属用户分组id,若有多个分号隔开: a;b;c 注意:此字段可能返回 null,表示取不到有效值。 |
UserGroupName | String | 否 | 工作流所属用户分组名称,若有多个分号隔开: a;b;c 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 否 | 项目id 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectIdent | String | 否 | 项目标识 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectName | String | 否 | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 |
Owner | String | 否 | 责任人 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerId | String | 否 | 责任人UserId 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowType | String | 否 | 工作流类型,周期cycle,手动manual 注意:此字段可能返回 null,表示取不到有效值。 示例值:cycle |
WorkflowExtOpsDto
工作流
被如下接口引用:DescribeOpsWorkflows。
名称 | 类型 | 描述 |
---|---|---|
TaskCount | Integer | 任务数量count 注意:此字段可能返回 null,表示取不到有效值。 |
FolderName | String | 文件名 注意:此字段可能返回 null,表示取不到有效值。 |
WorkFlowId | String | 工作流id 注意:此字段可能返回 null,表示取不到有效值。 |
Owner | String | 责任人 注意:此字段可能返回 null,表示取不到有效值。 |
OwnerId | String | 责任人userId 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | String | 项目id 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectIdent | String | 项目标识 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectName | String | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 |
WorkFlowDesc | String | 工作流描述 注意:此字段可能返回 null,表示取不到有效值。 |
WorkFlowName | String | 工作流名称 注意:此字段可能返回 null,表示取不到有效值。 |
FolderId | String | 工作流文件id 注意:此字段可能返回 null,表示取不到有效值。 |
Status | String | 工作流状态 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 工作流创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
ModifyTime | String | 最近更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowType | String | 工作流类型,周期cycle,手动manual 注意:此字段可能返回 null,表示取不到有效值。 示例值:cycle |
WorkflowExtOpsDtoPage
用户生产工作流列表分页
被如下接口引用:DescribeOpsWorkflows。
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录总数 注意:此字段可能返回 null,表示取不到有效值。 |
Items | Array of WorkflowExtOpsDto | 记录列表 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowScheduleDtoDs
工作流调度信息
被如下接口引用:DescribeWorkflowSchedulerInfoDs。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ProjectId | String | 否 | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowId | String | 否 | 工作流ID 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
Creater | String | 否 | 创建人 注意:此字段可能返回 null,表示取不到有效值。 |
ModifyTime | String | 否 | 修改时间 注意:此字段可能返回 null,表示取不到有效值。 |
DelayTime | Integer | 否 | 延迟时间 注意:此字段可能返回 null,表示取不到有效值。 |
StartupTime | Integer | 否 | 启动时间 注意:此字段可能返回 null,表示取不到有效值。 |
SelfDepend | String | 否 | 任务依赖 注意:此字段可能返回 null,表示取不到有效值。 |
StartTime | String | 否 | 开始时间 注意:此字段可能返回 null,表示取不到有效值。 |
EndTime | String | 否 | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
TaskAction | String | 否 | 指定运行时间 注意:此字段可能返回 null,表示取不到有效值。 |
CycleType | String | 否 | 调度周期时间单位 注意:此字段可能返回 null,表示取不到有效值。 |
CycleStep | Integer | 否 | 调度周期 注意:此字段可能返回 null,表示取不到有效值。 |
CrontabExpression | String | 否 | Cron表达式 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionStartTime | String | 否 | 执行时间左闭区间 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionEndTime | String | 否 | 执行时间右闭区间 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceInitStrategy | String | 否 | 实例初始化策略 注意:此字段可能返回 null,表示取不到有效值。 |
DependencyWorkflow | String | 否 | 工作流依赖 注意:此字段可能返回 null,表示取不到有效值。 |
SchedulerDesc | String | 否 | 调度计划 注意:此字段可能返回 null,表示取不到有效值。 |
FirstSubmitTime | String | 否 | 工作流首次提交时间 注意:此字段可能返回 null,表示取不到有效值。 |
LatestSubmitTime | String | 否 | 工作流最近提交时间 注意:此字段可能返回 null,表示取不到有效值。 |
CalendarOpen | String | 否 | 日历调度是否开启 注意:此字段可能返回 null,表示取不到有效值。 |
CalendarName | String | 否 | 日历调度名称 注意:此字段可能返回 null,表示取不到有效值。 |
CalendarId | String | 否 | 日历调度id 注意:此字段可能返回 null,表示取不到有效值。 |
ScheduleTimeZone | String | 否 | 时区配置 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowSchedulerOpsDto
工作流调度详情
被如下接口引用:DescribeWorkflowInfoById。
名称 | 类型 | 描述 |
---|---|---|
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
Creator | String | 创建人 注意:此字段可能返回 null,表示取不到有效值。 |
ModifyTime | String | 修改时间 注意:此字段可能返回 null,表示取不到有效值。 |
DelayTime | Integer | 延迟时间, unit=minute 注意:此字段可能返回 null,表示取不到有效值。 |
StartupTime | Integer | 启动时间,unit=minute 注意:此字段可能返回 null,表示取不到有效值。 |
SelfDepend | String | 任务自依赖类型 注意:此字段可能返回 null,表示取不到有效值。 |
StartTime | String | 开始时间 注意:此字段可能返回 null,表示取不到有效值。 |
EndTime | String | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
TaskAction | String | 指定运行时间, 指定时间:如周一:1 注意:此字段可能返回 null,表示取不到有效值。 |
CycleType | String | 调度周期类型,时间单位 注意:此字段可能返回 null,表示取不到有效值。 |
CycleStep | Integer | 调度周期,间隔步长 unit=minute 注意:此字段可能返回 null,表示取不到有效值。 |
CrontabExpression | String | 调度cron表达式 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionStartTime | String | 执行时间左闭区间 注意:此字段可能返回 null,表示取不到有效值。 |
ExecutionEndTime | String | 执行时间右闭区间 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceInitStrategy | String | 任务实例初始化策略 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowId | String | 工作流ID 注意:此字段可能返回 null,表示取不到有效值。 |
DependencyWorkflow | String | 工作流自依赖 注意:此字段可能返回 null,表示取不到有效值。 |
SchedulerDesc | String | 调度计划释义 注意:此字段可能返回 null,表示取不到有效值。 |
FirstSubmitTime | String | 工作流首次提交时间 注意:此字段可能返回 null,表示取不到有效值。 |
LatestSubmitTime | String | 工作流最近提交时间 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowTaskCountOpsDto
工作流任务统计
被如下接口引用:DescribeWorkflowTaskCount。
名称 | 类型 | 描述 |
---|---|---|
Count | Integer | 工作流任务数 注意:此字段可能返回 null,表示取不到有效值。 |
TypeCount | Array of PairDto | 任务类型维度统计 注意:此字段可能返回 null,表示取不到有效值。 |
CycleCount | Array of PairDto | 任务周期类型维度统计 注意:此字段可能返回 null,表示取不到有效值。 |