Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

Data Types

Last updated: 2024-06-24 16:59:07

AdhocDetail

Subtask records

Used by actions: SubmitSqlTask.

Name	Type	Description
Id	Integer	Subtask record Id
ScriptContent	String	Script Content
StartTime	Timestamp ISO8601	Task start time Note: This field may return null, indicating that no valid value can be obtained.
EndTime	Timestamp ISO8601	Task termination time Note: This field may return null, indicating that no valid value can be obtained.
Status	String	Current Task Status
RecordId	Integer	Submit Task ID

AdhocRecord

Task Submission Record

Used by actions: SubmitSqlTask.

Name	Type	Description
Id	Integer	Task Submission Record ID Note: This field may return null, indicating that no valid value can be obtained.
ScriptContent	String	Script ContentNote: This field may return null, indicating that no valid value can be obtained.
CreateTime	Timestamp ISO8601	Task Submission Time Note: This field may return null, indicating that no valid value can be obtained.
Status	String	Task StatusNote: This field may return null, indicating that no valid value can be obtained.
InstanceId	String	Instance ID Note: This field may return null, indicating that no valid value can be obtained.

AgentStatus

Agent Collector Status Statistics

Used by actions: DescribeIntegrationTask.

Name	Type	Description
Running	Integer	Running Quantity Note: This field may return null, indicating that no valid value can be obtained.
Abnormal	Integer	Number of Anomalies Note: This field may return null, indicating that no valid value can be obtained.
InOperation	Integer	Operating Quantity Note: This field may return null, indicating that no valid value can be obtained.

AlarmEventInfo

Alarm Event Details

Used by actions: DescribeAlarmEvents.

Name	Type	Required	Description
AlarmId	String	Yes	Alert ID
AlarmTime	String	Yes	Alarm Time
TaskId	String	Yes	Task ID
RegularName	String	Yes	Rule name
AlarmLevel	Integer	Yes	Alert level, 0 for normal, 1 for important, 2 for urgent
AlarmWay	Integer	Yes	Alert Method, separated by commas (1: email, 2: SMS, 3: WeChat, 4: voice call, 5: represents WeCom, 6: http)
AlarmRecipientId	String	Yes	Alert Recipient ID, separated by commas
ProjectId	String	Yes	Project ID
AlarmIndicator	Integer	No	Alert Metrics, 0 for task failure, 1 for task run timeout, 2 for task stop, 3 for task pause
AlarmIndicatorDesc	String	No	Alert Metric Description Note: This field may return null, indicating that no valid value can be obtained.
TriggerType	Integer	No	Metric threshold, 1 indicates the first run failure of the offline task, 2 indicates failure after all retries of the offline task Note: This field may return null, indicating that no valid value can be obtained.
EstimatedTime	Integer	No	Estimated timeout, minute level Note: This field may return null, indicating that no valid value can be obtained.
InstanceId	String	No	Instance IDNote: This field may return null, indicating that no valid value can be obtained.
TaskName	String	No	Task NameNote: This field may return null, indicating that no valid value can be obtained.
IsSendSuccess	Integer	No	0: Partial Success, 1: Complete Success, 2: Complete Failure Note: This field may return null, indicating that no valid value can be obtained.
InQuitePeriods	Integer	No	During Do Not Disturb time, 0: No, 1: Yes Note: This field may return null, indicating that no valid value can be obtained.
RecordId	Integer	No	Alert Record ID Note: This field may return null, indicating that no valid value can be obtained.
MessageId	String	No	Message ID Note: This field may return null, indicating that no valid value can be obtained.
Operator	Integer	No	Threshold Calculation Operator, 1: Greater than, 2: Less than Note: This field may return null, indicating that no valid value can be obtained.
RegularId	String	No	Alert Rule ID Note: This field may return null, indicating that no valid value can be obtained.
AlarmRecipientName	String	No	Alert Recipient Nickname Note: This field may return null, indicating that no valid value can be obtained.
TaskType	Integer	No	Alert Task Type Note: This field may return null, indicating that no valid value can be obtained.
SendResult	String	No	Send Result Note: This field may return null, indicating that no valid value can be obtained.
MonitorObjectId	String	No	Monitoring Object ID Note: This field may return null, indicating that no valid value can be obtained.
MonitorObjectName	String	No	Monitoring Object Name Note: This field may return null, indicating that no valid value can be obtained.
Threshold	Float	No	Metric Threshold Note: This field may return null, indicating that no valid value can be obtained.

AlarmIndicatorInfo

Alert Metrics

Used by actions: BatchCreateIntegrationTaskAlarms, CreateTaskAlarmRegular, DescribeTaskAlarmRegulations, ModifyTaskAlarmRegular.

Name	Type	Required	Description
Id	String	No	Metric ID Note: This field may return null, indicating that no valid value can be obtained.
AlarmIndicator	Integer	No	Alert Metrics, 0 for task failure, 1 for task execution timeout, 2 for task stop, 3 for task pause, 4 read speed, 5 write speed, 6 read throughput, 7 write throughput, 8 dirty data byte count, 9 number of dirty data entries, 10 task exception, 11 task detection anomaly, 12 restart times, 13 task delay, 14 number of restarts within the last 20 minutes, 15 transmission delay, 16 business delay, 50 offline package CPU usage rate, 51 offline package memory usage rate, 52 offline package parallelism utilization, 53 number of instances queued for offline packages, 54 real-time package resource utilization, 55 number of tasks running in real-time packages Note: This field may return null, indicating that no valid value can be obtained.
AlarmIndicatorDesc	String	No	Alert Metric Description Note: This field may return null, indicating that no valid value can be obtained.
TriggerType	Integer	No	Metric Threshold, 1 for the first run failure of an offline task, 2 for all retries failed of an offline task Note: This field may return null, indicating that no valid value can be obtained.
EstimatedTime	Integer	No	Estimated timeout duration, minute level Note: This field may return null, indicating that no valid value can be obtained.
Operator	Integer	No	Alert threshold operator, 1 Greater than, 2 Less than Note: This field may return null, indicating that no valid value can be obtained.
AlarmIndicatorUnit	String	No	Alert metric threshold unit: ms (milliseconds), s (seconds), min (minutes) Note: This field may return null, indicating that no valid value can be obtained.
Duration	Integer	No	Alert Interval
DurationUnit	String	No	Alert interval unit: hour, minute, day
MaxTimes	Integer	No	Maximum number of alerts within a cycle
Threshold	Float	No	Metric Threshold Note: This field may return null, indicating that no valid value can be obtained.

AlarmInfo

Task Alert Information

Used by actions: SetTaskAlarmNew.

Name	Type	Required	Description
TaskIds	String	Yes	Associated Task ID
AlarmType	String	Yes	Alert Categories; 'failure' indicates failure alert; 'overtime' indicates timeout alert
AlarmWay	String	Yes	Alert Method; 'SMS' indicates SMS; 'Email' indicates email; 'HTTP' indicates an interface method; 'Wechat' indicates WeChat method
AlarmRecipient	String	Yes	Alert Recipient, multiple recipients separated by ;
AlarmRecipientId	String	Yes	Alert Recipient ID, multiple recipient IDs separated by ;
Hours	Integer	Yes	Estimated Running Hours, value range 0-23
Minutes	Integer	Yes	Estimated Running Minutes, value range 0-59
TriggerType	Integer	Yes	Alert Trigger Moment; '1' means first run failure; '2' means failure after all retries;
AlarmId	String	No	Alert Information ID
Status	Integer	No	Alert Status Setting; '1' indicates available; '0' indicates unavailable, default is available

AlarmReceiverInfo

Alert Recipient Details

Used by actions: DescribeAlarmReceiver.

Name	Type	Required	Description
AlarmId	String	Yes	Alert ID
AlarmReceiver	String	Yes	Alarm Recipient ID
Email	Integer	Yes	Email,0: Not set,1: Success,2: Failure
Sms	Integer	Yes	SMS,0: Not set,1: Success,2: Failure
Wechat	Integer	Yes	WeChat,0: Not set,1: Success,2: Failure
Voice	Integer	Yes	Telephone,0: Not set,1: Success,2: Failure
Wecom	Integer	Yes	WeCom,0: Not set,1: Success,2: Failure
Http	Integer	Yes	http,0: Not set,1: Success,2: Failure
WecomGroup	Integer	No	Enterprise WeChat group,0: Not set,1: Success,2: Failure Note: This field may return null, indicating that no valid value can be obtained.
LarkGroup	Integer	No	FeiShu Group,0: Not set,1: Success,2: Failure Note: This field may return null, indicating that no valid value can be obtained.

Apply

Approval List Information

Used by actions: DescribeApproveList.

Name	Type	Description
ApplicantId	String	Applicant ID
ApplicantName	String	Applicant Name
Remark	String	Approval Remarks Note: This field may return null, indicating that no valid value can be obtained.
ApproveClassification	String	Approval Category Key
ApproveId	String	Approval Form ID
ApproveType	String	Approval Type Key
Reason	String	Application Reason Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation Time
ApproveTime	String	Approval Time Note: This field may return null, indicating that no valid value can be obtained.
ApproveClassificationName	String	Approval Category Name
Status	String	Status
ApproveTypeName	String	Approval Type Name
ErrorMessage	String	Approval Exception or Failure Information
ApplyName	String	Apply for Name Note: This field may return null, indicating that no valid value can be obtained.
ApproverId	String	Approver ID Note: This field may return null, indicating that no valid value can be obtained.
ApproverName	String	Approver Name Note: This field may return null, indicating that no valid value can be obtained.
ApproveProjectName	String	Project for Approval Note: This field may return null, indicating that no valid value can be obtained.

ApproveModify

Modify Approval Form Status

Used by actions: ModifyApproveStatus.

Name	Type	Description
ApproveId	String	Approval Form ID
Success	Boolean	Modification successful?

ApproveType

Approval Category

Used by actions: DescribeApproveTypeList.

Name	Type	Description
Type	String	Application Category Key
TypeName	String	Type Name
Classification	String	Application Type Key

AttributeItemDTO

AIOps basic information

Used by actions: DescribeOpsInstanceLogList.

Name	Type	Required	Description
Key	String	No	key Note: This field may return null, indicating that no valid value can be obtained.
Value	String	No	value Note: This field may return null, indicating that no valid value can be obtained.
Description	String	No	DescriptionNote: This field may return null, indicating that no valid value can be obtained.

BaseClusterInfo

Cluster Basic Information

Used by actions: DescribeProject.

Name	Type	Description
ClusterId	String	Cluster ID Note: This field may return null, indicating that no valid value can be obtained.
ClusterType	String	Cluster Type, EMR/CDW, etc. Note: This field may return null, indicating that no valid value can be obtained.
ClusterName	String	Cluster NameNote: This field may return null, indicating that no valid value can be obtained.
RegionCn	String	Region Chinese Note: This field may return null, indicating that no valid value can be obtained.
RegionEn	String	Region English Note: This field may return null, indicating that no valid value can be obtained.
RegionArea	String	RegionNote: This field may return null, indicating that no valid value can be obtained.
Used	Boolean	Whether the Cluster is Used Note: This field may return null, indicating that no valid value can be obtained.
Status	Integer	Cluster StatusNote: This field may return null, indicating that no valid value can be obtained.
StatusInfo	String	Cluster State Information Note: This field may return null, indicating that no valid value can be obtained.
StorageType	String	Cluster Storage Type Note: This field may return null, indicating that no valid value can be obtained.
ComputeType	String	Cluster Computing Type Note: This field may return null, indicating that no valid value can be obtained.
ClusterResource	String	Cluster Resource Quantity Note: This field may return null, indicating that no valid value can be obtained.
ChargeType	String	Cluster Payment Method Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	Timestamp ISO8601	Cluster Creation Time Note: This field may return null, indicating that no valid value can be obtained.
ExtraConf	String	Additional Configuration Note: This field may return null, indicating that no valid value can be obtained.
RangerUserName	String	Ranger Account Name Note: This field may return null, indicating that no valid value can be obtained.
CdwUserName	String	CDW Account (for display) Note: This field may return null, indicating that no valid value can be obtained.

BaseTenant

Tenant basic information

Used by actions: DescribeProject.

Name	Type	Required	Description
TenantId	String	Yes	Tenant IDNote: This field may return null, indicating that no valid value can be obtained.
TenantName	String	Yes	Tenant ID Note: This field may return null, indicating that no valid value can be obtained.
DisplayName	String	Yes	Tenant display name, usually the Chinese name Note: This field may return null, indicating that no valid value can be obtained.
Description	String	Yes	RemarksNote: This field may return null, indicating that no valid value can be obtained.
OwnerUserId	String	Yes	Tenant Main Account Note: This field may return null, indicating that no valid value can be obtained.
Params	String	Yes	Tenant's additional configuration parameters, in JSON format string Note: This field may return null, indicating that no valid value can be obtained.

BaseUser

Basic User Information

Used by actions: DescribeProject.

Name	Type	Required	Description
UserId	String	No	Cloud User UIN, Globally Unique Note: This field may return null, indicating that no valid value can be obtained.
UserName	String	No	User Global Unique Identifier Note: This field may return null, indicating that no valid value can be obtained.
DisplayName	String	No	User Display Name Note: This field may return null, indicating that no valid value can be obtained.
PhoneNum	String	No	Telephone Number Note: This field may return null, indicating that no valid value can be obtained.
Email	String	No	Email Note: This field may return null, indicating that no valid value can be obtained.

BatchCreateTaskVersionDTO

Used by BatchCreateTaskVersion, describes task information

Used by actions: CreateTaskVersionDs.

Name	Type	Required	Description
TaskId	String	Yes	Task IDNote: This field may return null, indicating that no valid value can be obtained.
VersionRemark	String	No	VersionRemark Note: This field may return null, indicating that no valid value can be obtained.
FolderId	String	No	Folder ID Note: This field may return null, indicating that no valid value can be obtained.

BatchOperateResult

Batch operation result return

Used by actions: SetTaskAlarmNew.

Name	Type	Description
SuccessCount	Integer	Number of Batch Operations Succeeded
FailedCount	Integer	Number of Batch Operations Failed
TotalCount	Integer	Total Number of Batch Operations

BatchOperateResultOpsDto

Instance Batch Operation Result Class

Used by actions: KillOpsMakePlanInstances, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances.

Name	Type	Description
Result	Boolean	ResultNote: This field may return null, indicating that no valid value can be obtained.
ErrorId	String	Error ID Note: This field may return null, indicating that no valid value can be obtained.
ErrorDesc	String	Error Description Note: This field may return null, indicating that no valid value can be obtained.

BatchOperationOpsDto

Batch operation result return

Used by actions: BatchDeleteOpsTasks, BatchModifyOpsOwners, BatchStopOpsTasks, UpdateWorkflowOwner.

Name	Type	Description
SuccessCount	Integer	Number of successful batch operations Note: This field may return null, indicating that no valid value can be obtained.
FailedCount	Integer	Number of failed batch operations Note: This field may return null, indicating that no valid value can be obtained.
TotalCount	Integer	Total number of batch operations Note: This field may return null, indicating that no valid value can be obtained.

BatchOpsDTO

Batch Operation Result, with Failure Reason

Used by actions: TriggerDsEvent.

Name	Type	Description
TotalCount	Integer	Total Quantity Note: This field may return null, indicating that no valid value can be obtained.
SuccessCount	Integer	Success count Note: This field may return null, indicating that no valid value can be obtained.
FailCount	Integer	Failure count Note: This field may return null, indicating that no valid value can be obtained.
FailMessageList	Array of FailMessage	Failure reason Note: This field may return null, indicating that no valid value can be obtained.

BatchResult

Batch Operation Result

Used by actions: ModifyWorkflowSchedule.

Name	Type	Description
Running	Integer	Number of Tasks Running
Success	Integer	Number of Tasks Executed Successfully
Failed	Integer	Number of Tasks Executed Failed
Total	Integer	Total Tasks

BatchReturn

Operation result

Used by actions: RegisterEvent, RegisterEventListener, TriggerEvent.

Name	Type	Description
Result	Boolean	Execution Result
ErrorDesc	String	Execution remarks Note: This field may return null, indicating that no valid value can be obtained.
ErrorId	String	Execution ID Note: This field may return null, indicating that no valid value can be obtained.

BytesSpeed

Real-time task synchronization speed Bytes/s

Used by actions: DescribeRealTimeTaskSpeed.

Name	Type	Description
NodeType	String	Node TypeNote: This field may return null, indicating that no valid value can be obtained.
NodeName	String	Node nameNote: This field may return null, indicating that no valid value can be obtained.
Values	Array of SpeedValue	Speed value list Note: This field may return null, indicating that no valid value can be obtained.

CollectionFolderOpsDto

Folder List

Used by actions: DescribeAllByFolderNew.

Name	Type	Required	Description
TotalCount	Integer	No	Total numberNote: This field may return null, indicating that no valid value can be obtained.
TotalPage	Integer	No	Total number of pages Note: This field may return null, indicating that no valid value can be obtained.
PageCount	Integer	No	Current Page Number Note: This field may return null, indicating that no valid value can be obtained.
PageNumber	Integer	No	Page Number Note: This field may return null, indicating that no valid value can be obtained.
PageSize	Integer	No	Quantity per page Note: This field may return null, indicating that no valid value can be obtained.
Items	Array of FolderOpsDto	No	Task InformationNote: This field may return null, indicating that no valid value can be obtained.

CollectionInstanceOpsDto

Instance List Structure

Used by actions: DagInstances, DescribeScheduleInstances.

Name	Type	Required	Description
TotalCount	Integer	No	Total numberNote: This field may return null, indicating that no valid value can be obtained.
TotalPage	Integer	No	Total Number of Pages Note: This field may return null, indicating that no valid value can be obtained.
PageCount	Integer	No	Current Page Number Note: This field may return null, indicating that no valid value can be obtained.
PageNumber	Integer	No	Page Number Note: This field may return null, indicating that no valid value can be obtained.
PageSize	Integer	No	Quantity per page Note: This field may return null, indicating that no valid value can be obtained.
Items	Array of InstanceOpsDto	No	Instance InformationNote: This field may return null, indicating that no valid value can be obtained.

ColumnAggregationLineage

Column Lineage Aggregation Information

Used by actions: DescribeColumnLineage.

Name	Type	Description
TableName	String	Table nameNote: This field may return null, indicating that no valid value can be obtained.
ParentId	String	Parent Node ID Note: This field may return null, indicating that no valid value can be obtained.
MetastoreType	String	Metadata Type Note: This field may return null, indicating that no valid value can be obtained.
ParentSet	String	String Type Parent Node Collection Note: This field may return null, indicating that no valid value can be obtained.
ChildSet	String	String Type Child Node Collection Note: This field may return null, indicating that no valid value can be obtained.
ColumnInfoSet	Array of SimpleColumnInfo	Column Information Collection Note: This field may return null, indicating that no valid value can be obtained.

ColumnBasicInfo

Table Metadata Information

Used by actions: DescribeFieldBasicInfo.

Name	Type	Description
TableId	String	Table's Globally Unique ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	Data Source Globally Unique ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceName	String	Data Source Name Note: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	Database ID Note: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	Database nameNote: This field may return null, indicating that no valid value can be obtained.
TableName	String	Table Name Note: This field may return null, indicating that no valid value can be obtained.
ColumnName	String	Field NameNote: This field may return null, indicating that no valid value can be obtained.
DataType	String	Data Type, such as string/int etc. Note: This field may return null, indicating that no valid value can be obtained.
ColumnType	String	Field Type, such as varchar(32)/int(10) etc. Note: This field may return null, indicating that no valid value can be obtained.
ColumnDefault	String	Field Default Value Note: This field may return null, indicating that no valid value can be obtained.
ColumnKey	String	Index Type, such as PRI/MUL/PARTITION etc., For normal fields, this value is an empty string Note: This field may return null, indicating that no valid value can be obtained.
ColumnPosition	Integer	Field Order Identifier Note: This field may return null, indicating that no valid value can be obtained.
ColumnComment	String	Field Comment Note: This field may return null, indicating that no valid value can be obtained.
StoreType	String	Data TypeNote: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	Project ID Note: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	Project Name in English Note: This field may return null, indicating that no valid value can be obtained.
ProjectDisplayName	String	Project Name in Chinese Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	Update timeNote: This field may return null, indicating that no valid value can be obtained.
Scale	Integer	Precision Note: This field may return null, indicating that no valid value can be obtained.

ColumnData

ColumnItem

Used by actions: DiagnosePro.

Name	Type	Required	Description
EventName	String	No	ColumnName1 Note: This field may return null, indicating that no valid value can be obtained.
EventProjectName	String	No	ColumnName1 Note: This field may return null, indicating that no valid value can be obtained.
Type	String	No	1 Note: This field may return null, indicating that no valid value can be obtained.
CurRunDate	String	No	1 Note: This field may return null, indicating that no valid value can be obtained.
TaskId	String	No	1 Note: This field may return null, indicating that no valid value can be obtained.
State	String	No	1 Note: This field may return null, indicating that no valid value can be obtained.
EventType	String	No	1 Note: This field may return null, indicating that no valid value can be obtained.
TaskName	String	No	Task NameNote: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	No	Project nameNote: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	No	Project IDNote: This field may return null, indicating that no valid value can be obtained.

ColumnItem

Used by actions: DiagnosePro.

Name	Type	Required	Description
ColumnName	String	No	ColumnName1 Note: This field may return null, indicating that no valid value can be obtained.
ColumnRef	String	No	ColumnName1 Note: This field may return null, indicating that no valid value can be obtained.

ColumnLineageInfo

Lineage Field Information

Used by actions: DescribeColumnLineage.

Name	Type	Required	Description
Id	String	Yes	Lineage ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	Yes	Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
ColumnName	String	No	Field NameNote: This field may return null, indicating that no valid value can be obtained.
ColumnNameCn	String	No	Field Chinese Name Note: This field may return null, indicating that no valid value can be obtained.
ColumnType	String	No	Field TypeNote: This field may return null, indicating that no valid value can be obtained.
RelationParams	String	No	Relationship Parameters Note: This field may return null, indicating that no valid value can be obtained.
Params	String	No	ParameterNote: This field may return null, indicating that no valid value can be obtained.
ParentId	String	No	Parent ID Note: This field may return null, indicating that no valid value can be obtained.
MetastoreType	String	No	Metadata Type Note: This field may return null, indicating that no valid value can be obtained.
MetastoreTypeName	String	No	Metadata Type Name Note: This field may return null, indicating that no valid value can be obtained.
TableName	String	No	Table Name Note: This field may return null, indicating that no valid value can be obtained.
QualifiedName	String	No	Full Field Name Note: This field may return null, indicating that no valid value can be obtained.
DownStreamCount	Integer	No	Number of Downstream Nodes Note: This field may return null, indicating that no valid value can be obtained.
UpStreamCount	Integer	No	Number of Upstream Nodes Note: This field may return null, indicating that no valid value can be obtained.
Description	String	No	DescriptionNote: This field may return null, indicating that no valid value can be obtained.
PrefixPath	String	No	Path Information Starting from the Central Node Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
ModifyTime	String	No	Update timeNote: This field may return null, indicating that no valid value can be obtained.
Tasks	Array of String	No	Task ID list Note: This field may return null, indicating that no valid value can be obtained.
ParentSet	String	No	Parent Node List String Note: This field may return null, indicating that no valid value can be obtained.
ChildSet	String	No	Child Node List String Note: This field may return null, indicating that no valid value can be obtained.
ExtParams	Array of LineageParamRecord	No	Additional parameters Note: This field may return null, indicating that no valid value can be obtained.
TableId	String	No	Table IDNote: This field may return null, indicating that no valid value can be obtained.

ColumnMeta

Column Metadata

Used by actions: DescribeColumnsMeta.

Name	Type	Description
NameEn	String	Field English Name Note: This field may return null, indicating that no valid value can be obtained.
NameCn	String	Field Chinese Name Note: This field may return null, indicating that no valid value can be obtained.
Type	String	Field TypeNote: This field may return null, indicating that no valid value can be obtained.
Description	String	Field DescriptionNote: This field may return null, indicating that no valid value can be obtained.
Position	Integer	Field Sequence Number Note: This field may return null, indicating that no valid value can be obtained.
IsPartition	Boolean	Is Partition Field Note: This field may return null, indicating that no valid value can be obtained.
Name	String	Field nameNote: This field may return null, indicating that no valid value can be obtained.
ColumnFamiliesFieldSet	Array of Pair	HBase Column Family Attribute Set Note: This field may return null, indicating that no valid value can be obtained.
DictionaryId	String	Corresponding Code Table Dictionary ID Note: This field may return null, indicating that no valid value can be obtained.
DictionaryName	String	Corresponding Code Table Dictionary Name Note: This field may return null, indicating that no valid value can be obtained.
LevelName	String	Security Level: Name Note: This field may return null, indicating that no valid value can be obtained.
LevelRank	Integer	Security Level: Value Range 1-10 Note: This field may return null, indicating that no valid value can be obtained.

CommonContent

Content Details

Used by actions: ModifyTaskScript.

Name	Type	Description
Content	String	Detailed Content Note: This field may return null, indicating that no valid value can be obtained.

CommonId

ID Wrapper Object

Used by actions: CreateTask.

Name	Type	Required	Description
Id	String	Yes	ID Value Note: This field may return null, indicating that no valid value can be obtained.

CommonIdOpsDto

Return Command ID

Used by actions: CreateOpsMakePlan.

Name	Type	Description
Id	String	Returns the supplemental plan id Note: This field may return null, indicating that no valid value can be obtained.

CompareResult

Quality Check Comparison Results

Used by actions: CommitRuleGroupTask, DescribeRuleExecDetail, DescribeRuleExecResults, DescribeRuleGroupExecResultsByPage.

Name	Type	Required	Description
Items	Array of CompareResultItem	Yes	Comparison Result Item List Note: This field may return null, indicating that no valid value can be obtained.
TotalRows	Integer	Yes	Total Number of Rows Detected Note: This field may return null, indicating that no valid value can be obtained.
PassRows	Integer	Yes	Number of Rows Passed Note: This field may return null, indicating that no valid value can be obtained.
TriggerRows	Integer	Yes	Number of Rows Failed Note: This field may return null, indicating that no valid value can be obtained.

CompareResultItem

Comparison Result Item

Used by actions: CommitRuleGroupTask, DescribeRuleExecDetail, DescribeRuleExecResults, DescribeRuleGroupExecResultsByPage.

Name	Type	Required	Description
FixResult	Integer	Yes	Comparison Result, 1 is true, 2 is false Note: This field may return null, indicating that no valid value can be obtained.
ResultValue	String	Yes	Quality SQL Execution Result Note: This field may return null, indicating that no valid value can be obtained.
Values	Array of ThresholdValue	Yes	Threshold List Note: This field may return null, indicating that no valid value can be obtained.
Operator	String	Yes	Comparison Operation Type Note: This field may return null, indicating that no valid value can be obtained.
CompareType	Integer	Yes	Comparison Type Note: This field may return null, indicating that no valid value can be obtained.
ValueComputeType	Integer	Yes	Value Comparison Type Note: This field may return null, indicating that no valid value can be obtained.

CompareRule

Comparison Rules

Used by actions: CreateRule, DescribeRule, DescribeRules, ModifyRule.

Name	Type	Required	Description
Items	Array of CompareRuleItem	No	Comparison Criteria List Note: This field may return null, indicating that no valid value can be obtained.
CycleStep	Integer	No	Default cycle of the periodic template, Unit: seconds Note: This field may return null, indicating that no valid value can be obtained.
ComputeExpression	String	No	o represents OR, a represents AND, numbers represent items' indices Note: This field may return null, indicating that no valid value can be obtained.

CompareRuleItem

Comparison Criterion

Used by actions: CreateRule, DescribeRule, DescribeRules, ModifyRule.

Name	Type	Required	Description
CompareType	Integer	No	Comparison Type 1. Fixed value 2. Fluctuation Value 3. Numeric Range Comparison 4. Enumeration Range Comparison 5. No Comparison Note: This field may return null, indicating that no valid value can be obtained.
Operator	String	No	Comparison Operation Type < <= == => > != IRLCRO: Within the interval (left closed, right open) IRLORC: Within the interval (left open, right closed) IRLCRC: Within the interval (left closed, right closed) IRLORO: Within the interval (left open, right open) NRLCRO: Not within the range (left-closed, right-open) NRLORC: Not within the range (left-open, right-closed) NRLCRC: Not within the range (left-closed, right-closed) NRLORO: Not within the range (left-open, right-open) Note: This field may return null, indicating that no valid value can be obtained.
ValueComputeType	Integer	No	Quality statistical value types 1. Absolute Value 2. Increase 3. Decline 4. _C includes 5. N_C does not include Note: This field may return null, indicating that no valid value can be obtained.
ValueList	Array of ThresholdValue	No	Comparison threshold list Note: This field may return null, indicating that no valid value can be obtained.

Content

Used by actions: DiagnosePro.

Name	Type	Required	Description
TaskId	String	No	Task IDNote: This field may return null, indicating that no valid value can be obtained.
TaskName	String	No	Task NameNote: This field may return null, indicating that no valid value can be obtained.
Diagnose	String	No	Diagnosis Note: This field may return null, indicating that no valid value can be obtained.
Reason	String	No	Reason Note: This field may return null, indicating that no valid value can be obtained.
Operation	String	No	OperationNote: This field may return null, indicating that no valid value can be obtained.
Url	String	No	Link Note: This field may return null, indicating that no valid value can be obtained.

CreateMakeDatetimeInfo

Supplementary Plan Date Range

Used by actions: CreateOpsMakePlan, DescribeOpsMakePlans.

Name	Type	Required	Description
StartDate	String	No	Start date Note: This field may return null, indicating that no valid value can be obtained.
EndDate	String	No	End date Note: This field may return null, indicating that no valid value can be obtained.
StartTime	String	No	Start TimeNote: This field may return null, indicating that no valid value can be obtained.
EndTime	String	No	End timeNote: This field may return null, indicating that no valid value can be obtained.

DailyScoreInfo

Daily Rating Information

Used by actions: DescribeQualityScoreTrend, DescribeTableScoreTrend.

Name	Type	Description
StatisticsDate	Integer	Statistics Date TimestampNote: This field may return null, indicating that no valid value can be obtained.
Score	Float	ScoringNote: This field may return null, indicating that no valid value can be obtained.

DataCheckStat

Data Monitoring Results

Used by actions: DescribeDataCheckStat.

Name	Type	Description
TableTotal	Integer	Total Tables
ColumnTotal	Integer	Total Number of Fields
TableConfig	Integer	Number of Table Configuration Checks
ColumnConfig	Integer	Number of Field Configuration Checks
TableExec	Integer	Actual Number of Table Checks
ColumnExec	Integer	Actual Number of Field Checks

DataSourceInfo

Data Source Object

Used by actions: DescribeDataSourceList, DescribeDatasource.

Name	Type	Description
DatabaseName	String	If the data source list is bound to a database, then it is the database nameNote: This field may return null, indicating that no valid value can be obtained.
Description	String	Data source description informationNote: This field may return null, indicating that no valid value can be obtained.
ID	Integer	Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
Instance	String	Instance ID of the data source engine, e.g., CDB Instance IDNote: This field may return null, indicating that no valid value can be obtained.
Name	String	Data Source Name, cannot be empty under the same SpaceNameNote: This field may return null, indicating that no valid value can be obtained.
Region	String	Region to which the data source engine belongs Note: This field may return null, indicating that no valid value can be obtained.
Type	String	Data Source Type: enumerated valuesNote: This field may return null, indicating that no valid value can be obtained.
ClusterId	String	Cluster ID to which the data source belongs Note: This field may return null, indicating that no valid value can be obtained.
AppId	Integer	Application ID AppId Note: This field may return null, indicating that no valid value can be obtained.
BizParams	String	Configuration Information Extension of Business Data SourceNote: This field may return null, indicating that no valid value can be obtained.
Category	String	Data Source Category: Binding Engine, Binding DatabaseNote: This field may return null, indicating that no valid value can be obtained.
Display	String	Data Source Display Name, for visual inspectionNote: This field may return null, indicating that no valid value can be obtained.
OwnerAccount	String	Data Source Responsible Person Account ID Note: This field may return null, indicating that no valid value can be obtained.
Params	String	Data source configuration information, stored as JSON KV. The KV storage information varies according to the data source typeNote: This field may return null, indicating that no valid value can be obtained.
Status	Integer	Visibility of the data source, where 1 is visible and 0 is not visible. Default is 1Note: This field may return null, indicating that no valid value can be obtained.
OwnerAccountName	String	Data source owner account name Note: This field may return null, indicating that no valid value can be obtained.
ClusterName	String	Cluster NameNote: This field may return null, indicating that no valid value can be obtained.
OwnerProjectId	String	Project IDNote: This field may return null, indicating that no valid value can be obtained.
OwnerProjectName	String	Project NameNote: This field may return null, indicating that no valid value can be obtained.
OwnerProjectIdent	String	Belonging project identifier Note: This field may return null, indicating that no valid value can be obtained.
AuthorityProjectName	String	Authorized project Note: This field may return null, indicating that no valid value can be obtained.
AuthorityUserName	String	Authorized user Note: This field may return null, indicating that no valid value can be obtained.
Edit	Boolean	Edit permissions available Note: This field may return null, indicating that no valid value can be obtained.
Author	Boolean	Authorization permissions available Note: This field may return null, indicating that no valid value can be obtained.
Deliver	Boolean	Transfer permissions available Note: This field may return null, indicating that no valid value can be obtained.
DataSourceStatus	String	Data source status Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	Integer	TimeNote: This field may return null, indicating that no valid value can be obtained.
ParamsString	String	Params JSON string Note: This field may return null, indicating that no valid value can be obtained.
BizParamsString	String	BizParams JSON string Note: This field may return null, indicating that no valid value can be obtained.
ModifiedTime	Integer	Modification TimeNote: This field may return null, indicating that no valid value can be obtained.
ShowType	String	Data source display type, corresponding to Type Note: This field may return null, indicating that no valid value can be obtained.
ProductId	Integer	Current data source production source Id Note: This field may return null, indicating that no valid value can be obtained.
DevelopmentId	Integer	Current data source development source Id Note: This field may return null, indicating that no valid value can be obtained.
DevelopmentParams	String	Same as params, content is the data for the development data source Note: This field may return null, indicating that no valid value can be obtained.

DataSourceInfoPage

Query Data Source Pagination List

Used by actions: DescribeDataSourceList.

Name	Type	Description
PageNumber	Integer	pagination page number Note: This field may return null, indicating that no valid value can be obtained.
PageSize	Integer	pagination size Note: This field may return null, indicating that no valid value can be obtained.
Rows	Array of DataSourceInfo	data source list Note: This field may return null, indicating that no valid value can be obtained.
TotalCount	Integer	Total numberNote: This field may return null, indicating that no valid value can be obtained.
TotalPageNumber	Integer	total pagination pages Note: This field may return null, indicating that no valid value can be obtained.

DatabaseInfo

Data Quality Data Source Database

Used by actions: DescribeDatabaseInfoList.

Name	Type	Required	Description
DatasourceName	String	No	Data source name Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	No	Data Source IDNote: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	No	Database nameNote: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	No	Database id Note: This field may return null, indicating that no valid value can be obtained.
InstanceId	String	No	Instance Id Note: This field may return null, indicating that no valid value can be obtained.
DatasourceType	Integer	No	Data source typeNote: This field may return null, indicating that no valid value can be obtained.
OriginDatabaseName	String	No	Database Original Name Note: This field may return null, indicating that no valid value can be obtained.
OriginSchemaName	String	No	Schema NameNote: This field may return null, indicating that no valid value can be obtained.
DsEnvType	Integer	No	0 or Not Returned. Undefined, 1. generation 2. development Note: This field may return null, indicating that no valid value can be obtained.

DatabaseMeta

Data Source Metadata

Used by actions: DescribeDatabaseMetas.

Name	Type	Description
ProjectId	String	Project IDNote: This field may return null, indicating that no valid value can be obtained.
MetastoreType	String	Technology Type Note: This field may return null, indicating that no valid value can be obtained.
DatasourceName	String	Data Source Name Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	Integer	Data Source IDNote: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	Project English Name Note: This field may return null, indicating that no valid value can be obtained.
Category	String	Data Source Category: Binding Engine, Binding Database, Available Values: DB, ENGINE Note: This field may return null, indicating that no valid value can be obtained.
Description	String	Data source description informationNote: This field may return null, indicating that no valid value can be obtained.
Instance	String	Instance ID of the data source engine, e.g., CDB Instance IDNote: This field may return null, indicating that no valid value can be obtained.
Region	String	Data Source Engine Region Note: This field may return null, indicating that no valid value can be obtained.
Status	Integer	Visibility of the data source, where 1 is visible and 0 is not visible. Default is 1Note: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	Database Name Note: This field may return null, indicating that no valid value can be obtained.
ProjectDisplayName	String	Project Chinese Name Note: This field may return null, indicating that no valid value can be obtained.
OwnerAccountName	String	Person in Charge Name Note: This field may return null, indicating that no valid value can be obtained.
DisplayName	String	Data Source Display Name Note: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	Database ID Note: This field may return null, indicating that no valid value can be obtained.
Catalog	String	Data Source Type: hive/mysql/hbase, etc. Note: This field may return null, indicating that no valid value can be obtained.
StorageSize	Integer	Storage Size in bytes Note: This field may return null, indicating that no valid value can be obtained.
StorageSizeWithUnit	String	Formatted Storage Size, with unit, e.g., 12B Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.

DatasourceBaseInfo

Data Source Object

Used by actions: DescribeDataSourceInfoList.

Name	Type	Description
DatabaseNames	Array of String	If the data source list is bound to a database, then it is the database nameNote: This field may return null, indicating that no valid value can be obtained.
Description	String	Data source description informationNote: This field may return null, indicating that no valid value can be obtained.
ID	Integer	Data Source ID
Instance	String	Instance ID of the data source engine, e.g., CDB Instance IDNote: This field may return null, indicating that no valid value can be obtained.
Name	String	Data Source Name, cannot be empty under the same SpaceName
Region	String	Region to which the data source engine belongs Note: This field may return null, indicating that no valid value can be obtained.
Type	String	Data Source Type: enumerated valuesNote: This field may return null, indicating that no valid value can be obtained.
ClusterId	String	Cluster ID to which the data source belongs Note: This field may return null, indicating that no valid value can be obtained.
Version	String	Version information of the data source Note: This field may return null, indicating that no valid value can be obtained.
ParamsString	String	Attached parameter information of the data source Params JSON string Note: This field may return null, indicating that no valid value can be obtained.
Category	String	Distinguish whether the data source type is a custom Definition source or a system source Note: This field may return null, indicating that no valid value can be obtained.

DependencyConfig

Dependency Configuration

Used by actions: ModifyTaskInfo.

Name	Type	Required	Description
DependConfType	String	Yes	Only five types of periodic execution dependency configurations: HOUR, DAY, WEEK, MONTH, YEAR, CRONTAB, MINUTE
SubordinateCyclicType	String	Yes	Dependency Configuration Subordinate Period Type, 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
DependencyStrategy	String	Yes	WAITING, waiting (default policy) EXECUTING: executing
ParentTask	TaskInnerInfo	No	Parent Task Information Note: This field may return null, indicating that no valid value can be obtained.
SonTask	TaskInnerInfo	No	Subtask Information Note: This field may return null, indicating that no valid value can be obtained.

DescribeApply

Application List

Used by actions: DescribeApproveList.

Name	Type	Description
Rows	Array of Apply	Application List Details
TotalPageNumber	Integer	Total Pagination Pages
TotalCount	Integer	Total Count
PageNumber	Integer	Page number
PageSize	Integer	Page size

DescribeBatchOperateTaskDTO

Batch Operation Task List

Used by actions: DescribeBatchOperateTask.

Name	Type	Required	Description
TaskId	String	No	Task IDNote: This field may return null, indicating that no valid value can be obtained.
TaskName	String	No	Task NameNote: This field may return null, indicating that no valid value can be obtained.
WorkflowId	String	No	Workflow Id Note: This field may return null, indicating that no valid value can be obtained.
WorkflowName	String	No	Workflow name Note: This field may return null, indicating that no valid value can be obtained.
Status	String	No	StatusNote: This field may return null, indicating that no valid value can be obtained.
TaskTypeId	Integer	No	Task IDNote: This field may return null, indicating that no valid value can be obtained.
TaskTypeDesc	String	No	Task TypeNote: This field may return null, indicating that no valid value can be obtained.
FolderName	String	No	Folder name Note: This field may return null, indicating that no valid value can be obtained.
FolderId	String	No	Folder IDNote: This field may return null, indicating that no valid value can be obtained.
InCharge	String	No	Owner Note: This field may return null, indicating that no valid value can be obtained.
Submit	Integer	No	Submitted? Note: This field may return null, indicating that no valid value can be obtained.
DataEngine	String	No	Engine: presto\SparkJob\SparkSql Note: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	No	Update timeNote: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Creation time Note: This field may return null, indicating that no valid value can be obtained.
CycleUnit	String	No	Cycle type Note: This field may return null, indicating that no valid value can be obtained.
ScheduleDesc	String	No	Scheduling plan Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	No	Data source ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceType	String	No	Data source typeNote: This field may return null, indicating that no valid value can be obtained.

DescribeBatchOperateTaskPage

Batch Operation Task List Pagination

Used by actions: DescribeBatchOperateTask.

Name	Type	Required	Description
PageCount	Integer	Yes	Total Number of Pages Note: This field may return null, indicating that no valid value can be obtained.
Items	Array of DescribeBatchOperateTaskDTO	Yes	ContentNote: This field may return null, indicating that no valid value can be obtained.
TotalCount	Integer	No	Total count Note: This field may return null, indicating that no valid value can be obtained.

DescribeFolderWorkflowListData

Folder Pagination Information

Used by actions: DescribeFolderWorkflowList.

Name	Type	Description
Items	Array of Workflow	Workflow Information List
TotalCount	Integer	Total number of items
PageNumber	Integer	Page Number
PageSize	Integer	Page Size

DiagnoseRep

Used by actions: DiagnosePro.

Name	Type	Required	Description
Content	Content	No	Diagnostic information content Note: This field may return null, indicating that no valid value can be obtained.
Table	Table	No	List of diagnostic result-related information Note: This field may return null, indicating that no valid value can be obtained.

DimensionCount

Dimension statistical business view

Used by actions: DescribeTemplateDimCount.

Name	Type	Required	Description
Count	Integer	No	Statistics value Note: This field may return null, indicating that no valid value can be obtained.
QualityDim	Integer	No	Dimension types 1: Accuracy, 2: Uniqueness, 3: Completeness, 4: Consistency, 5: Timeliness, 6: Validity Note: This field may return null, indicating that no valid value can be obtained.

DimensionScore

Dimension Scoring

Used by actions: DescribeDimensionScore.

Name	Type	Description
DimensionScoreList	Array of DimensionScoreInfo	Dimension Scoring List Note: This field may return null, indicating that no valid value can be obtained.

DimensionScoreInfo

Dimension Scoring Information

Used by actions: DescribeDimensionScore.

Name	Type	Description
Name	String	Dimension NameNote: This field may return null, indicating that no valid value can be obtained.
Weight	Float	WeightNote: This field may return null, indicating that no valid value can be obtained.
UserId	Integer	Setter ID Note: This field may return null, indicating that no valid value can be obtained.
UserName	String	Setter Name Note: This field may return null, indicating that no valid value can be obtained.
UpdateTime	Integer	Update Time Timestamp Note: This field may return null, indicating that no valid value can be obtained.
JoinTableNumber	Integer	Number of Evaluation Forms Involved
Score	Float	Scoring
UserIdStr	String	Set by User ID Str Note: This field may return null, indicating that no valid value can be obtained.

DlcDataGovernPolicy

Data Governance Configuration Items

Used by actions: GenHiveTableDDLSql.

Name	Type	Required	Description
RewriteDataPolicy	DlcRewriteDataInfo	No	Data Layout Governance Item Note: This field may return null, indicating that no valid value can be obtained.
ExpiredSnapshotsPolicy	DlcExpiredSnapshotsInfo	No	Snapshot Expiration Governance Item Note: This field may return null, indicating that no valid value can be obtained.
RemoveOrphanFilesPolicy	DlcRemoveOrphanFilesInfo	No	Remove Isolated Files Governance Item Note: This field may return null, indicating that no valid value can be obtained.
MergeManifestsPolicy	DlcMergeManifestsInfo	No	Merge Metadata Manifests Governance Item Note: This field may return null, indicating that no valid value can be obtained.
InheritDataBase	String	No	Integration Library Rules: default (Default Inheritance), none (No Inheritance) Note: This field may return null, indicating that no valid value can be obtained.
RuleType	String	No	Governance Rule Types, Customize: Custom Definition; Intelligence: Intelligent Governance Note: This field may return null, indicating that no valid value can be obtained.
GovernEngine	String	No	Governance Engine Note: This field may return null, indicating that no valid value can be obtained.

DlcExpiredSnapshotsInfo

Snapshot Expiration Governance Item

Used by actions: GenHiveTableDDLSql.

Name	Type	Required	Description
ExpiredSnapshotsEnable	String	No	Whether to enable snapshot expiration governance: enable, none Note: This field may return null, indicating that no valid value can be obtained.
Engine	String	No	Name of the engine used to run snapshot expiration governance Note: This field may return null, indicating that no valid value can be obtained.
RetainLast	Integer	No	Number of recent snapshots to retain Note: This field may return null, indicating that no valid value can be obtained.
BeforeDays	Integer	No	Snapshots expired before specified days Note: This field may return null, indicating that no valid value can be obtained.
MaxConcurrentDeletes	Integer	No	Number of parallel processes for cleaning up expired snapshots Note: This field may return null, indicating that no valid value can be obtained.
IntervalMin	Integer	No	Snapshot expiration governance run cycle, unit: minutes Note: This field may return null, indicating that no valid value can be obtained.

DlcMergeManifestsInfo

Merge metadata Manifests governance items

Used by actions: GenHiveTableDDLSql.

Name	Type	Required	Description
MergeManifestsEnable	String	No	Whether to enable merging metadata Manifests file governance items: enable, none Note: This field may return null, indicating that no valid value can be obtained.
Engine	String	No	Engine name used to run merging metadata Manifests file governance items Note: This field may return null, indicating that no valid value can be obtained.
IntervalMin	Integer	No	Merge Metadata Manifests file governance runtime cycle, in minutes Note: This field may return null, indicating that no valid value can be obtained.

DlcRemoveOrphanFilesInfo

Remove Isolated Files Governance Item

Used by actions: GenHiveTableDDLSql.

Name	Type	Required	Description
RemoveOrphanFilesEnable	String	No	Enable Removal of Isolated Files Governance Item: enable, none Note: This field may return null, indicating that no valid value can be obtained.
Engine	String	No	Engine Name for Running Removal of Isolated Files Governance Item Note: This field may return null, indicating that no valid value can be obtained.
BeforeDays	Integer	No	Remove Isolated Files Older Than Specified Days Note: This field may return null, indicating that no valid value can be obtained.
MaxConcurrentDeletes	Integer	No	Number of Concurrent Processes for Removing Isolated Files Note: This field may return null, indicating that no valid value can be obtained.
IntervalMin	Integer	No	Isolated Files Governance Run Cycle, in minutes Note: This field may return null, indicating that no valid value can be obtained.

DlcRewriteDataInfo

Data Layout Governance Item

Used by actions: GenHiveTableDDLSql.

Name	Type	Required	Description
RewriteDataEnable	String	No	Whether to enable data layout governance item: enable (start), disable (do not enable, default) Note: This field may return null, indicating that no valid value can be obtained.
Engine	String	No	Engine name used to run data layout governance item Note: This field may return null, indicating that no valid value can be obtained.
MinInputFiles	Integer	No	Number of files executed by the rearrangement task Note: This field may return null, indicating that no valid value can be obtained.
TargetFileSizeBytes	Integer	No	Data file size after data rearrangement, in bytes Note: This field may return null, indicating that no valid value can be obtained.
IntervalMin	Integer	No	Data layout governance runtime cycle, in minutes Note: This field may return null, indicating that no valid value can be obtained.

DrInstanceOpsDto

Trial Run Record

Used by actions: DescribeDrInstancePage.

Name	Type	Description
TaskSource	String	Task Source Note: This field may return null, indicating that no valid value can be obtained.
JobId	String	Orchestration Space jobId Note: This field may return null, indicating that no valid value can be obtained.
RecordId	Integer	Task Submission Record Id Note: This field may return null, indicating that no valid value can be obtained.
SonRecordId	Integer	Subtask record id Note: This field may return null, indicating that no valid value can be obtained.
InstanceId	String	Task instance Id Note: This field may return null, indicating that no valid value can be obtained.
TaskId	String	For orchestration space, the task id; for development space, the script id Note: This field may return null, indicating that no valid value can be obtained.
RemotePath	String	Script COS address Note: This field may return null, indicating that no valid value can be obtained.
ScriptContent	String	Trial run content Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Task submission time Note: This field may return null, indicating that no valid value can be obtained.
StartTime	String	Task start time Note: This field may return null, indicating that no valid value can be obtained.
Duration	String	Running duration (seconds) Note: This field may return null, indicating that no valid value can be obtained.
Status	String	Trial run status Note: This field may return null, indicating that no valid value can be obtained.
TaskName	String	For orchestration space, the task name; for development space, the script name Note: This field may return null, indicating that no valid value can be obtained.
SubmitUserName	String	Trial run submitter Note: This field may return null, indicating that no valid value can be obtained.
SubmitUserId	String	Trial run submitter userId Note: This field may return null, indicating that no valid value can be obtained.
TaskType	String	Task TypeNote: This field may return null, indicating that no valid value can be obtained.
HasResultSet	Boolean	Contains result set Note: This field may return null, indicating that no valid value can be obtained.

DrInstanceOpsDtoPage

Trial Run Record

Used by actions: DescribeDrInstancePage.

Name	Type	Description
TotalCount	Integer	Total Record Count Note: This field may return null, indicating that no valid value can be obtained.
Items	Array of DrInstanceOpsDto	Record List Note: This field may return null, indicating that no valid value can be obtained.

EventBatchCaseDTO

Event Continuous Time Instance Information

Used by actions: TriggerDsEvent.

Name	Type	Required	Description
CaseId	String	No	Event Instance ID
Name	String	No	Event
StartDimension	String	No	Event Trigger Start Time
CreationTs	String	No	Creation Time
ConsumerId	String	No	Consumer ID
Description	String	No	Description
EndDimension	String	No	Event Trigger End Time
EventSubType	String	No	Event Cycle

EventCaseAuditLogOptDto

Event Instance

Used by actions: DescribeEventCases.

Name	Type	Description
CaseId	String	Event Instance ID Note: This field may return null, indicating that no valid value can be obtained.
EventName	String	Event nameNote: This field may return null, indicating that no valid value can be obtained.
EventType	String	Event typeNote: This field may return null, indicating that no valid value can be obtained.
EventSubType	String	Event Split Type Note: This field may return null, indicating that no valid value can be obtained.
EventBroadcastType	String	Event Broadcast Type Note: This field may return null, indicating that no valid value can be obtained.
TTL	Integer	Event Instance TTL Note: This field may return null, indicating that no valid value can be obtained.
TimeUnit	String	Event Instance TTL Unit Note: This field may return null, indicating that no valid value can be obtained.
Dimension	String	Data Time Note: This field may return null, indicating that no valid value can be obtained.
Status	String	Event Instance Status Note: This field may return null, indicating that no valid value can be obtained.
EventTriggerTimestamp	String	Event Instance Trigger Timestamp Note: This field may return null, indicating that no valid value can be obtained.
LogTimestamp	String	Event Instance Consumption Timestamp Note: This field may return null, indicating that no valid value can be obtained.
Description	String	Event Instance Description Note: This field may return null, indicating that no valid value can be obtained.

EventCaseAuditLogVOCollection

Event Instance Pagination Query Results

Used by actions: DescribeEventCases.

Name	Type	Description
TotalCount	Integer	Total number of resultsNote: This field may return null, indicating that no valid value can be obtained.
TotalPage	Integer	Total PagesNote: This field may return null, indicating that no valid value can be obtained.
PageCount	Integer	Number of records on current page Note: This field may return null, indicating that no valid value can be obtained.
PageNumber	Integer	Page NumberNote: This field may return null, indicating that no valid value can be obtained.
PageSize	Integer	Page sizeNote: This field may return null, indicating that no valid value can be obtained.
Items	Array of EventCaseAuditLogOptDto	Pagination Data Note: This field may return null, indicating that no valid value can be obtained.

EventCaseConsumeLogOptDto

Event Consumption Record

Used by actions: DescribeEventConsumeTasks.

Name	Type	Description
ConsumeLogId	String	Consumer ID\nNote: This field may return null, indicating that no valid value can be obtained.
EventCaseId	String	Event Case ID\nNote: This field may return null, indicating that no valid value can be obtained.
ConsumerId	String	Consumer ID\nNote: This field may return null, indicating that no valid value can be obtained.
CreationTimestamp	String	Consumption Timestamp\nNote: This field may return null, indicating that no valid value can be obtained.
ConsumerDetail	TaskOpsDto	Task DetailsNote: This field may return null, indicating that no valid value can be obtained.

EventCaseConsumeLogOptDtoCollection

Event Consumption Task Record List

Used by actions: DescribeEventConsumeTasks.

Name	Type	Description
TotalCount	Integer	Total number of resultsNote: This field may return null, indicating that no valid value can be obtained.
TotalPage	Integer	Total Number of Pages Note: This field may return null, indicating that no valid value can be obtained.
PageCount	Integer	Number of Results on Current Page Note: This field may return null, indicating that no valid value can be obtained.
PageNumber	Integer	Page NumberNote: This field may return null, indicating that no valid value can be obtained.
PageSize	Integer	Number of items per pageNote: This field may return null, indicating that no valid value can be obtained.
Items	Array of EventCaseConsumeLogOptDto	Pagination Data Note: This field may return null, indicating that no valid value can be obtained.

EventCaseDTO

Event Instance Information

Used by actions: TriggerDsEvent.

Name	Type	Required	Description
CaseId	String	No	Event Instance ID
Name	String	No	Event
Dimension	String	No	Event Format
CreationTs	String	No	Creation Time
ConsumerId	String	No	Consumer ID
Description	String	No	Description

EventCaseOpsDto

Used by actions: DescribeEvent.

Name	Type	Description
CaseId	String	Case ID Note: This field may return null, indicating that no valid value can be obtained.
Name	String	Case Name Note: This field may return null, indicating that no valid value can be obtained.
Dimension	String	time format Note: This field may return null, indicating that no valid value can be obtained.
CreationTimestamp	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
ConsumerId	String	Consumer ID Note: This field may return null, indicating that no valid value can be obtained.
Description	String	DescriptionNote: This field may return null, indicating that no valid value can be obtained.

EventListenerOpsDto

Event Listener

Used by actions: DescribeEvent.

Name	Type	Description
EventName	String	Event nameNote: This field may return null, indicating that no valid value can be obtained.
Key	String	Keyword, if it is a task, then it is the Task ID Note: This field may return null, indicating that no valid value can be obtained.
Type	String	Trigger methodNote: This field may return null, indicating that no valid value can be obtained.
Properties	String	Event Attributes Note: This field may return null, indicating that no valid value can be obtained.
CreationTimestamp	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.

EventOpsDto

Event details

Used by actions: DescribeEvent.

Name	Type	Description
Name	String	Event nameNote: This field may return null, indicating that no valid value can be obtained.
EventType	String	Event typeNote: This field may return null, indicating that no valid value can be obtained.
EventSubType	String	Event Segmentation TypeNote: This field may return null, indicating that no valid value can be obtained.
EventBroadcastType	String	Event Broadcast TypeNote: This field may return null, indicating that no valid value can be obtained.
DimensionFormat	String	Data Time Format Note: This field may return null, indicating that no valid value can be obtained.
TimeToLive	Integer	UptimeNote: This field may return null, indicating that no valid value can be obtained.
TimeUnit	String	Lifetime Unit Note: This field may return null, indicating that no valid value can be obtained.
CreationTimestamp	String	Creation Timestamp Note: This field may return null, indicating that no valid value can be obtained.
Owner	String	Owner Note: This field may return null, indicating that no valid value can be obtained.
Properties	String	AttributeNote: This field may return null, indicating that no valid value can be obtained.
Description	String	DescriptionNote: This field may return null, indicating that no valid value can be obtained.
Listeners	Array of EventListenerOpsDto	Listener Note: This field may return null, indicating that no valid value can be obtained.
EventCases	Array of EventCaseOpsDto	Incident Case Note: This field may return null, indicating that no valid value can be obtained.

FailMessage

Error Handling Result Information

Used by actions: TriggerDsEvent.

Name	Type	Description
Key	String	Unique Data Identifier Note: This field may return null, indicating that no valid value can be obtained.
ErrorMessage	String	Failure Reason Note: This field may return null, indicating that no valid value can be obtained.

FieldConfig

Field Variable

Used by actions: CreateRule, DescribeRule, DescribeRules, ModifyRule.

Name	Type	Required	Description
FieldKey	String	No	Field key Note: This field may return null, indicating that no valid value can be obtained.
FieldValue	String	No	Field valueNote: This field may return null, indicating that no valid value can be obtained.
FieldDataType	String	No	Field Value Type Note: This field may return null, indicating that no valid value can be obtained.

Filter

Universal Filter

Used by actions: DescribeAlarmEvents, DescribeColumnsMeta, DescribeDataSourceInfoList, DescribeDataSourceList, DescribeDatabaseInfoList, DescribeDatabaseMetas, DescribeDimensionScore, DescribeFieldBasicInfo, DescribeIntegrationTasks, DescribeQualityScore, DescribeQualityScoreTrend, DescribeRuleGroupExecResultsByPage, DescribeRuleGroupsByPage, DescribeRuleTemplatesByPage, DescribeRulesByPage, DescribeTableBasicInfo, DescribeTableInfoList, DescribeTableMetas, DescribeTableQualityDetails, DescribeTaskAlarmRegulations.

Name	Type	Required	Description
Name	String	No	Filter Field Name
Values	Array of String	No	Filter Value List

FilterOptional

Universal Filter

Used by actions: DescribeApproveList.

Name	Type	Required	Description
Name	String	No	Filter Field Name
Values	Array of String	No	Filter Value List

FolderDsDto

Folder Attributes

Used by actions: FindAllFolder.

Name	Type	Required	Description
Id	String	No	Folder ID Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
Name	String	No	Folder NameNote: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	No	Project ID Note: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	No	Update timeNote: This field may return null, indicating that no valid value can be obtained.
ParentsFolderId	String	No	Parent Folder ID Note: This field may return null, indicating that no valid value can be obtained.
Total	Integer	No	Total Workflows Note: This field may return null, indicating that no valid value can be obtained.
Workflows	Array of WorkflowCanvasOpsDto	No	Workflow ListNote: This field may return null, indicating that no valid value can be obtained.
TotalFolders	Integer	No	Total Subfolders Note: This field may return null, indicating that no valid value can be obtained.
Folders	Array of FolderDsDto	No	Subfolder List Note: This field may return null, indicating that no valid value can be obtained.
FindType	String	No	Search typeNote: This field may return null, indicating that no valid value can be obtained.

FolderOpsDto

Folder Attributes

Used by actions: DescribeAllByFolderNew.

Name	Type	Required	Description
Id	String	No	Folder IDNote: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
Name	String	No	Folder NameNote: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	No	Project ID Note: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	No	Update timeNote: This field may return null, indicating that no valid value can be obtained.
ParentsFolderId	String	No	Parent Folder ID Note: This field may return null, indicating that no valid value can be obtained.
Total	Integer	No	Total Workflows Note: This field may return null, indicating that no valid value can be obtained.
Workflows	Array of WorkflowCanvasOpsDto	No	Workflow ListNote: This field may return null, indicating that no valid value can be obtained.
TotalFolders	Integer	No	Total Subfolders Note: This field may return null, indicating that no valid value can be obtained.
FoldersList	String	No	Subfolder List Note: This field may return null, indicating that no valid value can be obtained.
FindType	String	No	Search typeNote: This field may return null, indicating that no valid value can be obtained.

FunctionResource

Function Resource Information

Used by actions: SaveCustomFunction.

Name	Type	Required	Description
Path	String	Yes	Resource PathNote: This field may return null, indicating that no valid value can be obtained.
Name	String	Yes	NoNote: This field may return null, indicating that no valid value can be obtained.
Id	String	No	Resource Unique Identifier
Md5	String	No	Resource MD5 Value Note: This field may return null, indicating that no valid value can be obtained.
Type	String	No	Default is HDFS Note: This field may return null, indicating that no valid value can be obtained.

FunctionTypeOrKind

Function Type or Function Classification

Used by actions: DescribeFunctionKinds, DescribeFunctionTypes.

Name	Type	Description
Name	String	Name
ZhName	String	Function Classification English Name
EnName	String	Function Classification Chinese Name

FunctionVersion

Function Submission Version Information

Used by actions: DescribeOrganizationalFunctions.

Name	Type	Description
Tag	String	Version number: V0 V1 V2
UserId	String	Submitter ID
Type	String	Change Type: ADD, MODIFY
Comment	String	Remarks
Timestamp	String	Submission Time: UTC Seconds
UserName	String	Submitter Name Note: This field may return null, indicating that no valid value can be obtained.
Content	String	Version Information: json string format Note: This field may return null, indicating that no valid value can be obtained.

GeneralTaskParam

Spark SQL Configuration Parameters

Used by actions: ModifyWorkflowInfo.

Name	Type	Required	Description
Type	String	Yes	Common Task Parameter Type, for example: SPARK_SQL
Value	String	Yes	Common Task Parameter Content, parameters that directly apply to the task. Separate different parameters with; Split

InstanceApiOpsRequest

Instance Query Type

Used by actions: DagInstances, DescribeScheduleInstances, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances.

Name	Type	Required	Description
Instance	InstanceOpsDto	No	Single Query Condition
SortCol	String	No	Sort fields, currently includes: Retry Count, Instance Data Time, Runtime Duration
TaskIdList	Array of String	No	Task ID list
TaskNameList	Array of String	No	Fuzzy search by taskName
FolderList	Array of String	No	Folder List
Sort	String	No	Ascending or Descending
StateList	Array of Integer	No	Instance Status List
TaskTypeList	Array of Integer	No	Instance Type List
CycleList	Array of String	No	Cycle Type
OwnerList	Array of String	No	Person in Charge
DateFrom	String	No	Data Timestamp
DateTo	String	No	Data Timestamp
CreateTimeFrom	String	No	Instance Storage Time
CreateTimeTo	String	No	Instance Storage Time
StartFrom	String	No	Start Execution Time
StartTo	String	No	Start Execution Time
WorkflowIdList	Array of String	No	Belongs to Workflow
WorkflowNameList	Array of String	No	Fuzzy search by workflowName
Keyword	String	No	Keyword Fuzzy Search
SearchColumns	Array of String	No	searchColumns are the list of field names to search
ProjectId	String	No	Project ID
Limit	Integer	No	Limit
TaskTypeMap	Array of TaskTypeMap	No	Task Type Mapping Relationship, storing Task Type ID and Task Type Description Information
InstanceType	String	No	0 Supplementary Entry Type 1 Periodic Instance 2 Non-periodic Instance
DagDeal	Boolean	No	Whether it is DAG
DagType	String	No	1 Parent instance 2 Child instance
DagDependent	String	No	1 Self-Dependency 2 Task Dependency 3 All Dependencies
DagDepth	Integer	No	DAG Depth Default to 1, value range 1-6
TenantId	String	No	Tenant ID
DataTimeCycle	String	No	Inquiry based on Current Data Time or Next Data Time, default to Current Data Time
ExecutorGroupIdList	Array of String	No	Resource Group ID, multiple Resource Group IDs separated by English commas

InstanceCondition

Instance Retrieval Criteria

Used by actions: DescribeTaskRunHistory.

Name	Type	Required	Description
ExecutionSpace	String	No	Execution Type
ProductName	String	No	Task Product Type

InstanceDownloadLogInfo

Download Log Details

Used by actions: DescribeInstanceLogFile.

Name	Type	Description
FileName	String	File NameNote: This field may return null, indicating that no valid value can be obtained.
FileUrl	String	File URL Note: This field may return null, indicating that no valid value can be obtained.

InstanceLifeCycleOpsDto

Instance Lifecycle Details

Used by actions: DagInstances, DescribeScheduleInstances, DescribeTaskRunHistory, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances.

Name	Type	Required	Description
TaskId	String	No	Task ID Note: This field may return null, indicating that no valid value can be obtained.
CurRunDate	String	No	Data Timestamp Note: This field may return null, indicating that no valid value can be obtained.
LifeRound	Integer	No	Instance Lifecycle Count Note: This field may return null, indicating that no valid value can be obtained.
RunType	String	No	Run Type Rerun/Supplement/Periodic/Non-periodic Note: This field may return null, indicating that no valid value can be obtained.
Tries	Integer	No	Number of Reruns Note: This field may return null, indicating that no valid value can be obtained.
InstanceLifeDetailDtoList	Array of InstanceLifeDetailDto	No	Instance LifecycleNote: This field may return null, indicating that no valid value can be obtained.
RunnerState	String	No	Runner Status Note: This field may return null, indicating that no valid value can be obtained.
ErrorDesc	String	No	Error codeNote: This field may return null, indicating that no valid value can be obtained.
ErrorCodeLevel	String	No	Error Alert Level Note: This field may return null, indicating that no valid value can be obtained.
InstanceLogListOpsDto	InstanceLogInfo	No	Instance Log Summary Note: This field may return null, indicating that no valid value can be obtained.
InstanceState	String	No	Instance StatusNote: This field may return null, indicating that no valid value can be obtained.

InstanceLifeDetailDto

Instance Lifecycle Detail

Used by actions: DagInstances, DescribeScheduleInstances, DescribeTaskRunHistory, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances.

Name	Type	Required	Description
State	String	No	Instance StatusNote: This field may return null, indicating that no valid value can be obtained.
StartTime	String	No	Start Time of the State Note: This field may return null, indicating that no valid value can be obtained.
DetailState	String	No	Instance Lifecycle Phase Status Note: This field may return null, indicating that no valid value can be obtained.
EndTime	String	No	End Time of the State Note: This field may return null, indicating that no valid value can be obtained.

InstanceList

Offline operation and maintenance instance list

Used by actions: DescribeInstanceList.

Name	Type	Description
CostTime	String	Time Consumed Note: This field may return null, indicating that no valid value can be obtained.
CurRunDate	String	Data TimestampNote: This field may return null, indicating that no valid value can be obtained.
CycleType	String	Cycle type Note: This field may return null, indicating that no valid value can be obtained.
DoFlag	Integer	Whether to Supplement Note: This field may return null, indicating that no valid value can be obtained.
InCharge	String	Person in ChargeNote: This field may return null, indicating that no valid value can be obtained.
LastLog	String	LogNote: This field may return null, indicating that no valid value can be obtained.
SchedulerDesc	String	Scheduling plan Note: This field may return null, indicating that no valid value can be obtained.
StartTime	String	Start startup time Note: This field may return null, indicating that no valid value can be obtained.
State	String	Instance status 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 Note: This field may return null, indicating that no valid value can be obtained.
TaskId	String	Task IDNote: This field may return null, indicating that no valid value can be obtained.
TaskName	String	Task NameNote: This field may return null, indicating that no valid value can be obtained.
TryLimit	Integer	Number of trial runs Note: This field may return null, indicating that no valid value can be obtained.

InstanceLogInfo

Instance Log Summary Information

Used by actions: DagInstances, DescribeOpsInstanceLogList, DescribeScheduleInstances, DescribeTaskRunHistory, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances.

Name	Type	Required	Description
TaskId	String	No	Task IDNote: This field may return null, indicating that no valid value can be obtained.
CurRunDate	String	No	Data TimestampNote: This field may return null, indicating that no valid value can be obtained.
Tries	String	No	Number of trial runs Note: This field may return null, indicating that no valid value can be obtained.
LastUpdate	String	No	Log Update Time Note: This field may return null, indicating that no valid value can be obtained.
BrokerIp	String	No	Log Node Note: This field may return null, indicating that no valid value can be obtained.
FileSize	String	No	File sizeNote: This field may return null, indicating that no valid value can be obtained.
OriginFileName	String	No	File Name including Full Path Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Log Creation Time Note: This field may return null, indicating that no valid value can be obtained.
InstanceLogType	String	No	Instance Log Type, run: running; kill: termination Note: This field may return null, indicating that no valid value can be obtained.
TaskName	String	No	Task NameNote: This field may return null, indicating that no valid value can be obtained.
CostTime	String	No	Runtime Duration Note: This field may return null, indicating that no valid value can be obtained.
InstanceStatus	String	No	Instance Status COMPLETED completed FAILED failed retry EXPIRED failed RUNNING running Note: This field may return null, indicating that no valid value can be obtained.
CodeFileName	String	No	Instance Code File, absence indicates the corresponding code file does not exist, possibly due to the executor not being upgraded/certain types of tasks having no code. Note: This field may return null, indicating that no valid value can be obtained.
ExtensionInfo	Array of AttributeItemDTO	No	Extended Attributes Note: This field may return null, indicating that no valid value can be obtained.

InstanceLogInfoOpsDto

Instance log information details

Used by actions: DescribeInstanceLogDetail.

Name	Type	Description
LogInfo	String	Instance running log Note: This field may return null, indicating that no valid value can be obtained.
YarnLogInfo	Array of String	The Yarn log address submitted by the instance run Note: This field may return null, indicating that no valid value can be obtained.
DataLogInfo	String	The datax log generated by the instance run Note: This field may return null, indicating that no valid value can be obtained.
ThirdTaskRunLogInfo	String	Third-party Task Execution Log Note: This field may return null, indicating that no valid value can be obtained.
ThirdTaskLogUrlDesc	String	Third-party Task Log Link Description Note: This field may return null, indicating that no valid value can be obtained.
LineCount	Integer	Number of Log Lines Note: This field may return null, indicating that no valid value can be obtained.

InstanceLogList

Instance log information

Used by actions: DescribeInstanceLogList.

Name	Type	Description
TaskId	String	Task IDNote: This field may return null, indicating that no valid value can be obtained.
CurRunDate	String	Data TimestampNote: This field may return null, indicating that no valid value can be obtained.
Tries	String	Maximum number of retriesNote: This field may return null, indicating that no valid value can be obtained.
LastUpdate	String	Last Updated TimeNote: This field may return null, indicating that no valid value can be obtained.
BrokerIp	String	Node IP Note: This field may return null, indicating that no valid value can be obtained.
FileSize	String	File sizeNote: This field may return null, indicating that no valid value can be obtained.
OriginFileName	String	Original File Name Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
InstanceLogType	String	Instance Log Type Note: This field may return null, indicating that no valid value can be obtained.
TaskName	String	Task NameNote: This field may return null, indicating that no valid value can be obtained.
CostTime	String	Time Consumed Note: This field may return null, indicating that no valid value can be obtained.

InstanceNodeInfo

Query the current node information of the real-time task instance

Used by actions: DescribeRealTimeTaskInstanceNodeInfo.

Name	Type	Description
NodeType	String	Read from node SOURCE Write to node SINK Note: This field may return null, indicating that no valid value can be obtained.
NodeId	String	Node IDNote: This field may return null, indicating that no valid value can be obtained.
NodeName	String	Node nameNote: This field may return null, indicating that no valid value can be obtained.

InstanceOpsDto

Instance Operation Details

Used by actions: DagInstances, DescribeOpsMakePlanInstances, DescribeScheduleInstances, DescribeTaskRunHistory, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances.

Name	Type	Required	Description
TaskId	String	No	Task IDNote: This field may return null, indicating that no valid value can be obtained.
TaskName	String	No	Task NameNote: This field may return null, indicating that no valid value can be obtained.
WorkflowId	String	No	Workflow ID Note: This field may return null, indicating that no valid value can be obtained.
WorkflowName	String	No	Workflow nameNote: This field may return null, indicating that no valid value can be obtained.
InCharge	String	No	Owner Note: This field may return null, indicating that no valid value can be obtained.
CycleType	String	No	Cycle Type Note: This field may return null, indicating that no valid value can be obtained.
CurRunDate	String	No	Data Time Note: This field may return null, indicating that no valid value can be obtained.
NextCurDate	String	No	Next Data Time Note: This field may return null, indicating that no valid value can be obtained.
RunPriority	Integer	No	Running Priority Note: This field may return null, indicating that no valid value can be obtained.
TryLimit	Integer	No	Number of Attempts Note: This field may return null, indicating that no valid value can be obtained.
Tries	Integer	No	Current Running Times Note: This field may return null, indicating that no valid value can be obtained.
TotalRunNum	Integer	No	Total Retry Attempts Note: This field may return null, indicating that no valid value can be obtained.
DoFlag	Integer	No	Whether to Supplement Note: This field may return null, indicating that no valid value can be obtained.
RedoFlag	Integer	No	Whether it is a Retry Note: This field may return null, indicating that no valid value can be obtained.
State	String	No	Instance StatusNote: This field may return null, indicating that no valid value can be obtained.
RuntimeBroker	String	No	Run Node Note: This field may return null, indicating that no valid value can be obtained.
ErrorDesc	String	No	Reason for Failure Note: This field may return null, indicating that no valid value can be obtained.
TaskType	TaskTypeOpsDto	No	Task TypeNote: This field may return null, indicating that no valid value can be obtained.
DependenceFulfillTime	String	No	Dependency Judgment Completion Time Note: This field may return null, indicating that no valid value can be obtained.
FirstDependenceFulfillTime	String	No	First Dependency Judgment Pass Time Note: This field may return null, indicating that no valid value can be obtained.
FirstStartTime	String	No	Initial startup time Note: This field may return null, indicating that no valid value can be obtained.
StartTime	String	No	Start startup time Note: This field may return null, indicating that no valid value can be obtained.
EndTime	String	No	Operation completion time Note: This field may return null, indicating that no valid value can be obtained.
CostTime	String	No	Time Consumed Note: This field may return null, indicating that no valid value can be obtained.
CostMillisecond	Integer	No	Elapsed time (ms) Note: This field may return null, indicating that no valid value can be obtained.
MaxCostTime	Integer	No	Maximum operation duration Note: This field may return null, indicating that no valid value can be obtained.
MinCostTime	Integer	No	Minimum operation duration Note: This field may return null, indicating that no valid value can be obtained.
AvgCostTime	Float	No	Average operation duration Note: This field may return null, indicating that no valid value can be obtained.
LastLog	String	No	Recent logs Note: This field may return null, indicating that no valid value can be obtained.
SchedulerDateTime	String	No	Scheduling Time Note: This field may return null, indicating that no valid value can be obtained.
LastSchedulerDateTime	String	No	Last scheduling time Note: This field may return null, indicating that no valid value can be obtained.
LastUpdate	String	No	Last update event Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
DependencyRel	String	No	Branch, Dependency Relationship and,or Note: This field may return null, indicating that no valid value can be obtained.
ExecutionSpace	String	No	Execution space Note: This field may return null, indicating that no valid value can be obtained.
IgnoreEvent	Boolean	No	Ignore events Note: This field may return null, indicating that no valid value can be obtained.
VirtualFlag	Boolean	No	Virtual Task Instance Note: This field may return null, indicating that no valid value can be obtained.
FolderId	String	No	Folder ID Note: This field may return null, indicating that no valid value can be obtained.
FolderName	String	No	Folder Name Note: This field may return null, indicating that no valid value can be obtained.
SonList	String	No	Recursive Instance Information Note: This field may return null, indicating that no valid value can be obtained.
ProductName	String	No	Product Business Name Note: This field may return null, indicating that no valid value can be obtained.
ResourceGroup	String	No	Resource Group Note: This field may return null, indicating that no valid value can be obtained.
ResourceInstanceId	String	No	Resource Group Specified Execution Node Note: This field may return null, indicating that no valid value can be obtained.
YarnQueue	String	No	Resource Queue Note: This field may return null, indicating that no valid value can be obtained.
SchedulerDesc	String	No	Scheduling Plan Note: This field may return null, indicating that no valid value can be obtained.
FirstSubmitTime	String	No	Latest Submission Time Note: This field may return null, indicating that no valid value can be obtained.
FirstRunTime	String	No	First Execution Time Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	No	Project ID Note: This field may return null, indicating that no valid value can be obtained.
ProjectIdent	String	No	Project Identifier Note: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	No	Project nameNote: This field may return null, indicating that no valid value can be obtained.
TenantId	String	No	Tenant ID Note: This field may return null, indicating that no valid value can be obtained.
InstanceKey	String	No	Instance Identifier Note: This field may return null, indicating that no valid value can be obtained.
ExecutorGroupId	String	No	Resource Group ID Note: This field may return null, indicating that no valid value can be obtained.
ExecutorGroupName	String	No	Resource Group Name Note: This field may return null, indicating that no valid value can be obtained.
RelatedInstanceList	Array of InstanceOpsDto	No	Associated Instance Information. Note: This field may return null, indicating that no valid value can be obtained.
RelatedInstanceSize	Integer	No	Associated Instance Information Quantity, not strongly associated with RelatedInstanceList. Note: This field may return null, indicating that no valid value can be obtained.
OwnerId	String	No	ownerId Note: This field may return null, indicating that no valid value can be obtained.
UserId	String	No	User ID Note: This field may return null, indicating that no valid value can be obtained.
InstanceLifeCycleOpsDto	InstanceLifeCycleOpsDto	No	Instance LifecycleNote: This field may return null, indicating that no valid value can be obtained.
RetryAttempts	Integer	No	Automatic Retry Attempts Note: This field may return null, indicating that no valid value can be obtained.
DeletedFatherList	Array of String	No	Urgently Removed Dependency Parent Instance List Note: This field may return null, indicating that no valid value can be obtained.
CirculateInstanceList	Array of InstanceOpsDto	No	Cyclic Dependency Associated Instances Note: This field may return null, indicating that no valid value can be obtained.

InstanceOpsInfoPage

Task Execution History Pagination Record

Used by actions: DescribeTaskRunHistory.

Name	Type	Description
TotalCount	Integer	Number of recordsNote: This field may return null, indicating that no valid value can be obtained.
Items	Array of InstanceOpsDto	Record list Note: This field may return null, indicating that no valid value can be obtained.

InstanceSearchCondition

Instance Retrieval Criteria

Used by actions: DescribeTaskRunHistory.

Name	Type	Required	Description
CycleList	Array of String	No	Task Scheduling Cycle Type
DateFrom	String	No	Start time
DateTo	String	No	Expire Time
Instance	InstanceCondition	No	Instance Filtering Conditions
Keyword	String	No	Fuzzy Query Keywords
Sort	String	No	Sorting Method
SortCol	String	No	Sort Fields
StateList	Array of String	No	Instance Status Type

InstanceStatisticInfo

Operation and Maintenance Dashboard Instance Status Statistics and Instance Status Trend

Used by actions: DescribeStatisticInstanceStatusTrendOps.

Name	Type	Description
CountList	Array of Integer	Instance Status Trend Statistics Note: This field may return null, indicating that no valid value can be obtained.
TimeList	Array of String	Instance Status Trend Time Segmentation Note: This field may return null, indicating that no valid value can be obtained.
InstanceStatus	String	Instance Status Identification: WAITING_RUNNING, KILLING, FAILED, FAILED_TRYING, SUCCEED, respectively indicate waiting for execution, terminating, failed, trying again, successful, used for Instance Status Distribution and Instance Status Trend
InstanceCount	Integer	Used for Instance Status Distribution Count
ShowTime	String	Current Display Time Note: This field may return null, indicating that no valid value can be obtained.
ReportTime	String	1 Note: This field may return null, indicating that no valid value can be obtained.
Count	Integer	1 Note: This field may return null, indicating that no valid value can be obtained.

IntegrationInstanceLog

Instance log information

Used by actions: DescribeInstanceLog.

Name	Type	Description
LogInfo	String	Task log information Note: This field may return null, indicating that no valid value can be obtained.

IntegrationNodeDetail

Integration Node Details

Used by actions: ModifyTaskScript.

Name	Type	Required	Description
Name	String	No	Integration Node Name
NodeType	String	No	Integration Node Type
DataSourceType	String	No	Node Data Source Type
Description	String	No	Node Description Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	No	Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
Config	Array of RecordField	No	Node Configuration Information Note: This field may return null, indicating that no valid value can be obtained.
ExtConfig	Array of RecordField	No	Node Extension Configuration Information Note: This field may return null, indicating that no valid value can be obtained.
Schema	Array of IntegrationNodeSchema	No	Node Schema Note: This field may return null, indicating that no valid value can be obtained.
NodeMapping	IntegrationNodeMapping	No	Node Mapping Note: This field may return null, indicating that no valid value can be obtained.
OwnerUin	String	No	owner uin

IntegrationNodeInfo

Integrated Task Node

Used by actions: CreateIntegrationNode, CreateIntegrationTask, DescribeIntegrationNode, DescribeIntegrationTask, DescribeIntegrationTasks, DescribeIntegrationVersionNodesInfo, ModifyIntegrationNode, ModifyIntegrationTask.

Name	Type	Required	Description
Id	String	No	Integration Node ID Note: This field may return null, indicating that no valid value can be obtained.
TaskId	String	No	Task ID of the Integrated Node
Name	String	No	Integration Node Name
NodeType	String	No	Integration Node Type, INPUT: Input Node, OUTPUT: Output Node
DataSourceType	String	No	Node Data Source Type: 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
Description	String	No	Node Description Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	No	Data source IDNote: This field may return null, indicating that no valid value can be obtained.
Config	Array of RecordField	No	Node Configuration Information Note: This field may return null, indicating that no valid value can be obtained.
ExtConfig	Array of RecordField	No	Node Extension Configuration Information Note: This field may return null, indicating that no valid value can be obtained.
Schema	Array of IntegrationNodeSchema	No	Node Schema Note: This field may return null, indicating that no valid value can be obtained.
NodeMapping	IntegrationNodeMapping	No	Node Mapping Note: This field may return null, indicating that no valid value can be obtained.
AppId	String	No	Belonging User AppId, Display Fields Non-passed
ProjectId	String	No	Project ID
CreatorUin	String	No	Creator UIN, Display Fields Non-passed Note: This field may return null, indicating that no valid value can be obtained.
OperatorUin	String	No	Operator UIN, Display Fields Non-passed Note: This field may return null, indicating that no valid value can be obtained.
OwnerUin	String	No	owner uin Display Fields Non-passed
CreateTime	String	No	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	No	Update timeNote: This field may return null, indicating that no valid value can be obtained.

IntegrationNodeMapping

Integrated Node Mapping

Name	Type	Required	Description
SourceId	String	No	Source Node ID
SinkId	String	No	Target Node ID
SourceSchema	Array of IntegrationNodeSchema	No	Source Node Schema Note: This field may return null, indicating that no valid value can be obtained.
SchemaMappings	Array of IntegrationNodeSchemaMapping	No	Node Schema Mapping Note: This field may return null, indicating that no valid value can be obtained.
ExtConfig	Array of RecordField	No	Node Mapping Extended Information Note: This field may return null, indicating that no valid value can be obtained.

IntegrationNodeSchema

Integrated Node Schema

Name	Type	Required	Description
Id	String	Yes	Schema ID Random Unique
Name	String	Yes	Schema Name
Type	String	Yes	Schema Type
Value	String	No	Schema Value Note: This field may return null, indicating that no valid value can be obtained.
Properties	Array of RecordField	No	Schema Extended Attributes Note: This field may return null, indicating that no valid value can be obtained.
Alias	String	No	Schema Alias Note: This field may return null, indicating that no valid value can be obtained.
Comment	String	No	Field Remarks Note: This field may return null, indicating that no valid value can be obtained.

IntegrationNodeSchemaMapping

Integrated Node Schema Mapping

Name	Type	Required	Description
SourceSchemaId	String	Yes	Task Node Source Schema ID
SinkSchemaId	String	Yes	Task Node Target Schema ID

IntegrationStatisticsTrendResult

DataInLong Dashboard trend chart statistical results

Used by actions: DescribeIntegrationStatisticsInstanceTrend, DescribeIntegrationStatisticsRecordsTrend, DescribeIntegrationStatisticsTaskStatusTrend.

Name	Type	Description
StatisticName	Array of String	Statistical Attribute Name Note: This field may return null, indicating that no valid value can be obtained.
StatisticValue	Array of Integer	Statistical Value Note: This field may return null, indicating that no valid value can be obtained.
StatisticType	String	Statistical Item Note: This field may return null, indicating that no valid value can be obtained.

IntegrationTaskInfo

Integration Tasks

Used by actions: CreateIntegrationTask, DescribeIntegrationTask, DescribeIntegrationTasks, ModifyIntegrationTask.

Name	Type	Required	Description
TaskName	String	No	Task Name
Description	String	No	Task Description Note: This field may return null, indicating that no valid value can be obtained.
SyncType	Integer	No	Synchronization Type 1. Solution (Whole Database Migration), 2. Single Table Synchronization
TaskType	Integer	No	201. Real-time, 202. Offline
WorkflowId	String	No	Workflow ID of Task Note: This field may return null, indicating that no valid value can be obtained.
TaskId	String	No	Task IDNote: This field may return null, indicating that no valid value can be obtained.
ScheduleTaskId	String	No	Task Scheduling ID (oceanus or us etc. Job ID), not a mandatory field Note: This field may return null, indicating that no valid value can be obtained.
TaskGroupId	String	No	InLong Task ID Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	No	Project IDNote: This field may return null, indicating that no valid value can be obtained.
CreatorUin	String	No	Creator UIN Note: This field may return null, indicating that no valid value can be obtained.
OperatorUin	String	No	Operator UIN Note: This field may return null, indicating that no valid value can be obtained.
OwnerUin	String	No	owner uin Note: This field may return null, indicating that no valid value can be obtained.
AppId	String	No	Application ID Note: This field may return null, indicating that no valid value can be obtained.
Status	Integer	No	1: not started \| 2: In operation \| 3: Running \| 4: Suspension \| 5: Task Stopping \| 6: Stop \| 7: Execution Failure \| 20: Abnormal \| 21: Unknown \| Note: This field may return null, indicating that no valid value can be obtained.
Nodes	Array of IntegrationNodeInfo	No	Node list Note: This field may return null, indicating that no valid value can be obtained.
ExecutorId	String	No	Execution Resource ID Note: This field may return null, indicating that no valid value can be obtained.
Config	Array of RecordField	No	Task configuration information Note: This field may return null, indicating that no valid value can be obtained.
ExtConfig	Array of RecordField	No	Task extension configuration information Note: This field may return null, indicating that no valid value can be obtained.
ExecuteContext	Array of RecordField	No	Task execution context information Note: This field may return null, indicating that no valid value can be obtained.
Mappings	Array of IntegrationNodeMapping	No	Node Mapping Note: This field may return null, indicating that no valid value can be obtained.
TaskMode	String	No	Task configuration mode, 0: Canvas 1: Form 3: Script Note: This field may return null, indicating that no valid value can be obtained.
Incharge	String	No	Person in ChargeNote: This field may return null, indicating that no valid value can be obtained.
OfflineTaskAddEntity	OfflineTaskAddParam	No	Offline new parameters Note: This field may return null, indicating that no valid value can be obtained.
ExecutorGroupName	String	No	group name Note: This field may return null, indicating that no valid value can be obtained.
InLongManagerUrl	String	No	inlong manager url Note: This field may return null, indicating that no valid value can be obtained.
InLongStreamId	String	No	stream id Note: This field may return null, indicating that no valid value can be obtained.
InLongManagerVersion	String	No	version Note: This field may return null, indicating that no valid value can be obtained.
DataProxyUrl	Array of String	No	inlong dataproxy url Note: This field may return null, indicating that no valid value can be obtained.
Submit	Boolean	No	Whether the task version has been submitted for operation and maintenance Note: This field may return null, indicating that no valid value can be obtained.
InputDatasourceType	String	No	Data Source Type: 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 Note: This field may return null, indicating that no valid value can be obtained.
OutputDatasourceType	String	No	Data Source Type: 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 Note: This field may return null, indicating that no valid value can be obtained.
NumRecordsIn	Integer	No	Number of reads Note: This field may return null, indicating that no valid value can be obtained.
NumRecordsOut	Integer	No	Number of writes Note: This field may return null, indicating that no valid value can be obtained.
ReaderDelay	Float	No	Read latency Note: This field may return null, indicating that no valid value can be obtained.
NumRestarts	Integer	No	Restart Times Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	No	Task Update Time Note: This field may return null, indicating that no valid value can be obtained.
LastRunTime	String	No	Last task run time Note: This field may return null, indicating that no valid value can be obtained.
StopTime	String	No	Task stop time Note: This field may return null, indicating that no valid value can be obtained.
HasVersion	Boolean	No	Job Submitted? Note: This field may return null, indicating that no valid value can be obtained.
Locked	Boolean	No	Is the task locked? Note: This field may return null, indicating that no valid value can be obtained.
Locker	String	No	Task Locked By Note: This field may return null, indicating that no valid value can be obtained.
RunningCu	Float	No	Resource Consumption Note: This field may return null, indicating that no valid value can be obtained.
TaskAlarmRegularList	Array of String	No	Associated Alert Rules for the Task Note: This field may return null, indicating that no valid value can be obtained.
SwitchResource	Integer	No	Real-time task resource layering status: 0:Ongoing,1:Success,2:Failed Note: This field may return null, indicating that no valid value can be obtained.
ReadPhase	Integer	No	Real-time task reading phase: 0:Full Full,1:Partial Full,2:Full Incremental Note: This field may return null, indicating that no valid value can be obtained.
InstanceVersion	Integer	No	Real-time Task Version Number Note: This field may return null, indicating that no valid value can be obtained.
ArrangeSpaceTaskId	String	No	Offline task imported into orchestration space Task ID Note: This field may return null, indicating that no valid value can be obtained.
OfflineTaskStatus	Integer	No	Offline Task Status Differentiation 1.Not Submitted 2.Submitted 3.Exported Note: This field may return null, indicating that no valid value can be obtained.

LineageParamRecord

Lineage Parameter Record

Used by actions: DescribeColumnLineage, DescribeTableLineage, DescribeTableLineageInfo.

Name	Type	Required	Description
Name	String	Yes	Field name
Value	String	Yes	Field valueNote: This field may return null, indicating that no valid value can be obtained.

LinkOpsDto

Details of the task dependency edge

Used by actions: DescribeAllByFolderNew, DescribeDependTaskLists, DescribeSuccessorOpsTaskInfos, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId.

Name	Type	Required	Description
Id	String	Yes	Edge ID Note: This field may return null, indicating that no valid value can be obtained.
LinkKey	String	Yes	Edge key Note: This field may return null, indicating that no valid value can be obtained.
TaskFrom	String	Yes	Source node of the edge Note: This field may return null, indicating that no valid value can be obtained.
TaskTo	String	Yes	Target node of the edge Note: This field may return null, indicating that no valid value can be obtained.
InCharge	String	Yes	Person in ChargeNote: This field may return null, indicating that no valid value can be obtained.
LinkDependencyType	String	Yes	Dependency Relationship Between Parent and Child TasksNote: This field may return null, indicating that no valid value can be obtained.
Offset	String	Yes	Dependency offset between parent and child tasks Note: This field may return null, indicating that no valid value can be obtained.
LinkType	String	Yes	Type of edge Note: This field may return null, indicating that no valid value can be obtained.
WorkflowId	String	Yes	Workflow IDNote: This field may return null, indicating that no valid value can be obtained.

LogContent

Real-time Task Log Content

Used by actions: TaskLog.

Name	Type	Description
Time	Integer	Log Timestamp, in milliseconds Note: This field may return null, indicating that no valid value can be obtained.
PkgId	String	Log Package ID Note: This field may return null, indicating that no valid value can be obtained.
Log	String	Log content

LogContentInfo

Log Content Entity

Used by actions: DescribeStreamTaskLogList.

Name	Type	Description
Log	String	Log contentNote: This field may return null, indicating that no valid value can be obtained.
PkgId	String	Log group Id\nNote: This field may return null, indicating that no valid value can be obtained.
PkgLogId	String	Log ID Note: This field may return null, indicating that no valid value can be obtained.
Time	Integer	TimeNote: This field may return null, indicating that no valid value can be obtained.
ContainerName	String	Container Name the Log Belongs To Note: This field may return null, indicating that no valid value can be obtained.

MakePlanInstanceOpsDtoCollection

Supplementary Plan Instance Collection

Used by actions: DescribeOpsMakePlanInstances.

Name	Type	Description
TotalCount	Integer	Total Record Count Note: This field may return null, indicating that no valid value can be obtained.
TotalPage	Integer	Total Number of Pages Note: This field may return null, indicating that no valid value can be obtained.
PageCount	Integer	Number of Records on Current Page Note: This field may return null, indicating that no valid value can be obtained.
PageNumber	Integer	Page NumberNote: This field may return null, indicating that no valid value can be obtained.
PageSize	Integer	Page SizeNote: This field may return null, indicating that no valid value can be obtained.
Items	Array of InstanceOpsDto	Record List Note: This field may return null, indicating that no valid value can be obtained.

MakePlanOpsDto

Supplemental Plan

Used by actions: DescribeOpsMakePlans.

Name	Type	Description
PlanId	String	Supplement Plan ID Note: This field may return null, indicating that no valid value can be obtained.
MakeName	String	Supplement Plan Name Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	Project ID Note: This field may return null, indicating that no valid value can be obtained.
CheckParent	Boolean	Check Parent Task Status for Supplement Note: This field may return null, indicating that no valid value can be obtained.
SameSelfDependType	Boolean	Use Original Task Self-Dependency Configuration Note: This field may return null, indicating that no valid value can be obtained.
ParallelNum	Integer	Concurrency, effective when SameSelfDependType is false Note: This field may return null, indicating that no valid value can be obtained.
SameCycle	Boolean	Modify Supplement Instance Generation Period Note: This field may return null, indicating that no valid value can be obtained.
SourceTaskCycle	String	Scheduling Cycle Conversion Method - Original Cycle Type Note: This field may return null, indicating that no valid value can be obtained.
TargetTaskCycle	String	Scheduling Cycle Conversion Method - Target Cycle Type Note: This field may return null, indicating that no valid value can be obtained.
TargetTaskAction	Integer	Scheduling Cycle Conversion Method - Specific Time for Target Cycle Type Note: This field may return null, indicating that no valid value can be obtained.
MapParamList	Array of StrToStrMap	Supplement Instance From Definition Parameters Note: This field may return null, indicating that no valid value can be obtained.
CreatorId	String	Creator ID Note: This field may return null, indicating that no valid value can be obtained.
Creator	String	Creator Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
TaskIdList	Array of String	Supplementary Task ID Collection Note: This field may return null, indicating that no valid value can be obtained.
MakeDatetimeList	Array of CreateMakeDatetimeInfo	Supplementary Plan Date Range Note: This field may return null, indicating that no valid value can be obtained.
Remark	String	Supplementary Plan Description Note: This field may return null, indicating that no valid value can be obtained.
SchedulerResourceGroup	String	Supplementary Designated Scheduling Resource Group (ID) Note: This field may return null, indicating that no valid value can be obtained.
SchedulerResourceGroupName	String	Supplementary Scheduled Resource Group Name Note: This field may return null, indicating that no valid value can be obtained.
IntegrationResourceGroup	String	Supplementary Designated Integration Resource Group (ID) Note: This field may return null, indicating that no valid value can be obtained.
IntegrationResourceGroupName	String	Supplementary Integrated Resource Group Name Note: This field may return null, indicating that no valid value can be obtained.
TaskCount	Integer	Number of Supplementary Plan Tasks Note: This field may return null, indicating that no valid value can be obtained.
CompletePercent	Integer	Percentage of Supplementary Plan Instances Completed Note: This field may return null, indicating that no valid value can be obtained.
SuccessPercent	Integer	Percentage of Supplementary Plan Instances Successful Note: This field may return null, indicating that no valid value can be obtained.
CheckParentType	String	Check Parent Task Type for Supplementary. Value range: NONE: Do not check any ALL: Check all upstream parent tasks MAKE_SCOPE: Check only within the selected tasks of (the current supplementary plan) Note: This field may return null, indicating that no valid value can be obtained.

MakePlanOpsDtoCollection

Supplementary plan collection

Used by actions: DescribeOpsMakePlans.

Name	Type	Description
TotalCount	Integer	Total Record Count Note: This field may return null, indicating that no valid value can be obtained.
TotalPage	Integer	Total number of records Note: This field may return null, indicating that no valid value can be obtained.
PageCount	Integer	Number of records on current page Note: This field may return null, indicating that no valid value can be obtained.
PageNumber	Integer	Page Number Note: This field may return null, indicating that no valid value can be obtained.
PageSize	Integer	Page Size Note: This field may return null, indicating that no valid value can be obtained.
Items	Array of MakePlanOpsDto	Record List Note: This field may return null, indicating that no valid value can be obtained.

MakePlanTaskOpsDto

Supplemental Plan Tasks

Used by actions: DescribeOpsMakePlanTasks.

Name	Type	Description
TaskBaseInfo	TaskOpsDto	Basic task informationNote: This field may return null, indicating that no valid value can be obtained.
InstanceCount	Integer	Supplemental instances already generated for this task Note: This field may return null, indicating that no valid value can be obtained.
CompletePercent	Integer	Supplementary Task Instance Completion Percentage Note: This field may return null, indicating that no valid value can be obtained.
SuccessPercent	Integer	Supplementary Task Instance Success Percentage Note: This field may return null, indicating that no valid value can be obtained.
InstanceTotalCount	Integer	Estimated Total Number of Instances Generated, as generation is asynchronous, -1 indicates instances are not fully generated yet Note: This field may return null, indicating that no valid value can be obtained.

MakePlanTaskOpsDtoCollection

Supplementary Plan Task Collection

Used by actions: DescribeOpsMakePlanTasks.

Name	Type	Description
TotalCount	Integer	Total Record Count Note: This field may return null, indicating that no valid value can be obtained.
TotalPage	Integer	Total Number of Pages Note: This field may return null, indicating that no valid value can be obtained.
PageCount	Integer	Number of Records on Current Page Note: This field may return null, indicating that no valid value can be obtained.
PageNumber	Integer	Page Number Note: This field may return null, indicating that no valid value can be obtained.
PageSize	Integer	Page Size Note: This field may return null, indicating that no valid value can be obtained.
Items	Array of MakePlanTaskOpsDto	Record List Note: This field may return null, indicating that no valid value can be obtained.

OfflineInstance

Offline Instance

Used by actions: GetOfflineDIInstanceList, GetOfflineInstanceList.

Name	Type	Description
CreateUin	String	Create Account Sub UIN Note: This field may return null, indicating that no valid value can be obtained.
OperatorUin	String	Operate Account Sub UIN Note: This field may return null, indicating that no valid value can be obtained.
OwnerUin	String	Primary AccountNote: This field may return null, indicating that no valid value can be obtained.
AppId	String	AccountsNote: This field may return null, indicating that no valid value can be obtained.
WorkspaceId	String	Project ID Note: This field may return null, indicating that no valid value can be obtained.
TaskId	String	Task ID
CurRunDate	String	Data Timestamp
IssueId	String	Issuance time
InlongTaskId	String	Resource Group ID Issuance, not an input item Note: This field may return null, indicating that no valid value can be obtained.
ResourceGroup	String	Resource Group Note: This field may return null, indicating that no valid value can be obtained.
TaskRunType	Integer	Task Type (1 Debugging, 2 Scheduled Execution)
State	String	Instance status 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
StartTime	String	Start TimeNote: This field may return null, indicating that no valid value can be obtained.
EndTime	String	End timeNote: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	Last Updated Time
InstanceKey	String	Unique Key Note: This field may return null, indicating that no valid value can be obtained.

OfflineTaskAddParam

New Parameter for Offline Task

Used by actions: CreateIntegrationTask, DescribeIntegrationTask, DescribeIntegrationTasks, ModifyIntegrationTask.

Name	Type	Required	Description
WorkflowName	String	Yes	Name
DependencyWorkflow	String	Yes	Dependencies: yes, no
StartTime	String	Yes	Task Start Data Time. Not Empty. Default to Current Time
EndTime	String	Yes	Task End Data Time. Not Empty. Default to Current Time
CycleType	Integer	Yes	Cycle Type. One-time task: 6, Minute Task: 1, Hourly task: 2, Daily Task: 3, Weekly Task: 4, Monthly Task: 5, Cron task: 0
CycleStep	Integer	Yes	Interval, optional, default is 1. Not null. Default is 1
DelayTime	Integer	Yes	Delayed Execution Time, in minutes
CrontabExpression	String	Yes	Task cron expression, used only for cron tasks, else defaults to empty Note: This field may return null, indicating that no valid value can be obtained.
RetryWait	Integer	Yes	Retry Wait
Retriable	Integer	Yes	Is Retry Allowed
TryLimit	Integer	Yes	Retry Limit
RunPriority	Integer	Yes	Priority
ProductName	String	Yes	Product
SelfDepend	Integer	Yes	1 Ordered Serialization, one at a time, queued orderly 2 Unordered Serial, one at a time, not queued serial 3 Parallel, multiple at a time parallel
TaskAction	String	No	Time Specification, such as 1,3 for monthly tasks, enter 1,3. Not empty. Default "" Monthly Task: for specific days like "1,3", specifying end of month as "L" alone, cannot be mixed with specific dates Note: This field may return null, indicating that no valid value can be obtained.
ExecutionEndTime	String	No	Scheduled Execution End Time Note: This field may return null, indicating that no valid value can be obtained.
ExecutionStartTime	String	No	Scheduled Execution Start Time Note: This field may return null, indicating that no valid value can be obtained.
TaskAutoSubmit	Boolean	No	Is Auto-submit Note: This field may return null, indicating that no valid value can be obtained.
InstanceInitStrategy	String	No	Instance Generation Method, T_PLUS_0 schedule task on the same day / T_PLUS_1 schedule task the next day Note: This field may return null, indicating that no valid value can be obtained.

OperationOpsDto

Operation Result

Used by actions: BatchStopWorkflowsByIds, DeleteWorkflowById, FreezeTasksByWorkflowIds, RunTasksByMultiWorkflow.

Name	Type	Description
Result	Boolean	Operation Success Note: This field may return null, indicating that no valid value can be obtained.
ResultMsg	String	Operation Result Details Note: This field may return null, indicating that no valid value can be obtained.
ErrorId	String	Operation Failure Type Note: This field may return null, indicating that no valid value can be obtained.
ErrorDesc	String	Operation Failure Description Note: This field may return null, indicating that no valid value can be obtained.

OpsTaskCanvasDto

Task Information

Used by actions: DescribeDependOpsTasks.

Name	Type	Description
TaskId	String	Task IDNote: This field may return null, indicating that no valid value can be obtained.
TaskName	String	Task NameNote: This field may return null, indicating that no valid value can be obtained.
WorkflowId	String	Workflow IDNote: This field may return null, indicating that no valid value can be obtained.
WorkflowName	String	Workflow nameNote: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	Project nameNote: This field may return null, indicating that no valid value can be obtained.
ProjectIdent	String	Project IdentifierNote: This field may return null, indicating that no valid value can be obtained.
Status	String	Task status, 'Y', 'F', 'O', 'T', 'INVALID' respectively indicate Scheduling In Progress, Stopped, Paused, Stopping, Expired Note: This field may return null, indicating that no valid value can be obtained.
TaskTypeId	Integer	Task Type ID Note: This field may return null, indicating that no valid value can be obtained.
TaskTypeDesc	String	Task Type Description, where the corresponding relationship between Task Type ID and Task Type Description is as follows 20 Universal Data Synchronization Task 21 JDBC SQL 22 Tbase 25 Data ETL 30 Python 31 PySpark 34 Hive SQL 35 Shell 36 Spark SQL 37 HDFS to HBase 38 SHELL 39 Spark 45 DATA_QUALITY 55 THIVE to MySQL 56 THIVE to PostgreSQL 66 HDFS to PostgreSQL 67 HDFS to Oracle 68 HDFS to MySQL 69 FTP to HDFS 70 HIVE SQL 72 HIVE to HDFS 75 HDFS to HIVE 81 Python SQL Script 82 Spark Scala Computation 83 Wormhole Task 84 Verify Reconciliation File 85 HDFS to THIVE 86 TDW to HDFS 87 HDFS to TDW 88 Verify Reconciliation File 91 FLINK Task 92 MapReduce 98 custom topology 99 kafkatoHDFS 100 kafkatoHbase 101 Import MYSQL to HIVE(DX) 104 MYSQL to HIVE 105 HIVE to MYSQL 106 SQL SERVER to HIVE 107 HIVE to SQL SERVER 108 ORACLE to HIVE 109 HIVE to ORACLE 111 HIVE to MYSQL (NEW) 112 HIVE to PG 113 HIVE to PHOENIX 118 MYSQL to HDFS 119 PG to HDFS 120 ORACLE to HDFS 121 Data Quality 10000 Custom Definition Business Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	Project IDNote: This field may return null, indicating that no valid value can be obtained.
FolderName	String	Folder NameNote: This field may return null, indicating that no valid value can be obtained.
FolderId	String	Folder IDNote: This field may return null, indicating that no valid value can be obtained.
FirstSubmitTime	String	Latest Submission Time Note: This field may return null, indicating that no valid value can be obtained.
FirstRunTime	String	First Execution Time Note: This field may return null, indicating that no valid value can be obtained.
ScheduleDesc	String	Scheduling Plan Display Description Information Note: This field may return null, indicating that no valid value can be obtained.
InCharge	String	Owner Note: This field may return null, indicating that no valid value can be obtained.
CycleUnit	String	Scheduling Cycle Type Note: This field may return null, indicating that no valid value can be obtained.
LeftCoordinate	Float	Canvas X-axis Coordinate Point Note: This field may return null, indicating that no valid value can be obtained.
TopCoordinate	Float	Canvas Y-axis Coordinate Point Note: This field may return null, indicating that no valid value can be obtained.
VirtualFlag	Boolean	Cross-Workflow Virtual Task Identifier; true indicates a cross-workflow task; false indicates an in-workflow task Note: This field may return null, indicating that no valid value can be obtained.
TaskAction	String	Elastic Cycle Configuration Note: This field may return null, indicating that no valid value can be obtained.
DelayTime	Integer	DelayNote: This field may return null, indicating that no valid value can be obtained.
ExecutionStartTime	String	Execution Start Time Note: This field may return null, indicating that no valid value can be obtained.
ExecutionEndTime	String	Execution End Time Note: This field may return null, indicating that no valid value can be obtained.
Layer	String	Hierarchy Note: This field may return null, indicating that no valid value can be obtained.
SourceServiceId	String	Source Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
SourceServiceType	String	Source Data Source Type Note: This field may return null, indicating that no valid value can be obtained.
TargetServiceId	String	Target Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
TargetServiceType	String	Target Data Source Type Note: This field may return null, indicating that no valid value can be obtained.
AlarmType	String	Task Alert Types Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.

OpsTaskCanvasInfoList

Canvas Required Information

Used by actions: DescribeDependOpsTasks.

Name	Type	Description
TasksList	Array of OpsTaskCanvasDto	Canvas Task Information
LinksList	Array of OpsTaskLinkInfoDto	Canvas Task Link Information
CirculateTaskList	OpsTaskCanvasDto	Canvas Cyclic Dependency Task Information Note: This field may return null, indicating that no valid value can be obtained.

OpsTaskInfoPage

Task Pagination Query

Used by actions: DescribeOperateOpsTasks.

Name	Type	Description
PageNumber	Integer	Page Number
PageSize	Integer	Page Size
Items	Array of TaskOpsDto	Task List Information
TotalPage	Integer	Total Pages
PageCount	Integer	Page Number
TotalCount	Integer	Total number of items

OpsTaskLinkInfoDto

Dependency edge information of the task

Used by actions: DescribeDependOpsTasks.

Name	Type	Description
TaskTo	String	Downstream task ID
TaskFrom	String	Upstream task ID
LinkType	String	Dependency Edge Type 1,"real_real" indicates task->task; 2, "virtual_real" crossed workflow task->task
LinkId	String	Dependency Edge ID
LinkStyle	String	To distinguish newly added cyclic dependency. Default is normal, for cyclic dependency it is circulate Note: This field may return null, indicating that no valid value can be obtained.

OrderField

Universal Sort Field

Used by actions: DescribeAlarmEvents, DescribeColumnsMeta, DescribeDataSourceInfoList, DescribeDataSourceList, DescribeDatabaseMetas, DescribeFieldBasicInfo, DescribeIntegrationTasks, DescribeRuleGroupExecResultsByPage, DescribeRuleGroupsByPage, DescribeRuleTemplatesByPage, DescribeRulesByPage, DescribeTableBasicInfo, DescribeTableMetas, DescribeTableQualityDetails, DescribeTaskAlarmRegulations.

Name	Type	Required	Description
Name	String	Yes	Sorting Field Name
Direction	String	Yes	Sorting Direction: ASC\|DESC

OrderFieldOptional

Universal Sort Field

Used by actions: DescribeApproveList.

Name	Type	Required	Description
Name	String	No	Sorting Field Name
Direction	String	No	Sorting Direction: ASC\|DESC

OrganizationalFunction

Function containing hierarchical information

Used by actions: DescribeOrganizationalFunctions.

Name	Type	Description
Name	String	Name
DisplayName	String	Display Name
LayerPath	String	Hierarchical Path
ParentLayerPath	String	Parent Hierarchical Path
Type	String	Function Type Note: This field may return null, indicating that no valid value can be obtained.
Kind	String	Function Classification: Window functions, Aggregation functions, Date functions... Note: This field may return null, indicating that no valid value can be obtained.
Category	String	Function Category: System functions, Custom Definition functions Note: This field may return null, indicating that no valid value can be obtained.
Status	String	Function Status Note: This field may return null, indicating that no valid value can be obtained.
Description	String	Function DescriptionNote: This field may return null, indicating that no valid value can be obtained.
Usage	String	Function Usage Note: This field may return null, indicating that no valid value can be obtained.
ParamDesc	String	Function Parameter Description Note: This field may return null, indicating that no valid value can be obtained.
ReturnDesc	String	Function Return Value Description Note: This field may return null, indicating that no valid value can be obtained.
Example	String	Function Example Note: This field may return null, indicating that no valid value can be obtained.
ClusterIdentifier	String	Cluster Instance Engine IDNote: This field may return null, indicating that no valid value can be obtained.
FuncId	String	Function IDNote: This field may return null, indicating that no valid value can be obtained.
ClassName	String	Function Class Name Note: This field may return null, indicating that no valid value can be obtained.
ResourceList	Array of FunctionVersion	Function Resource List Note: This field may return null, indicating that no valid value can be obtained.
OperatorUserIds	Array of Integer	Operator ID List Note: This field may return null, indicating that no valid value can be obtained.
OwnerUserIds	Array of Integer	Public cloud Owner ID list Note: This field may return null, indicating that no valid value can be obtained.
DbName	String	Database nameNote: This field may return null, indicating that no valid value can be obtained.
SubmitErrorMsg	String	Submission failed error message Note: This field may return null, indicating that no valid value can be obtained.
SchemaName	String	Pattern nameNote: This field may return null, indicating that no valid value can be obtained.
CommandFormat	String	Function Command FormatNote: This field may return null, indicating that no valid value can be obtained.
OwnerName	String	NameNote: This field may return null, indicating that no valid value can be obtained.
SubmitTimestamp	String	TimestampNote: This field may return null, indicating that no valid value can be obtained.
Tag	String	Function tag Note: This field may return null, indicating that no valid value can be obtained.
OperatorUserIdsStr	Array of String	Operator ID List Note: This field may return null, indicating that no valid value can be obtained.
OwnerUserIdsStr	Array of String	Public Cloud Owner ID List Note: This field may return null, indicating that no valid value can be obtained.

Pair

Key-Value Pair

Used by actions: DescribeColumnsMeta.

Name	Type	Required	Description
Key	String	Yes	Key Name
Value	String	Yes	Value

PairDto

Key-Value Pair

Used by actions: DescribeWorkflowTaskCount.

Name	Type	Description
Key	String	Key Name Note: This field may return null, indicating that no valid value can be obtained.
Value	String	ValueNote: This field may return null, indicating that no valid value can be obtained.

ParamInfo

Parameters

Used by actions: DeleteFilePath, GetFileInfo, ModifyTaskInfo, ModifyWorkflowInfo.

Name	Type	Required	Description
ParamKey	String	Yes	Parameter Name
ParamValue	String	Yes	Parameter Value

Partition

Partition Parameter

Used by actions: GenHiveTableDDLSql.

Name	Type	Required	Description
Transform	String	No	Partition Conversion Strategy
Name	String	No	Partition Field Name
TransformArgs	Array of String	No	Policy Parameter

PathNodeDsVO

Data Development - Unified Tree Structure Return Attributes

Used by actions: DescribeDsFolderTree, DescribeDsParentFolderTree.

Name	Type	Required	Description
Id	String	No	PathNode ID Note: This field may return null, indicating that no valid value can be obtained.
Title	String	No	PathNode Name Note: This field may return null, indicating that no valid value can be obtained.
Type	String	No	PathNode Type Note: This field may return null, indicating that no valid value can be obtained.
ParentId	String	No	Unique Identifier of Parent Node Note: This field may return null, indicating that no valid value can be obtained.
IsLeaf	Boolean	No	Is Leaf Node Note: This field may return null, indicating that no valid value can be obtained.
Children	Array of PathNodeDsVO	No	Child Node List Note: This field may return null, indicating that no valid value can be obtained.
Params	String	No	Business Parameters, base64 encoded JSON string, to obtain specific parameters, base64 decoding is required Note: This field may return null, indicating that no valid value can be obtained.

ProdSchedulerTask

Data Quality Production Scheduling Task Business Entity

Used by actions: CreateRule, DescribeExecStrategy, DescribeRule, DescribeRuleGroup, DescribeRules, ModifyExecStrategy.

Name	Type	Required	Description
WorkflowId	String	Yes	Production Scheduling Task Workflow ID Note: This field may return null, indicating that no valid value can be obtained.
TaskId	String	No	Production Scheduling Task ID Note: This field may return null, indicating that no valid value can be obtained.
TaskName	String	No	Production Scheduling Task Name Note: This field may return null, indicating that no valid value can be obtained.
CycleType	Integer	No	Production Scheduling Task Type Note: This field may return null, indicating that no valid value can be obtained.

Project

Project Information

Used by actions: DescribeProject.

Name	Type	Description
TenantId	String	Tenant ID of the project Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	Project IDNote: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	Project Identifier, English Name Note: This field may return null, indicating that no valid value can be obtained.
DisplayName	String	Project Display Name, can be Chinese Name Note: This field may return null, indicating that no valid value can be obtained.
Region	String	RegionNote: This field may return null, indicating that no valid value can be obtained.
Description	String	RemarksNote: This field may return null, indicating that no valid value can be obtained.
CreateTime	Timestamp ISO8601	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
Creator	BaseUser	Creator Note: This field may return null, indicating that no valid value can be obtained.
Tenant	BaseTenant	Tenant Information Note: This field may return null, indicating that no valid value can be obtained.
AdminUsers	Array of BaseUser	Project Administrator Note: This field may return null, indicating that no valid value can be obtained.
Clusters	Array of BaseClusterInfo	Project-related cluster information Note: This field may return null, indicating that no valid value can be obtained.
Params	String	Additional configuration parameters for the project Note: This field may return null, indicating that no valid value can be obtained.
Status	Integer	Project Status: 0: disabled, 1: enabled, -3: disabling, 2: enabling
Model	String	Project Type, SIMPLE: simple mode STANDARD: standard mode Note: This field may return null, indicating that no valid value can be obtained.

ProjectBaseInfoOpsRequest

Basic Information

Used by actions: DagInstances, DescribeAllByFolderNew, DescribeScheduleInstances, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances.

Name	Type	Required	Description
ProjectId	String	No	Project ID
ProjectIdent	String	No	Project Identifier
ProjectName	String	No	Project name
IsAdmin	Boolean	No	Whether admin

Property

DLC table creation attribute

Used by actions: GenHiveTableDDLSql, SubmitTaskTestRun.

Name	Type	Required	Description
Key	String	Yes	Key Value
Value	String	Yes	Value

QualityScore

Quality Score

Used by actions: DescribeQualityScore.

Name	Type	Description
CompositeScore	Float	Composite Score Note: This field may return null, indicating that no valid value can be obtained.
ScoringDistribution	Array of TableScoreStatisticsInfo	Score Distribution Note: This field may return null, indicating that no valid value can be obtained.
TotalTableNumber	Integer	Total Number of Tables Note: This field may return null, indicating that no valid value can be obtained.

QualityScoreTrend

Quality Score Trend

Used by actions: DescribeQualityScoreTrend, DescribeTableScoreTrend.

Name	Type	Description
AverageScore	Float	Periodic Average Score Note: This field may return null, indicating that no valid value can be obtained.
DailyScoreList	Array of DailyScoreInfo	Daily Score List Note: This field may return null, indicating that no valid value can be obtained.

QuietPeriod

DataInLong - Alarm do-not-disturb time

Used by actions: BatchCreateIntegrationTaskAlarms, CreateTaskAlarmRegular, DescribeTaskAlarmRegulations, ModifyTaskAlarmRegular.

Name	Type	Required	Description
DaysOfWeek	Array of Integer	No	Represents the days of the week, 1 for Monday, 7 for Sunday, and so on Note: This field may return null, indicating that no valid value can be obtained.
StartTime	String	No	Start TimeNote: This field may return null, indicating that no valid value can be obtained.
EndTime	String	No	End timeNote: This field may return null, indicating that no valid value can be obtained.

RealTimeTaskInstanceNodeInfo

Current Node Information of Real-time Task Instance

Used by actions: DescribeRealTimeTaskInstanceNodeInfo.

Name	Type	Description
TaskName	String	Task Name Note: This field may return null, indicating that no valid value can be obtained.
TaskId	String	Task ID Note: This field may return null, indicating that no valid value can be obtained.
InstanceNodeInfoList	Array of InstanceNodeInfo	Real-time Task Instance Node Information List Note: This field may return null, indicating that no valid value can be obtained.

RealTimeTaskSpeed

Real-time task synchronization speed trend

Used by actions: DescribeRealTimeTaskSpeed.

Name	Type	Description
RecordsSpeedList	Array of RecordsSpeed	Synchronous Speed Bar/s List
BytesSpeedList	Array of BytesSpeed	Synchronous Speed Bytes/s List

RecordField

Common Record Fields, agreed with the server to pass in legitimate key-value pairs

Used by actions: BatchStartIntegrationTasks, CommitIntegrationTask, CreateIntegrationNode, CreateIntegrationTask, DescribeColumnLineage, DescribeIntegrationNode, DescribeIntegrationTask, DescribeIntegrationTasks, DescribeIntegrationVersionNodesInfo, DescribeTableLineage, DescribeTableLineageInfo, GetIntegrationNodeColumnSchema, ModifyIntegrationNode, ModifyIntegrationTask, ModifyTaskScript, ResumeIntegrationTask, StartIntegrationTask.

Name	Type	Required	Description
Name	String	No	Field Name, Extended Field Name
Value	String	No	Field Value, Extended Field Value

RecordsSpeed

Real-time task synchronization speed Bar/s

Used by actions: DescribeRealTimeTaskSpeed.

Name	Type	Description
NodeType	String	Node TypeNote: This field may return null, indicating that no valid value can be obtained.
NodeName	String	Node nameNote: This field may return null, indicating that no valid value can be obtained.
Values	Array of SpeedValue	Speed value list Note: This field may return null, indicating that no valid value can be obtained.

ResourcePathTree

Resource Management Directory Tree Node

Used by actions: DescribeResourceManagePathTrees.

Name	Type	Description
Name	String	Resource name Note: This field may return null, indicating that no valid value can be obtained.
IsLeaf	Boolean	Is leaf node Note: This field may return null, indicating that no valid value can be obtained.
ResourceId	String	Resource ID Note: This field may return null, indicating that no valid value can be obtained.
LocalPath	String	Local path Note: This field may return null, indicating that no valid value can be obtained.
RemotePath	String	Remote path Note: This field may return null, indicating that no valid value can be obtained.
FileExtensionType	String	File TypeNote: This field may return null, indicating that no valid value can be obtained.
Size	Integer	File sizeNote: This field may return null, indicating that no valid value can be obtained.
Md5Value	String	File MD5 value Note: This field may return null, indicating that no valid value can be obtained.
OwnerName	String	File Owner's Name Note: This field may return null, indicating that no valid value can be obtained.
UpdateUser	String	Updater Note: This field may return null, indicating that no valid value can be obtained.
UpdateUserId	String	File Updater UIN Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	Integer	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
UpdateTime	Integer	Update timeNote: This field may return null, indicating that no valid value can be obtained.
CosBucket	String	COS Bucket Name Note: This field may return null, indicating that no valid value can be obtained.
CosRegion	String	COS Region Note: This field may return null, indicating that no valid value can be obtained.
ExtraInfo	String	Additional InformationNote: This field may return null, indicating that no valid value can be obtained.

RobLockState

Lock Acquisition Status: Whether to Grab the Lock and Current Lock Holder

Used by actions: RobAndLockIntegrationTask.

Name	Type	Description
IsRob	Boolean	Whether to Grab the Lock
Locker	String	Current Lock Holder

Rule

Data Quality Rules

Used by actions: CreateRule, DescribeRule, DescribeRules, DescribeRulesByPage.

Name	Type	Required	Description
RuleId	Integer	No	Rule ID Note: This field may return null, indicating that no valid value can be obtained.
RuleGroupId	Integer	No	Rule Group ID Note: This field may return null, indicating that no valid value can be obtained.
TableId	String	No	Data Table ID Note: This field may return null, indicating that no valid value can be obtained.
Name	String	No	Rule nameNote: This field may return null, indicating that no valid value can be obtained.
Type	Integer	No	Rule Type 1. System Template, 2. Custom Definition Template, 3. Custom Definition SQL Note: This field may return null, indicating that no valid value can be obtained.
RuleTemplateId	Integer	No	Rule Template ID Note: This field may return null, indicating that no valid value can be obtained.
RuleTemplateContent	String	No	Rule Template Overview Note: This field may return null, indicating that no valid value can be obtained.
QualityDim	Integer	No	Quality Dimension of Rule 1: Accuracy, 2: Uniqueness, 3: Completeness, 4: Consistency, 5: Timeliness, 6: Validity Note: This field may return null, indicating that no valid value can be obtained.
SourceObjectType	Integer	No	Applicable Source Data Object Type (1: Constant, 2: Offline Table Level, 3: Offline Field Level) Note: This field may return null, indicating that no valid value can be obtained.
SourceObjectDataType	Integer	No	Applicable Source Data Object Type (1: Numeric, 2: String) Note: This field may return null, indicating that no valid value can be obtained.
SourceObjectDataTypeName	String	No	Source Field Detailed Type, INT, STRING Note: This field may return null, indicating that no valid value can be obtained.
SourceObjectValue	String	No	Source Field Name Note: This field may return null, indicating that no valid value can be obtained.
ConditionType	Integer	No	Detection Range 1. Whole Table, 2. Conditional Scan Note: This field may return null, indicating that no valid value can be obtained.
ConditionExpression	String	No	Conditional Scan WHERE Condition Expression Note: This field may return null, indicating that no valid value can be obtained.
CustomSql	String	No	Custom Template SQL Expression from Definition Note: This field may return null, indicating that no valid value can be obtained.
CompareRule	CompareRule	No	Alert Trigger Condition Note: This field may return null, indicating that no valid value can be obtained.
AlarmLevel	Integer	No	Alert Trigger Level 1. Low, 2. Medium, 3. High Note: This field may return null, indicating that no valid value can be obtained.
Description	String	No	Rule DescriptionNote: This field may return null, indicating that no valid value can be obtained.
Operator	String	No	Rule Configurator Note: This field may return null, indicating that no valid value can be obtained.
TargetDatabaseId	String	No	Target Database Id Note: This field may return null, indicating that no valid value can be obtained.
TargetDatabaseName	String	No	Target Database Name Note: This field may return null, indicating that no valid value can be obtained.
TargetTableId	String	No	Target Table Id Note: This field may return null, indicating that no valid value can be obtained.
TargetTableName	String	No	Target Table Name Note: This field may return null, indicating that no valid value can be obtained.
TargetConditionExpr	String	No	Target Field Filter Condition Expression Note: This field may return null, indicating that no valid value can be obtained.
RelConditionExpr	String	No	Source and target field association conditions in ON expression Note: This field may return null, indicating that no valid value can be obtained.
FieldConfig	RuleFieldConfig	No	From Definition template SQL expression parameters Note: This field may return null, indicating that no valid value can be obtained.
MultiSourceFlag	Boolean	No	Whether to join multiple tables Note: This field may return null, indicating that no valid value can be obtained.
WhereFlag	Boolean	No	Whether WHERE parameters exist Note: This field may return null, indicating that no valid value can be obtained.
TemplateSql	String	No	Template original SQL Note: This field may return null, indicating that no valid value can be obtained.
SubQualityDim	Integer	No	Template sub-dimensions: 0.Parent dimension type, 1.Consistency: Enum range consistency, 2.Consistency: Numeric range consistency, 3.Consistency: Field data correlation Note: This field may return null, indicating that no valid value can be obtained.
TargetObjectType	Integer	No	Rule applicable target data object types (1: Constant, 2: Offline table level, 3: Offline field level) Note: This field may return null, indicating that no valid value can be obtained.
TargetObjectDataType	Integer	No	Rule applicable target data object types (1: Numeric, 2: String) Note: This field may return null, indicating that no valid value can be obtained.
TargetObjectDataTypeName	String	No	Target field detailed types, INT, STRING Note: This field may return null, indicating that no valid value can be obtained.
TargetObjectValue	String	No	Target field name Note: This field may return null, indicating that no valid value can be obtained.
SourceEngineTypes	Array of Integer	No	Source engine type Note: This field may return null, indicating that no valid value can be obtained.
TableName	String	No	Table name Note: This field may return null, indicating that no valid value can be obtained.
TableOwnerName	String	No	Table manager name Note: This field may return null, indicating that no valid value can be obtained.
ExecStrategy	RuleGroupExecStrategy	No	Execution strategy information Note: This field may return null, indicating that no valid value can be obtained.
Subscription	RuleGroupSubscribe	No	Subscription information Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
DatasourceId	Integer	No	Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	No	Database ID Note: This field may return null, indicating that no valid value can be obtained.
MonitorStatus	Integer	No	Monitoring enabled. 0 false, 1 true Note: This field may return null, indicating that no valid value can be obtained.
TriggerCondition	String	No	Trigger conditionNote: This field may return null, indicating that no valid value can be obtained.
DsEnvType	Integer	No	0, or not returned, or null: Undefined, 1: Production, 2: Development Note: This field may return null, indicating that no valid value can be obtained.

RuleConfig

Rule Configuration

Used by actions: CommitRuleGroupTask.

Name	Type	Required	Description
RuleId	Integer	No	Rule IDNote: This field may return null, indicating that no valid value can be obtained.
ConditionType	Integer	No	Rule Detection Range Type 1. Whole Table 2. Conditional Scan Note: This field may return null, indicating that no valid value can be obtained.
Condition	String	No	Detection Range Expression Note: This field may return null, indicating that no valid value can be obtained.
TargetCondition	String	No	Target Detection Range Expression Note: This field may return null, indicating that no valid value can be obtained.

RuleDimCnt

RuleDimCnt Rule Dimension Statistics

Used by actions: DescribeRuleDimStat.

Name	Type	Description
Dim	Integer	1: Accuracy, 2: Uniqueness, 3: Integrity, 4: Consistency, 5: Timeliness, 6: Validity
Cnt	Integer	count Number

RuleDimStat

Rule Dimension Count Statistics

Used by actions: DescribeRuleDimStat.

Name	Type	Description
TotalCnt	Integer	Total number
DimCntList	Array of RuleDimCnt	Dimension Count Statistics

RuleExecConfig

Rule Execution Configuration

Used by actions: CommitRuleGroupTask.

Name	Type	Required	Description
QueueName	String	No	Compute Queue Name Note: This field may return null, indicating that no valid value can be obtained.
ExecutorGroupId	String	No	Execution Resource Group Note: This field may return null, indicating that no valid value can be obtained.
EngineType	String	No	The running execution engine, if not specified, the default execution engine under this data source will be requested Note: This field may return null, indicating that no valid value can be obtained.

RuleExecDateStat

Overview Trend Results

Used by actions: DescribeTrendStat.

Name	Type	Description
StatDate	String	Statistics Date
AlarmCnt	Integer	Number of Alerts
PipelineCnt	Integer	Number of blocked processes

RuleExecLog

Rule Execution Log

Used by actions: DescribeRuleExecLog.

Name	Type	Description
Finished	Boolean	Completion Status Note: This field may return null, indicating that no valid value can be obtained.
Log	String	ContentNote: This field may return null, indicating that no valid value can be obtained.

RuleExecResult

Rule Execution Result

Used by actions: CommitRuleGroupTask, DescribeRuleExecDetail, DescribeRuleExecResults, DescribeRuleGroupExecResultsByPage.

Name	Type	Required	Description
RuleExecId	Integer	No	Rule Execution ID Note: This field may return null, indicating that no valid value can be obtained.
RuleGroupExecId	Integer	No	Rule Group Execution ID Note: This field may return null, indicating that no valid value can be obtained.
RuleGroupId	Integer	No	Rule Group IDNote: This field may return null, indicating that no valid value can be obtained.
RuleId	Integer	No	Rule IDNote: This field may return null, indicating that no valid value can be obtained.
RuleName	String	No	Rule nameNote: This field may return null, indicating that no valid value can be obtained.
RuleType	Integer	No	Rule type 1.System Template, 2.Custom Definition Template, 3.Custom Definition SQLNote: This field may return null, indicating that no valid value can be obtained.
SourceObjectDataTypeName	String	No	Source Field Detailed Type, int string Note: This field may return null, indicating that no valid value can be obtained.
SourceObjectValue	String	No	Source Field NameNote: This field may return null, indicating that no valid value can be obtained.
ConditionExpression	String	No	Conditional Scan WHERE Condition ExpressionNote: This field may return null, indicating that no valid value can be obtained.
ExecResultStatus	Integer	No	Test Results (1: Detection passed, 2: Trigger Rules, 3: Detection failed) Note: This field may return null, indicating that no valid value can be obtained.
TriggerResult	String	No	Trigger Result, Alert Sent Successfully, Block Task Successful Note: This field may return null, indicating that no valid value can be obtained.
CompareResult	CompareResult	No	Comparison Result Note: This field may return null, indicating that no valid value can be obtained.
TemplateName	String	No	Template name Note: This field may return null, indicating that no valid value can be obtained.
QualityDim	Integer	No	Quality Dimension Note: This field may return null, indicating that no valid value can be obtained.
TargetDBTableName	String	No	Target Table - Database Table Name Note: This field may return null, indicating that no valid value can be obtained.
TargetObjectValue	String	No	Target Table - Field Name Note: This field may return null, indicating that no valid value can be obtained.
TargetObjectDataType	String	No	Target Table - Field Type Note: This field may return null, indicating that no valid value can be obtained.
FieldConfig	RuleFieldConfig	No	Custom Definition Template SQL Expression Parameters Note: This field may return null, indicating that no valid value can be obtained.
RelConditionExpr	String	No	Source Field and Target Field Association Condition ON ExpressionNote: This field may return null, indicating that no valid value can be obtained.
StartTime	String	No	Execution timeNote: This field may return null, indicating that no valid value can be obtained.
AlarmLevel	Integer	No	1/2/3: Low/Medium/High Note: This field may return null, indicating that no valid value can be obtained.

RuleExecResultDetail

Rule Execution Result Details

Used by actions: DescribeRuleExecDetail.

Name	Type	Required	Description
DatasourceId	Integer	No	Data source ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceName	String	No	Data Source Name Note: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	No	Database GUID Note: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	No	Database nameNote: This field may return null, indicating that no valid value can be obtained.
InstanceId	String	No	Instance IDNote: This field may return null, indicating that no valid value can be obtained.
TableId	String	No	table guid Note: This field may return null, indicating that no valid value can be obtained.
TableName	String	No	Table nameNote: This field may return null, indicating that no valid value can be obtained.
RuleExecResult	RuleExecResult	No	rule execution record Note: This field may return null, indicating that no valid value can be obtained.
TableOwnerUserId	Integer	No	table owner userId Note: This field may return null, indicating that no valid value can be obtained.
DatasourceType	Integer	No	2.HIVE 3.DLC Note: This field may return null, indicating that no valid value can be obtained.

RuleExecResultPage

Rule Execution Result Pagination

Used by actions: DescribeRuleExecResults.

Name	Type	Description
TotalCount	Integer	Record Count Note: This field may return null, indicating that no valid value can be obtained.
Items	Array of RuleExecResult	Rule Execution Result

RuleExecStat

Rule Execution Result

Used by actions: DescribeRuleExecStat.

Name	Type	Description
TotalCnt	Integer	Total Rule Executions
LastTotalCnt	Integer	Quarter-over-quarter total rule executions Note: This field may return null, indicating that no valid value can be obtained.
TotalCntRatio	Float	Percentage of total rule executions
LastTotalCntRatio	Float	Quarter-over-quarter change in total rule executions Note: This field may return null, indicating that no valid value can be obtained.
TriggerCnt	Integer	Number of rule triggers
LastTriggerCnt	Integer	Quarter-over-quarter number of rule triggers Note: This field may return null, indicating that no valid value can be obtained.
TriggerCntRatio	Float	Percentage of triggers in total
LastTriggerCntRatio	Float	Quarter-over-quarter change in rule triggers Note: This field may return null, indicating that no valid value can be obtained.
AlarmCnt	Integer	Number of rule alerts
LastAlarmCnt	Integer	Quarter-over-quarter number of rule alerts Note: This field may return null, indicating that no valid value can be obtained.
AlarmCntRatio	Float	Percentage of alerts in total
LastAlarmCntRatio	Float	Quarter-over-quarter change in alert numbers Note: This field may return null, indicating that no valid value can be obtained.
PipelineCnt	Integer	Number of block occurrences
LastPipelineCnt	Integer	Quarter-over-quarter number of block occurrences Note: This field may return null, indicating that no valid value can be obtained.
PipelineCntRatio	Float	Percentage of blocks in total
LastPipelineCntRatio	Float	Quarter-over-quarter change in block occurrences Note: This field may return null, indicating that no valid value can be obtained.

RuleFieldConfig

Rule Variable Replacement

Used by actions: CommitRuleGroupTask, CreateRule, DescribeRule, DescribeRuleExecDetail, DescribeRuleExecResults, DescribeRuleGroupExecResultsByPage, DescribeRules, ModifyRule.

Name	Type	Required	Description
WhereConfig	Array of FieldConfig	No	Where Variable Note: This field may return null, indicating that no valid value can be obtained.
TableConfig	Array of TableConfig	No	Database Table Variable Note: This field may return null, indicating that no valid value can be obtained.

RuleGroup

Data Quality Rule Group

Used by actions: DescribeRuleGroup, DescribeRuleGroupsByPage.

Name	Type	Required	Description
RuleGroupId	Integer	No	Rule Group ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	No	Data Source IDNote: This field may return null, indicating that no valid value can be obtained.
DatasourceName	String	No	Data Source Name Note: This field may return null, indicating that no valid value can be obtained.
DatasourceType	Integer	No	Data source typeNote: This field may return null, indicating that no valid value can be obtained.
MonitorType	Integer	No	Monitoring Type: 1. Not Configured, 2. Associate Production Scheduling, 3. Offline Period Detection Note: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	No	Update timeNote: This field may return null, indicating that no valid value can be obtained.
TableName	String	No	Associated Data Table Name Note: This field may return null, indicating that no valid value can be obtained.
TableId	String	No	Associated Data Table Id Note: This field may return null, indicating that no valid value can be obtained.
TableOwnerName	String	No	Associated Data Table Owner Note: This field may return null, indicating that no valid value can be obtained.
ExecStrategy	RuleGroupExecStrategy	No	Execution policyNote: This field may return null, indicating that no valid value can be obtained.
Subscription	RuleGroupSubscribe	No	Execution policyNote: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	No	Database ID Note: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	No	Database nameNote: This field may return null, indicating that no valid value can be obtained.
Permission	Boolean	No	Permission Granted Note: This field may return null, indicating that no valid value can be obtained.
RuleCount	Integer	No	Number of Rules Configured Note: This field may return null, indicating that no valid value can be obtained.
MonitorStatus	Boolean	No	Monitoring Status Note: This field may return null, indicating that no valid value can be obtained.
TableOwnerUserId	Integer	No	Table Leader UserId Note: This field may return null, indicating that no valid value can be obtained.
InstanceId	String	No	Instance IDNote: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
StrategyConfig	Boolean	No	Execution Strategy Configured? Note: This field may return null, indicating that no valid value can be obtained.
SubscribeConfig	Boolean	No	Execution Strategy Configured? Note: This field may return null, indicating that no valid value can be obtained.
DsEnvType	Integer	No	Data Source Environment: 0 or not returned. Undefined, 1. Production, 2. Development Note: This field may return null, indicating that no valid value can be obtained.

RuleGroupExecResult

Rule Group Execution Result

Used by actions: CommitRuleGroupTask, DescribeRuleGroupExecResultsByPage.

Name	Type	Required	Description
RuleGroupExecId	Integer	No	Rule Group Execution ID Note: This field may return null, indicating that no valid value can be obtained.
RuleGroupId	Integer	No	Rule Group ID Note: This field may return null, indicating that no valid value can be obtained.
TriggerType	Integer	No	Execution Trigger Type (1: Manual Trigger, 2: In-process Scheduling Trigger, 3: Periodic Scheduling Trigger) Note: This field may return null, indicating that no valid value can be obtained.
ExecTime	String	No	Execution time yyyy-MM-dd HH:mm:ss Note: This field may return null, indicating that no valid value can be obtained.
Status	Integer	No	Execution Status (1. Submitted, 2. Under detection, 3. Normal, 4. Abnormal) Note: This field may return null, indicating that no valid value can be obtained.
AlarmRuleCount	Integer	No	Number of Exceptional Rules Note: This field may return null, indicating that no valid value can be obtained.
TotalRuleCount	Integer	No	Total Number of Rules Note: This field may return null, indicating that no valid value can be obtained.
TableOwnerName	String	No	Source Table Responsible Person Note: This field may return null, indicating that no valid value can be obtained.
TableName	String	No	Source Table Name Note: This field may return null, indicating that no valid value can be obtained.
TableId	String	No	Table ID Note: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	No	Database ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	No	Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
Permission	Boolean	No	Permission Availability Note: This field may return null, indicating that no valid value can be obtained.
ExecDetail	String	No	Execution Details, Scheduling Plan, or Associated Production Task ID Note: This field may return null, indicating that no valid value can be obtained.
EngineType	String	No	Actual Execution Engine Note: This field may return null, indicating that no valid value can be obtained.
RuleExecResultVOList	Array of RuleExecResult	No	Rule Execution Result Note: This field may return null, indicating that no valid value can be obtained.

RuleGroupExecResultPage

Rule Group Execution Result Pagination

Used by actions: DescribeRuleGroupExecResultsByPage.

Name	Type	Required	Description
TotalCount	Integer	No	Record CountNote: This field may return null, indicating that no valid value can be obtained.
Items	Array of RuleGroupExecResult	No	Rule Group Execution ResultNote: This field may return null, indicating that no valid value can be obtained.

RuleGroupExecStrategy

Quality Rule Execution Strategy

Used by actions: CreateRule, DescribeExecStrategy, DescribeRule, DescribeRuleGroup, DescribeRules.

Name	Type	Required	Description
RuleGroupId	Integer	No	Rule Group ID Note: This field may return null, indicating that no valid value can be obtained.
MonitorType	Integer	No	Monitoring Type 1. Not configured, 2. Associated with production scheduling, 3. Offline cycle detection Note: This field may return null, indicating that no valid value can be obtained.
ExecQueue	String	No	Calculation Queue Note: This field may return null, indicating that no valid value can be obtained.
ExecutorGroupId	String	No	Execution Resource Group ID Note: This field may return null, indicating that no valid value can be obtained.
ExecutorGroupName	String	No	Execution Resource Group Name Note: This field may return null, indicating that no valid value can be obtained.
Tasks	Array of ProdSchedulerTask	No	Associated Production Scheduling Task List Note: This field may return null, indicating that no valid value can be obtained.
StartTime	String	No	Cycle Start Time Note: This field may return null, indicating that no valid value can be obtained.
EndTime	String	No	Cycle End Time Note: This field may return null, indicating that no valid value can be obtained.
CycleType	String	No	Scheduling Cycle Type Note: This field may return null, indicating that no valid value can be obtained.
DelayTime	Integer	No	Delayed Scheduling Time Note: This field may return null, indicating that no valid value can be obtained.
CycleStep	Integer	No	Interval Note: This field may return null, indicating that no valid value can be obtained.
TaskAction	String	No	Time Specification Note: This field may return null, indicating that no valid value can be obtained.
ExecEngineType	String	No	Execution engine to run, if not provided, the default execution engine for this data source will be requested Note: This field may return null, indicating that no valid value can be obtained.
ExecPlan	String	No	Execution planNote: This field may return null, indicating that no valid value can be obtained.
RuleId	Integer	No	Rule ID Note: This field may return null, indicating that no valid value can be obtained.
RuleName	String	No	Rule nameNote: This field may return null, indicating that no valid value can be obtained.
TriggerTypes	Array of String	No	Trigger Type Note: This field may return null, indicating that no valid value can be obtained.

RuleGroupPage

Rule Group Pagination

Used by actions: DescribeRuleGroupsByPage.

Name	Type	Description
TotalCount	Integer	Record CountNote: This field may return null, indicating that no valid value can be obtained.
Items	Array of RuleGroup	Rule Group List Note: This field may return null, indicating that no valid value can be obtained.

RuleGroupSchedulerInfo

Rule Group Scheduling Information

Used by actions: DescribeRuleGroupTable.

Name	Type	Description
Id	Integer	Rule Group IDNote: This field may return null, indicating that no valid value can be obtained.
MonitorType	Integer	1: Unconfigured 2: Associated with production scheduling 3: Offline cycle detection Note: This field may return null, indicating that no valid value can be obtained.
StartTime	String	Start TimeNote: This field may return null, indicating that no valid value can be obtained.
EndTime	String	End timeNote: This field may return null, indicating that no valid value can be obtained.
CycleType	String	Abbreviation for cycle type Note: This field may return null, indicating that no valid value can be obtained.
CycleStep	Integer	Cycle step length Note: This field may return null, indicating that no valid value can be obtained.
CycleDesc	String	Cycle type Note: This field may return null, indicating that no valid value can be obtained.
TaskAction	String	Specified time under offline cycle detection Note: This field may return null, indicating that no valid value can be obtained.
DelayTime	Integer	Delay time under offline cycle detection Note: This field may return null, indicating that no valid value can be obtained.
CycleTaskId	String	Task ID registered to the task scheduler under offline cycle detection Note: This field may return null, indicating that no valid value can be obtained.
AssociateTaskIds	Array of String	Associated task ID under associated production scheduling Note: This field may return null, indicating that no valid value can be obtained.

RuleGroupSubscribe

Data Quality Rule Group Subscription Information

Used by actions: CreateRule, DescribeRule, DescribeRuleGroup, DescribeRuleGroupSubscription, DescribeRuleGroupTable, DescribeRules.

Name	Type	Required	Description
RuleGroupId	Integer	No	Rule Group ID Note: This field may return null, indicating that no valid value can be obtained.
Receivers	Array of SubscribeReceiver	No	Subscription Recipient List Note: This field may return null, indicating that no valid value can be obtained.
SubscribeType	Array of Integer	No	Subscription Method 1. Email 2. SMS Note: This field may return null, indicating that no valid value can be obtained.
WebHooks	Array of SubscribeWebHook	No	Group Robot Configuration's Webhook Information Note: This field may return null, indicating that no valid value can be obtained.
RuleId	Integer	No	Rule ID Note: This field may return null, indicating that no valid value can be obtained.
RuleName	String	No	Rule nameNote: This field may return null, indicating that no valid value can be obtained.

RuleGroupTable

Table Binding Rule Group Information

Used by actions: DescribeRuleGroupTable.

Name	Type	Description
TableInfo	RuleGroupTableInnerInfo	Table Information Note: This field may return null, indicating that no valid value can be obtained.
RuleGroups	Array of RuleGroupSchedulerInfo	Rule Group Scheduling Information Note: This field may return null, indicating that no valid value can be obtained.
Subscriptions	Array of RuleGroupSubscribe	Subscriber Information Note: This field may return null, indicating that no valid value can be obtained.

RuleGroupTableInnerInfo

Rule Group Association Table Information

Used by actions: DescribeRuleGroupTable.

Name	Type	Description
TableId	String	Table IDNote: This field may return null, indicating that no valid value can be obtained.
TableName	String	Table NameNote: This field may return null, indicating that no valid value can be obtained.
InstanceId	String	Instance IDNote: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceName	String	Data Source Name Note: This field may return null, indicating that no valid value can be obtained.
DatasourceType	Integer	Data source typeNote: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	Database ID Note: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	Database nameNote: This field may return null, indicating that no valid value can be obtained.
ProjectId	Integer	Project IDNote: This field may return null, indicating that no valid value can be obtained.
UserId	Integer	Responsible Person ID Note: This field may return null, indicating that no valid value can be obtained.

RulePage

Data Quality Rule Pagination

Used by actions: DescribeRulesByPage.

Name	Type	Required	Description
TotalCount	Integer	No	Record Count Note: This field may return null, indicating that no valid value can be obtained.
Items	Array of Rule	No	Rule List Note: This field may return null, indicating that no valid value can be obtained.

RuleTemplate

Rule Template

Used by actions: DescribeRuleTemplate, DescribeRuleTemplates, DescribeRuleTemplatesByPage.

Name	Type	Description
RuleTemplateId	Integer	Rule Template ID
Name	String	Rule Template Name
Description	String	Rule Template Description
Type	Integer	Template Type (1: System Template, 2: Self Definition)
SourceObjectType	Integer	Applicable Source Data Object Type (1: Constant, 2: Offline Table Level, 3: Offline Field Level)
SourceObjectDataType	Integer	Applicable Source Data Object Type (1: Numeric, 2: String)
SourceContent	String	Rule Template Source Side Content, distinguish engine, JSON Structure Note: This field may return null, indicating that no valid value can be obtained.
SourceEngineTypes	Array of Integer	Applicable Source Data Type Note: This field may return null, indicating that no valid value can be obtained.
QualityDim	Integer	Quality Dimension of Rule (1: Accuracy, 2: Uniqueness, 3: Completeness, 4: Consistency, 5: Timeliness, 6: Validity) Note: This field may return null, indicating that no valid value can be obtained.
CompareType	Integer	Supported Comparison Types for Rule (1: Fixed Value Comparison, greater than, less than, greater than or equal, etc. 2: Fluctuation Value Comparison, absolute value, increase, decrease) Note: This field may return null, indicating that no valid value can be obtained.
CitationCount	Integer	Number of References Note: This field may return null, indicating that no valid value can be obtained.
UserId	Integer	Creator ID Note: This field may return null, indicating that no valid value can be obtained.
UserName	String	Creator Nickname Note: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	Update Time yyyy-MM-dd HH:mm:ss Note: This field may return null, indicating that no valid value can be obtained.
WhereFlag	Boolean	Whether to add where parameter Note: This field may return null, indicating that no valid value can be obtained.
MultiSourceFlag	Boolean	Whether to Associate Multiple Tables Note: This field may return null, indicating that no valid value can be obtained.
SqlExpression	String	Custom Template SQL Expression from Definition Note: This field may return null, indicating that no valid value can be obtained.
SubQualityDim	Integer	Template Sub-dimension,0. Parent Dimension Type,1. Consistency: Enumeration Range Consistency,2. Consistency: Numeric Range Consistency,3. Consistency: Field Data Correlation Note: This field may return null, indicating that no valid value can be obtained.
ResolvedSqlExpression	SqlExpression	SQL Expression Parsing Object Note: This field may return null, indicating that no valid value can be obtained.
DatasourceTypes	Array of Integer	Supported Data Source Types Note: This field may return null, indicating that no valid value can be obtained.
UserIdStr	String	Created by User ID Str Note: This field may return null, indicating that no valid value can be obtained.

RuleTemplatePage

RuleTemplatePage results

Used by actions: DescribeRuleTemplatesByPage.

Name	Type	Description
TotalCount	Integer	Record Count
Items	Array of RuleTemplate	Template List

RuntimeInstanceCntTop

Specify Time Window Instance Duration Ranking

Used by actions: DescribeSchedulerRunTimeInstanceCntByStatus.

Name	Type	Description
TaskId	String	Task IDNote: This field may return null, indicating that no valid value can be obtained.
TaskName	String	1 Note: This field may return null, indicating that no valid value can be obtained.
InCharge	String	Person in ChargeNote: This field may return null, indicating that no valid value can be obtained.
CycleUnit	String	Task Cycle Type Note: This field may return null, indicating that no valid value can be obtained.
State	String	Instance StatusNote: This field may return null, indicating that no valid value can be obtained.
RunTime	Integer	Time Consumption Note: This field may return null, indicating that no valid value can be obtained.
CurRunTime	String	Instance Running TimeNote: This field may return null, indicating that no valid value can be obtained.
WaitScheduleTime	Integer	Waiting for Scheduling Duration Note: This field may return null, indicating that no valid value can be obtained.

SchedulerTaskInstanceInfo

Integrate Offline Task Instance Information

Used by actions: BatchForceSuccessIntegrationTaskInstances, BatchKillIntegrationTaskInstances, BatchRerunIntegrationTaskInstances.

Name	Type	Required	Description
TaskId	String	Yes	Task ID
CurRunDate	String	Yes	Instance Running Time

SchemaDetail

Metadata Field Information

Used by actions: DescribeTableSchemaInfo.

Name	Type	Description
ColumnKey	String	Column Note: This field may return null, indicating that no valid value can be obtained.
Description	String	DescriptionNote: This field may return null, indicating that no valid value can be obtained.
Name	String	NameNote: This field may return null, indicating that no valid value can be obtained.
Type	String	TypeNote: This field may return null, indicating that no valid value can be obtained.

ScreenInstanceInfo

Instance Statistics Display

Used by actions: DescribeSchedulerInstanceStatus.

Name	Type	Required	Description
CountTag	Integer	No	Statistical Indicator 0: All Instances, 1: Current Day, 2: YesterdayNote: This field may return null, indicating that no valid value can be obtained.
TotalNum	Integer	No	Total numberNote: This field may return null, indicating that no valid value can be obtained.
RunningNum	Integer	No	RunningNote: This field may return null, indicating that no valid value can be obtained.
WaitRunningNum	Integer	No	Pending Execution Note: This field may return null, indicating that no valid value can be obtained.
DependencyNum	Integer	No	Wait for Upstream Note: This field may return null, indicating that no valid value can be obtained.
WaitEventNum	String	No	Waiting for Event Note: This field may return null, indicating that no valid value can be obtained.
StoppingNum	Integer	No	Terminating Note: This field may return null, indicating that no valid value can be obtained.
SucceedNum	Integer	No	SuccessNote: This field may return null, indicating that no valid value can be obtained.
FailedNum	Integer	No	Failed Note: This field may return null, indicating that no valid value can be obtained.

ScreenTaskInfo

Operations and Maintenance Dashboard Task Display

Used by actions: DescribeSchedulerTaskCntByStatus.

Name	Type	Required	Description
CountTag	Integer	No	Statistical Indicator 0: All Instances, 1: Current Day, 2: Yesterday
TotalNum	Integer	No	Total numberNote: This field may return null, indicating that no valid value can be obtained.
RunningNum	Integer	No	RunningNote: This field may return null, indicating that no valid value can be obtained.
StoppingNum	Integer	No	StoppingNote: This field may return null, indicating that no valid value can be obtained.
StoppedNum	Integer	No	StoppedNote: This field may return null, indicating that no valid value can be obtained.
FrozenNum	Integer	No	Pause Note: This field may return null, indicating that no valid value can be obtained.
YearNum	Integer	No	Annual task Note: This field may return null, indicating that no valid value can be obtained.
MonthNum	Integer	No	Monthly task Note: This field may return null, indicating that no valid value can be obtained.
WeekNum	Integer	No	Weekly task Note: This field may return null, indicating that no valid value can be obtained.
DayNum	Integer	No	Daily task Note: This field may return null, indicating that no valid value can be obtained.
HourNum	Integer	No	Hourly task Note: This field may return null, indicating that no valid value can be obtained.
MinuteNum	Integer	No	Minute Task Note: This field may return null, indicating that no valid value can be obtained.

ScriptInfoResponse

Development Space - Script-related Response

Used by actions: UploadContent.

Name	Type	Description
ResourceId	String	Resource IDNote: This field may return null, indicating that no valid value can be obtained.
FileName	String	Script Name Note: This field may return null, indicating that no valid value can be obtained.
FileExtensionType	String	File Extension Type Note: This field may return null, indicating that no valid value can be obtained.
Type	String	File TypeNote: This field may return null, indicating that no valid value can be obtained.
Md5Value	String	md5 Value Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	Update timeNote: This field may return null, indicating that no valid value can be obtained.
Size	Float	File sizeNote: This field may return null, indicating that no valid value can be obtained.
LocalPath	String	Local Path Note: This field may return null, indicating that no valid value can be obtained.
RemotePath	String	Remote Path Note: This field may return null, indicating that no valid value can be obtained.
OwnerName	String	UsernameNote: This field may return null, indicating that no valid value can be obtained.
Owner	String	User ID Note: This field may return null, indicating that no valid value can be obtained.
PathDepth	Integer	Path Depth Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	Project IDNote: This field may return null, indicating that no valid value can be obtained.
ExtraInfo	String	Additional Information Note: This field may return null, indicating that no valid value can be obtained.
LocalTempPath	String	Local Temporary File Path Note: This field may return null, indicating that no valid value can be obtained.
ZipPath	String	Local Compressed File Path Note: This field may return null, indicating that no valid value can be obtained.
Bucket	String	COS Bucket Name Note: This field may return null, indicating that no valid value can be obtained.
Region	String	COS Region Note: This field may return null, indicating that no valid value can be obtained.

ScriptRequestInfo

Development Space - Upload Script Request

Used by actions: UploadContent.

Name	Type	Required	Description
FilePath	String	No	Script path Project area 1470575647377821696 project, under the f1 directory: /datastudio/project/1470575647377821696/f1/sql1234.sql Personal area: /datastudio/personal/sqlTTT.sql
ProjectId	String	No	Project ID
Version	String	No	Script Version
Operation	String	No	Operation Type
ExtraInfo	String	No	Additional Information
BucketName	String	No	Bucket Name
Region	String	No	Region
FileExtensionType	String	No	File Extension Type

SearchColumnDocVO

Table Field Information

Used by actions: DescribeTableMeta, DescribeTableMetas.

Name	Type	Description
Name	String	Field NameNote: This field may return null, indicating that no valid value can be obtained.
ChineseName	String	Field Chinese Name Note: This field may return null, indicating that no valid value can be obtained.
Type	String	Field TypeNote: This field may return null, indicating that no valid value can be obtained.
Length	Integer	Field Type Length Note: This field may return null, indicating that no valid value can be obtained.
Precision	Integer	Field Type Precision Note: This field may return null, indicating that no valid value can be obtained.
Scale	Integer	Field Type scale Note: This field may return null, indicating that no valid value can be obtained.
DefaultValue	String	Field Default Value Note: This field may return null, indicating that no valid value can be obtained.
Description	String	Field DescriptionNote: This field may return null, indicating that no valid value can be obtained.
Position	Integer	Field Order Note: This field may return null, indicating that no valid value can be obtained.
IsPartition	Boolean	Is Partition Field Note: This field may return null, indicating that no valid value can be obtained.
ColumnKey	String	Index Type on the column Primary Key: PRI, Unique Index: UNI, General Index: MUL Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
ModifiedTime	String	Update timeNote: This field may return null, indicating that no valid value can be obtained.

SearchCondition

Query Instance Criteria

Used by actions: GetOfflineInstanceList.

Name	Type	Required	Description
Instance	SearchConditionInstanceNew	Yes	Query Framework, Required
Keyword	String	No	Query Keyword (Task ID exact match, Task Name fuzzy match), Optional
Sort	String	No	Sorting Order (asc, desc)
SortCol	String	No	Sort Column (costTime Runtime duration, startTime Start Time, state Instance status, curRunDate Data Timestamp)

SearchConditionInstanceNew

Search condition

Used by actions: GetOfflineDIInstanceList, GetOfflineInstanceList.

Name	Type	Required	Description
ExecutionSpace	String	Yes	Execution space, optional "DRY_RUN"
ProductName	String	No	Business Products, options: <DATA_DEV / DATA_QUALITY / DATA_INTEGRATION, default DATA_DEV. Non-empty. Default own project
ResourceGroup	String	No	Resource Group Information, optional

SearchConditionNew

Query Instance Criteria (new)

Used by actions: GetOfflineDIInstanceList.

Name	Type	Required	Description
Instance	SearchConditionInstanceNew	Yes	Query Framework, required
Keyword	String	No	Query keyword (Task ID exact match, Task Name fuzzy match), optional
Sort	String	No	Sorting Order (asc, desc)
SortCol	String	No	Sort Column (costTime Runtime duration, startTime Start Time, state Instance status, curRunDate Data Timestamp)

SimpleColumnInfo

Lineage Column Description

Used by actions: DescribeColumnLineage.

Name	Type	Description
Id	String	Column ID Note: This field may return null, indicating that no valid value can be obtained.
QualifiedName	String	Qualified Name Note: This field may return null, indicating that no valid value can be obtained.
ColumnName	String	Column nameNote: This field may return null, indicating that no valid value can be obtained.
ColumnNameCn	String	Column Chinese Name Note: This field may return null, indicating that no valid value can be obtained.
ColumnType	String	Column Type Note: This field may return null, indicating that no valid value can be obtained.
Description	String	Column Description Note: This field may return null, indicating that no valid value can be obtained.
PrefixPath	String	Prefix Path Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
ModifyTime	String	Modification TimeNote: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
DownStreamCount	Integer	Downstream Quantity Note: This field may return null, indicating that no valid value can be obtained.
UpStreamCount	Integer	Upstream Quantity Note: This field may return null, indicating that no valid value can be obtained.
RelationParams	String	Relationship Parameters Note: This field may return null, indicating that no valid value can be obtained.
Params	String	ParameterNote: This field may return null, indicating that no valid value can be obtained.
Tasks	Array of String	Task Collection Note: This field may return null, indicating that no valid value can be obtained.

SimpleTaskInfo

Simple Task Information

Used by actions: FreezeOpsTasks.

Name	Type	Required	Description
TaskId	String	Yes	Task ID
TaskName	String	Yes	Task Name

SourceFieldInfo

Upstream Node Field Information

Used by actions: GenHiveTableDDLSql.

Name	Type	Required	Description
FieldName	String	No	Field Name
FieldType	String	No	Field Type
Alias	String	No	Field Alias
Comment	String	No	Field DescriptionNote: This field may return null, indicating that no valid value can be obtained.

SpeedValue

Speed Value Object

Used by actions: DescribeRealTimeTaskSpeed.

Name	Type	Description
Time	Integer	Timestamp with MillisecondsNote: This field may return null, indicating that no valid value can be obtained.
Speed	Float	NoNote: This field may return null, indicating that no valid value can be obtained.

SqlExpression

Data Quality Custom Rule's SQL Expression Resolved Object

Used by actions: DescribeRuleTemplate, DescribeRuleTemplates.

Name	Type	Description
TableExpressions	Array of SqlExpressionTable	SQL Expression Table Name Note: This field may return null, indicating that no valid value can be obtained.
ParamExpressions	Array of String	SQL Expression Column Name Note: This field may return null, indicating that no valid value can be obtained.

SqlExpressionTable

Parsing table object for SQL expression when defining Data Quality Custom Rules

Used by actions: DescribeRuleTemplate, DescribeRuleTemplates.

Name	Type	Description
TableExpression	String	SQL expression table name Note: This field may return null, indicating that no valid value can be obtained.
ColumnExpression	Array of String	SQL expression column name Note: This field may return null, indicating that no valid value can be obtained.

StageCloudApiRequest

Used by actions: SubmitTaskTestRun.

Name	Type	Required	Description
ClusterId	String	No	No
StageId	String	No	No
JobId	String	No	No
StageName	String	No	No
Type	String	No	No
Mode	String	No	No
Version	String	No	No
Queue	String	No	No
Content	String	No	No
Parameters	Array of Property	No	No
Description	String	No	No
ProjectId	String	No	No
JobType	String	No	No
WorkFlowId	String	No	No

StartTaskInfo

Batch Run Integration Task Configuration

Used by actions: BatchStartIntegrationTasks.

Name	Type	Required	Description
Event	String	No	Batch task type, for example, START, TIMESTAMP, RESTORE, RESUME, etc.\nNote: This field may return null, indicating that no valid value can be obtained.
TaskIds	Array of String	No	Task Id list\nNote: This field may return null, indicating that no valid value can be obtained.
Config	Array of RecordField	No	Batch task configuration, currently only used for real-time integration based on time point startup. For time point startup, a RecordField configuration with name=timestamp, value=specific timestamp needs to be set\nNote: This field may return null, indicating that no valid value can be obtained.
Description	String	No	Operation TypeNote: This field may return null, indicating that no valid value can be obtained.

StrToStrMap

map

Used by actions: CreateOpsMakePlan, DescribeOpsMakePlans.

Name	Type	Required	Description
K	String	No	k Note: This field may return null, indicating that no valid value can be obtained.
V	String	No	v Note: This field may return null, indicating that no valid value can be obtained.

SubmitWorkflow

Submit Workflow Entity

Used by actions: SubmitWorkflow.

Name	Type	Description
TaskIds	Array of String	Submitted Task ID Collection Note: This field may return null, indicating that no valid value can be obtained.
Result	Boolean	Execution Result
ErrorDesc	String	Execution Status Remarks Note: This field may return null, indicating that no valid value can be obtained.
ErrorId	String	Execution Status ID Note: This field may return null, indicating that no valid value can be obtained.

SubscribeReceiver

Subscription Recipient

Used by actions: CreateRule, DescribeRule, DescribeRuleGroupSubscription, DescribeRules, ModifyRuleGroupSubscription.

Name	Type	Required	Description
ReceiverUserId	Integer	No	Recipient Uin Note: This field may return null, indicating that no valid value can be obtained.
ReceiverName	String	No	Recipient Name Note: This field may return null, indicating that no valid value can be obtained.
ReceiverUserIdStr	String	No	Recipient UIN Note: This field may return null, indicating that no valid value can be obtained.

SubscribeWebHook

Group Robot Subscription Configuration

Used by actions: CreateRule, DescribeRule, DescribeRuleGroupSubscription, DescribeRules, ModifyRuleGroupSubscription.

Name	Type	Required	Description
HookType	String	No	Group Robot Type, currently supports Feishu Note: This field may return null, indicating that no valid value can be obtained.
HookAddress	String	No	Group Robot Webhook Address, configuration method refer to https://www.tencentcloud.com/document/product/1254/70736?from_cn_redirect=1 Note: This field may return null, indicating that no valid value can be obtained.

Table

Used by actions: DiagnosePro.

Name	Type	Required	Description
Column	Array of ColumnItem	No	1 Note: This field may return null, indicating that no valid value can be obtained.
Data	Array of ColumnData	No	1 Note: This field may return null, indicating that no valid value can be obtained.

TableBaseInfo

Information Required for Creating DLC Table

Used by actions: GenHiveTableDDLSql.

Name	Type	Required	Description
DatabaseName	String	No	Database nameNote: This field may return null, indicating that no valid value can be obtained.
TableName	String	No	Table NameNote: This field may return null, indicating that no valid value can be obtained.
DatasourceConnectionName	String	No	Data Table's Data Source Name Note: This field may return null, indicating that no valid value can be obtained.
TableComment	String	No	Table Remarks Note: This field may return null, indicating that no valid value can be obtained.
Type	String	No	TypeNote: This field may return null, indicating that no valid value can be obtained.
TableFormat	String	No	Data Format Type Note: This field may return null, indicating that no valid value can be obtained.
UserAlias	String	No	User Nickname Note: This field may return null, indicating that no valid value can be obtained.
UserSubUin	String	No	Table Creation User ID Note: This field may return null, indicating that no valid value can be obtained.
GovernPolicy	DlcDataGovernPolicy	No	Data Governance Configuration ItemsNote: This field may return null, indicating that no valid value can be obtained.
DbGovernPolicyIsDisable	String	No	Is Database Data Governance disabled, true for disabled, false for enabled Note: This field may return null, indicating that no valid value can be obtained.

TableBasicInfo

Table Metadata Information

Used by actions: DescribeTableBasicInfo.

Name	Type	Description
TableId	String	Global Unique ID of the Table Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	Data Source Global Unique ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceName	String	Data Source Name Note: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	Database ID Note: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	Database nameNote: This field may return null, indicating that no valid value can be obtained.
TableName	String	Table NameNote: This field may return null, indicating that no valid value can be obtained.
EngineType	String	Engine/Storage Type Note: This field may return null, indicating that no valid value can be obtained.
TableType	String	Table Types, such as View, External Table, etc. Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	Project IDNote: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	Project Name in English Note: This field may return null, indicating that no valid value can be obtained.
ProjectDisplayName	String	Project English and Chinese Name Note: This field may return null, indicating that no valid value can be obtained.
TableOwnerId	String	Responsible Person ID Note: This field may return null, indicating that no valid value can be obtained.
TableOwnerName	String	Person in Charge Note: This field may return null, indicating that no valid value can be obtained.
StorageLocation	Integer	Storage locationNote: This field may return null, indicating that no valid value can be obtained.
Description	String	Table Description Note: This field may return null, indicating that no valid value can be obtained.
IsPartitionTable	Integer	Whether it is a partitioned table, 0-Full Table 1-Partition Table Note: This field may return null, indicating that no valid value can be obtained.
PartitionColumns	Array of String	Partition field list Note: This field may return null, indicating that no valid value can be obtained.
StorageFormat	String	Storage Format Note: This field may return null, indicating that no valid value can be obtained.
StorageSize	Integer	Storage Volume, Byte Count Note: This field may return null, indicating that no valid value can be obtained.
StorageSizeWithUnit	String	Storage Volume, Unit Note: This field may return null, indicating that no valid value can be obtained.
TotalSizeMb	Integer	Cumulative storage [MB] Note: This field may return null, indicating that no valid value can be obtained.
ReplicaCount	Integer	Replica quantityNote: This field may return null, indicating that no valid value can be obtained.
FileCount	Integer	Number of Files Note: This field may return null, indicating that no valid value can be obtained.
PartitionCount	Integer	Total Partitions (including hive, iceberg) Note: This field may return null, indicating that no valid value can be obtained.
PartitionFieldCount	Integer	Number of partition fields (including hive, iceberg) Note: This field may return null, indicating that no valid value can be obtained.
PartitionExpireDays	Integer	Lifecycle - Partition Retention Days [Effective during Partition Retention Policy] Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	Update timeNote: This field may return null, indicating that no valid value can be obtained.
Location	String	Storage locationNote: This field may return null, indicating that no valid value can be obtained.

TableConfig

Rule Table Variable Replacement

Used by actions: CreateRule, DescribeRule, DescribeRules, ModifyRule.

Name	Type	Required	Description
DatabaseId	String	No	Database ID Note: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	No	Database nameNote: This field may return null, indicating that no valid value can be obtained.
TableId	String	No	Table ID Note: This field may return null, indicating that no valid value can be obtained.
TableName	String	No	Table Name Note: This field may return null, indicating that no valid value can be obtained.
TableKey	String	No	Table Key Note: This field may return null, indicating that no valid value can be obtained.
FieldConfig	Array of FieldConfig	No	Field Variable Note: This field may return null, indicating that no valid value can be obtained.

TableHeat

Heat value of the table in the past seven days (excluding today)

Used by actions: DescribeTableMeta, DescribeTableMetas.

Name	Type	Description
TableId	String	Table IDNote: This field may return null, indicating that no valid value can be obtained.
DayTime	Timestamp ISO8601	Statistics DateNote: This field may return null, indicating that no valid value can be obtained.
Heat	Float	Popularity Note: This field may return null, indicating that no valid value can be obtained.
MaxHeat	Float	Maximum Popularity Note: This field may return null, indicating that no valid value can be obtained.

TableInfo

Metadata Table Details

Used by actions: DescribeTableInfoList.

Name	Type	Description
TableId	String	Table ID Note: This field may return null, indicating that no valid value can be obtained.
TableName	String	Table Name Note: This field may return null, indicating that no valid value can be obtained.
OriginDatabaseName	String	Table databaseName Note: This field may return null, indicating that no valid value can be obtained.
OriginSchemaName	String	Table schemaName Note: This field may return null, indicating that no valid value can be obtained.

TableLineageBaseInfo

Table Lineage Details

Used by actions: DescribeTableLineageInfo.

Name	Type	Required	Description
MetastoreType	String	Yes	Metadata Type Note: This field may return null, indicating that no valid value can be obtained.
PrefixPath	String	Yes	Path from Central Node to this Node Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	No	Space ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	No	Data source IDNote: This field may return null, indicating that no valid value can be obtained.
TableId	String	No	Table ID Note: This field may return null, indicating that no valid value can be obtained.
Params	Array of LineageParamRecord	No	Table Lineage Parameters Note: This field may return null, indicating that no valid value can be obtained.
ParentSet	String	No	Parent Node List Note: This field may return null, indicating that no valid value can be obtained.
ChildSet	String	No	Child Node List Note: This field may return null, indicating that no valid value can be obtained.
ExtParams	Array of RecordField	No	Additional parameters Note: This field may return null, indicating that no valid value can be obtained.
Id	String	No	Lineage ID Note: This field may return null, indicating that no valid value can be obtained.
MetastoreTypeName	String	No	Metadata Type Name Note: This field may return null, indicating that no valid value can be obtained.
TableName	String	No	Table Name Note: This field may return null, indicating that no valid value can be obtained.
QualifiedName	String	No	Full Table Name Note: This field may return null, indicating that no valid value can be obtained.
DownStreamCount	Integer	No	Number of Downstream Nodes in Lineage Note: This field may return null, indicating that no valid value can be obtained.
UpStreamCount	Integer	No	Number of Upstream Nodes in Lineage Note: This field may return null, indicating that no valid value can be obtained.
Description	String	No	Bloodline Description Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Bloodline Creation Time Note: This field may return null, indicating that no valid value can be obtained.
ModifyTime	String	No	Bloodline Update Time Note: This field may return null, indicating that no valid value can be obtained.
Tasks	Array of String	No	Modify the task ID list of lineage Note: This field may return null, indicating that no valid value can be obtained.

TableLineageInfo

Table Lineage Details

Used by actions: DescribeTableLineage, DescribeTableLineageInfo.

Name	Type	Required	Description
MetastoreType	String	Yes	Metadata Type Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	No	Space ID Note: This field may return null, indicating that no valid value can be obtained.
DatasourceId	String	No	Data source ID Note: This field may return null, indicating that no valid value can be obtained.
TableId	String	No	Table ID Note: This field may return null, indicating that no valid value can be obtained.
Params	Array of LineageParamRecord	No	Table Lineage Parameters Note: This field may return null, indicating that no valid value can be obtained.
ParentSet	String	No	Parent Node List Note: This field may return null, indicating that no valid value can be obtained.
ChildSet	String	No	Child Node List Note: This field may return null, indicating that no valid value can be obtained.
ExtParams	Array of RecordField	No	Additional parameters Note: This field may return null, indicating that no valid value can be obtained.
Id	String	No	Lineage ID Note: This field may return null, indicating that no valid value can be obtained.
MetastoreTypeName	String	No	Metadata Type Name Note: This field may return null, indicating that no valid value can be obtained.
TableName	String	No	Table name Note: This field may return null, indicating that no valid value can be obtained.
QualifiedName	String	No	Full Table Name Note: This field may return null, indicating that no valid value can be obtained.
DownStreamCount	Integer	No	Number of Downstream Nodes in Lineage Note: This field may return null, indicating that no valid value can be obtained.
UpStreamCount	Integer	No	Number of Upstream Nodes in Lineage Note: This field may return null, indicating that no valid value can be obtained.
Description	String	No	Bloodline Description Note: This field may return null, indicating that no valid value can be obtained.
PrefixPath	String	No	Path from the central node to this node Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Bloodline Creation Time Note: This field may return null, indicating that no valid value can be obtained.
ModifyTime	String	No	Bloodline Update Time Note: This field may return null, indicating that no valid value can be obtained.
Tasks	Array of String	No	List of task IDs for modifying bloodline Note: This field may return null, indicating that no valid value can be obtained.
ChannelType	String	No	Module/Application Type Note: This field may return null, indicating that no valid value can be obtained.
DisplayType	String	No	Display Type Note: This field may return null, indicating that no valid value can be obtained.
EngineType	String	No	Table Types Note: This field may return null, indicating that no valid value can be obtained.
TableType	String	No	Table Types Note: This field may return null, indicating that no valid value can be obtained.
DatasourceName	String	No	datasourceName Note: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	No	DatabaseName Note: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	No	DatabaseId Note: This field may return null, indicating that no valid value can be obtained.

TableMeta

Table Metadata Information

Used by actions: DescribeTableMeta, DescribeTableMetas.

Name	Type	Description
TableId	String	Global Unique ID of the Table Note: This field may return null, indicating that no valid value can be obtained.
TableName	String	Table NameNote: This field may return null, indicating that no valid value can be obtained.
TableOwnerName	String	Person in ChargeNote: This field may return null, indicating that no valid value can be obtained.
DatasourceId	Integer	Data Source Global Unique ID Note: This field may return null, indicating that no valid value can be obtained.
ClusterName	String	Cluster Name Note: This field may return null, indicating that no valid value can be obtained.
DatasourceName	String	Data Source Name Note: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	Database nameNote: This field may return null, indicating that no valid value can be obtained.
TablePath	String	Table Path Note: This field may return null, indicating that no valid value can be obtained.
TableNameCn	String	Chinese Table Name Note: This field may return null, indicating that no valid value can be obtained.
MetastoreId	Integer	Metadata Tenant ID Note: This field may return null, indicating that no valid value can be obtained.
MetastoreType	String	Technology Type, available values: HIVE,MYSQL,KAFKA, HBASE Note: This field may return null, indicating that no valid value can be obtained.
Description	String	Table Description Note: This field may return null, indicating that no valid value can be obtained.
ColumnSeparator	String	Column Separator Note: This field may return null, indicating that no valid value can be obtained.
StorageFormat	String	Storage Format Note: This field may return null, indicating that no valid value can be obtained.
StorageSize	Integer	Storage Volume, Byte Count Note: This field may return null, indicating that no valid value can be obtained.
TableType	String	Table Types, such as hive MANAGED_TABLE;EXTERNAL_TABLE Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	Timestamp ISO8601	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
ModifyTime	Timestamp ISO8601	Latest Data Modification Time Note: This field may return null, indicating that no valid value can be obtained.
DdlModifyTime	Timestamp ISO8601	Latest DDL Modification Time Note: This field may return null, indicating that no valid value can be obtained.
LastAccessTime	Timestamp ISO8601	Last Access Time of Data Note: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	Project Name in English Note: This field may return null, indicating that no valid value can be obtained.
BizCatalogIds	Array of String	Data Directory ID (may be multiple) Note: This field may return null, indicating that no valid value can be obtained.
BizCatalogNames	Array of String	Data Directory (may be multiple) Note: This field may return null, indicating that no valid value can be obtained.
HasFavorite	Boolean	true for Favorited/false indicates not favorited Note: This field may return null, indicating that no valid value can be obtained.
LifeCycleTime	Integer	LifecycleNote: This field may return null, indicating that no valid value can be obtained.
StorageSizeWithUnit	String	Storage Volume, displayed in appropriate units Note: This field may return null, indicating that no valid value can be obtained.
InstanceId	String	Instance ID of the Data Source Engine: e.g., EMR Cluster Instance ID/Data Source Instance ID Note: This field may return null, indicating that no valid value can be obtained.
TechnologyType	String	Data Source Technology Type: HIVE/MYSQL/HBASE/KAFKA etc. Note: This field may return null, indicating that no valid value can be obtained.
TableNameEn	String	Table English Name Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	Project IDNote: This field may return null, indicating that no valid value can be obtained.
Partitions	String	Number of partitions in Kafka Topic Note: This field may return null, indicating that no valid value can be obtained.
ReplicationFactor	String	Number of replicas in Kafka Topic Note: This field may return null, indicating that no valid value can be obtained.
ProjectDisplayName	String	Project English and Chinese Name Note: This field may return null, indicating that no valid value can be obtained.
DataModifyTime	Timestamp ISO8601	Last Modified Time of Data Note: This field may return null, indicating that no valid value can be obtained.
ClusterId	String	Cluster ID Note: This field may return null, indicating that no valid value can be obtained.
HasAdminAuthority	Boolean	Current user has Administrator Privileges Note: This field may return null, indicating that no valid value can be obtained.
DatasourceDisplayName	String	Data Source Display Name Note: This field may return null, indicating that no valid value can be obtained.
DatabaseId	String	Database ID Note: This field may return null, indicating that no valid value can be obtained.
FavoriteCount	Integer	Total favorites on the table under the tenant Note: This field may return null, indicating that no valid value can be obtained.
LikeCount	Integer	Total likes on the table under the tenant Note: This field may return null, indicating that no valid value can be obtained.
HasLike	Boolean	true for liked/false for not liked status Note: This field may return null, indicating that no valid value can be obtained.
TablePropertyScore	TablePropertyScore	Asset score of the table Note: This field may return null, indicating that no valid value can be obtained.
TableHeat	TableHeat	Heat value of the table Note: This field may return null, indicating that no valid value can be obtained.
OwnerProjectId	String	Data source ownerProjectId Note: This field may return null, indicating that no valid value can be obtained.
TableOwnerId	String	Table Owner ID Note: This field may return null, indicating that no valid value can be obtained.
DataSourceCategory	String	System Source -CLUSTER, DB - Self Definition Source Note: This field may return null, indicating that no valid value can be obtained.
Columns	Array of SearchColumnDocVO	Table Field Information Note: This field may return null, indicating that no valid value can be obtained.
MetaCrawlType	String	Table Collection Type TABLE, VIEW, MANAGED_TABLE (Hive managed table), EXTERNAL_TABLE (Hive external table), VIRTUAL_VIEW (virtual view), MATERIALIZED_VIEW (materialized view), LATERAL_VIEW, INDEX_TABLE (index table), END_SELECT (query structure), INSTANCE (intermediate temporary table type (data lineage)), CDW (CDW table type) Note: This field may return null, indicating that no valid value can be obtained.
IsView	Boolean	Is View Note: This field may return null, indicating that no valid value can be obtained.
Location	String	Storage locationNote: This field may return null, indicating that no valid value can be obtained.
IsPartitionTable	Integer	Determine if it is a partitioned table 1 Yes 0 No Note: This field may return null, indicating that no valid value can be obtained.
PartitionColumns	Array of String	Partition Field Key Note: This field may return null, indicating that no valid value can be obtained.
PartitionExpireDays	Integer	Lifecycle - Partition Retention Days [Valid when Partition Retention Policy is applied] Note: This field may return null, indicating that no valid value can be obtained.
TableProperties	Array of TableMetaProperty	Table Ancillary Information Note: This field may return null, indicating that no valid value can be obtained.

TableMetaProperty

Table Ancillary Information

Used by actions: DescribeTableMeta, DescribeTableMetas.

Name	Type	Description
Key	String	Attribute Key Note: This field may return null, indicating that no valid value can be obtained.
Value	String	Attribute Value Note: This field may return null, indicating that no valid value can be obtained.

TableNameFilter

Query conditions by Table Name

Used by actions: DescribeTableMeta.

Name	Type	Required	Description
MsType	String	No	Data source type
DatasourceId	Integer	No	Data source ID
DatabaseName	String	No	Database name
SchemaName	String	No	schema
Name	String	No	Table name

TablePropertyScore

Asset Rating of the table updated by day

Used by actions: DescribeTableMeta, DescribeTableMetas.

Name	Type	Description
TableId	String	Table ID
DayTime	Timestamp ISO8601	Statistics Date
Integrity	Float	Table Integrity Score
Safety	Float	Table Assurance Score
Timeliness	Float	Table Timeliness Score
Stability	Float	Table Stability Score
Normative	Float	Table Normalization Score
Average	Float	Average Asset Score

TableQualityDetail

Table Quality Details

Used by actions: DescribeTableQualityDetails.

Name	Type	Description
DatabaseId	String	Database ID Note: This field may return null, indicating that no valid value can be obtained.
DatabaseName	String	Database nameNote: This field may return null, indicating that no valid value can be obtained.
TableId	String	Table ID Note: This field may return null, indicating that no valid value can be obtained.
TableName	String	Table Name Note: This field may return null, indicating that no valid value can be obtained.
OwnerUserId	Integer	Table Owner ID Note: This field may return null, indicating that no valid value can be obtained.
OwnerUserName	String	Table Owner Name Note: This field may return null, indicating that no valid value can be obtained.
DatabaseScore	Float	Database Score Note: This field may return null, indicating that no valid value can be obtained.
TableScore	Float	Table Score Note: This field may return null, indicating that no valid value can be obtained.
LastPeriodRatio	Float	Table Month-over-Month Growth Note: This field may return null, indicating that no valid value can be obtained.
DsEnvType	Integer	0 or not returned or null: Undefined, 1: Production, 2: Development Note: This field may return null, indicating that no valid value can be obtained.

TableQualityDetailPage

Table Quality Scoring Pagination Results

Used by actions: DescribeTableQualityDetails.

Name	Type	Description
TotalCount	Integer	Total number of items Note: This field may return null, indicating that no valid value can be obtained.
Items	Array of TableQualityDetail	Table Quality List Note: This field may return null, indicating that no valid value can be obtained.

TableScoreStatisticsInfo

Table Scoring Statistics

Used by actions: DescribeQualityScore.

Name	Type	Description
Level	Integer	Levels 1,2,3,4,5 Note: This field may return null, indicating that no valid value can be obtained.
Scale	Integer	PercentageNote: This field may return null, indicating that no valid value can be obtained.
TableNumber	Integer	Table quantityNote: This field may return null, indicating that no valid value can be obtained.

TaskAlarmInfo

Task Alert Information

Used by actions: BatchCreateIntegrationTaskAlarms, CreateTaskAlarmRegular, DescribeTaskAlarmRegulations, ModifyTaskAlarmRegular.

Name	Type	Required	Description
TaskId	String	Yes	Task ID
RegularName	String	Yes	Rule name
RegularStatus	Integer	Yes	Rule Status (0 for off, 1 for on)
AlarmLevel	Integer	Yes	Alert Level (0 for general, 1 for critical, 2 for urgent)
AlarmWay	String	Yes	Alert Method, separated by commas (1: email, 2: SMS, 3: WeChat, 4: voice call, 5: represents WeCom, 6: http)
TaskType	Integer	Yes	Task Type (201 for real-time, 202 for offline)
Id	String	No	ID Note: This field may return null, indicating that no valid value can be obtained.
RegularId	String	No	Rule ID
AlarmIndicator	Integer	No	Alert Metrics, 0 for task failure, 1 for task run timeout, 2 for task stop, 3 for task pause,4 Write Speed, 5 Read Speed, 6 Read Throughput, 7 Write Throughput, 8 Dirty Data Byte Count, 9 Number of Dirty Data Entries
TriggerType	Integer	No	Metric Threshold (1 for the first run failure of an offline task, 2 for all retries failed of an offline task) Note: This field may return null, indicating that no valid value can be obtained.
EstimatedTime	Integer	No	Estimated Timeout Duration (Minute Level) Note: This field may return null, indicating that no valid value can be obtained.
AlarmRecipientId	String	No	Alert Recipient ID, separated by commas
ProjectId	String	No	Project IDNote: This field may return null, indicating that no valid value can be obtained.
Creater	String	No	CreatorNote: This field may return null, indicating that no valid value can be obtained.
AlarmRecipientName	String	No	Alert Recipient Nickname, separated by commas Note: This field may return null, indicating that no valid value can be obtained.
AlarmIndicatorDesc	String	No	Alert Metric Description Note: This field may return null, indicating that no valid value can be obtained.
Operator	Integer	No	Parameters needed for real-time task alerts, 1 is greater than, 2 is less than Note: This field may return null, indicating that no valid value can be obtained.
NodeId	String	No	Node ID, separated by commas Note: This field may return null, indicating that no valid value can be obtained.
NodeName	String	No	Node name, separated by commas Note: This field may return null, indicating that no valid value can be obtained.
AlarmIndicatorInfos	Array of AlarmIndicatorInfo	No	Metric List Note: This field may return null, indicating that no valid value can be obtained.
AlarmRecipientType	Integer	No	Alert Recipient Type, 0 is designated person; 1 is task responsible person Note: This field may return null, indicating that no valid value can be obtained.
QuietPeriods	Array of QuietPeriod	No	Do not disturb time Note: This field may return null, indicating that no valid value can be obtained.
WeComHook	String	No	Enterprise WeChat Group Hook Address, multiple hook addresses separated by commas Note: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	No	Last Operation Time Note: This field may return null, indicating that no valid value can be obtained.
OperatorUin	String	No	Last Operator Uin Note: This field may return null, indicating that no valid value can be obtained.
TaskCount	Integer	No	Associated Task Count Note: This field may return null, indicating that no valid value can be obtained.
MonitorType	Integer	No	Monitored Object Type, 1: all tasks, 2: specified tasks, 3: specified responsible person Note: This field may return null, indicating that no valid value can be obtained.
MonitorObjectIds	Array of String	No	Monitoring Object List Note: This field may return null, indicating that no valid value can be obtained.
LatestAlarmInstanceId	String	No	Instance ID of the Last Alert Note: This field may return null, indicating that no valid value can be obtained.
LatestAlarmTime	String	No	Time of the Last Alert Note: This field may return null, indicating that no valid value can be obtained.
Description	String	No	Alert Rule Description Note: This field may return null, indicating that no valid value can be obtained.
LarkWebHooks	String	No	FeiShu Group Hook Address, multiple hook addresses separated by commas Note: This field may return null, indicating that no valid value can be obtained.
DingDingWebHooks	String	No	DingTalk Group Hook addresses, multiple hook addresses separated by commas Note: This field may return null, indicating that no valid value can be obtained.

TaskByCycle

Cycle Unit Statistics

Used by actions: DescribeInstanceByCycle, DescribeTaskByCycle.

Name	Type	Required	Description
Number	Integer	No	num Note: This field may return null, indicating that no valid value can be obtained.
CycleUnit	String	No	Cycle Unit Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	No	Project ID Note: This field may return null, indicating that no valid value can be obtained.

TaskByStatus

Status Trend Statistics

Used by actions: DescribeTaskByCycleReport, DescribeTaskByStatusReport.

Name	Type	Required	Description
CountGroup	String	No	Statistical Value Note: This field may return null, indicating that no valid value can be obtained.
ShowTimeGroup	String	No	DateNote: This field may return null, indicating that no valid value can be obtained.
Status	String	No	StatusNote: This field may return null, indicating that no valid value can be obtained.
CycleUnit	String	No	Cycle Unit Note: This field may return null, indicating that no valid value can be obtained.
ReportTime	String	No	1
Count	Integer	No	1

TaskExtInfo

Task Extension Information

Used by actions: CreateTask, ModifyTaskInfo.

Name	Type	Required	Description
Key	String	No	Key
Value	String	No	Value

TaskInnerInfo

Task Attributes

Used by actions: ModifyTaskInfo.

Name	Type	Required	Description
TaskId	String	Yes	Task ID
TaskName	String	Yes	Task Name
WorkflowId	String	Yes	Workflow ID
CycleType	Integer	Yes	Cycle Type 0: Crontab Type, 1: minutes, 2: Hour, 3: Days, 4: Weekly, 5: Month, 6: One-time, 7: User-driven, 10: Elastic Cycle (Week), 11: Elastic Cycle (Month), 12: Year, 13: Instant Trigger (Instant Type), isolated from normal cyclic scheduling tasks
VirtualTaskId	String	No	Virtual Task ID Note: This field may return null, indicating that no valid value can be obtained.
VirtualFlag	Boolean	No	Virtual Task Marker Note: This field may return null, indicating that no valid value can be obtained.
RealWorkflowId	String	No	Real Task Workflow ID Note: This field may return null, indicating that no valid value can be obtained.

TaskInstanceCountDto

Task Instance Status Statistics

Used by actions: CountOpsInstanceState.

Name	Type	Description
Success	Integer	Number of Successful Instances
Running	Integer	Number of Instances in Execution
Waiting	Integer	Number of Instances Waiting
Depend	Integer	Number of Instances Waiting for Upstream
Failed	Integer	Failed Instance Count
Stopped	Integer	Permanently Terminated Instance Count

TaskLockStatus

Task Lock Status

Used by actions: DescribeTaskLockStatus.

Name	Type	Description
TaskId	String	Task ID
Locker	String	Lock Holder
IsLocker	Integer	Is the current operating user the lock holder? 1 means yes, 0 means no
IsRob	Integer	Is lock contention possible? 1 means yes, 0 means no

TaskOpsDto

Task Operation Details

Used by actions: DescribeAllByFolderNew, DescribeDependTaskLists, DescribeEventConsumeTasks, DescribeOperateOpsTasks, DescribeOpsMakePlanTasks, DescribeSuccessorOpsTaskInfos, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId.

Name	Type	Required	Description
TaskId	String	Yes	Task IDNote: This field may return null, indicating that no valid value can be obtained.
VirtualTaskId	String	Yes	Virtual Task ID Note: This field may return null, indicating that no valid value can be obtained.
VirtualFlag	Boolean	Yes	Virtual Task Marker Note: This field may return null, indicating that no valid value can be obtained.
TaskName	String	Yes	Task NameNote: This field may return null, indicating that no valid value can be obtained.
WorkflowId	String	Yes	Workflow IDNote: This field may return null, indicating that no valid value can be obtained.
RealWorkflowId	String	Yes	Actual Workflow ID when the task is a virtual task Note: This field may return null, indicating that no valid value can be obtained.
WorkflowName	String	Yes	Workflow nameNote: This field may return null, indicating that no valid value can be obtained.
FolderId	String	Yes	Folder ID Note: This field may return null, indicating that no valid value can be obtained.
FolderName	String	Yes	Folder Name Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Yes	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
LastUpdate	String	Yes	Latest Update Time Note: This field may return null, indicating that no valid value can be obtained.
Status	String	Yes	Task StatusNote: This field may return null, indicating that no valid value can be obtained.
InCharge	String	Yes	Person in ChargeNote: This field may return null, indicating that no valid value can be obtained.
InChargeId	String	Yes	Responsible User ID Note: This field may return null, indicating that no valid value can be obtained.
StartTime	String	Yes	Scheduling Effective Date Note: This field may return null, indicating that no valid value can be obtained.
EndTime	String	Yes	Scheduling End Date Note: This field may return null, indicating that no valid value can be obtained.
ExecutionStartTime	String	Yes	Execution Time Left Closed Interval Note: This field may return null, indicating that no valid value can be obtained.
ExecutionEndTime	String	Yes	Execution Time Right Closed Interval Note: This field may return null, indicating that no valid value can be obtained.
CycleType	String	Yes	Cycle Type Note: This field may return null, indicating that no valid value can be obtained.
CycleStep	Integer	Yes	Step Length Note: This field may return null, indicating that no valid value can be obtained.
CrontabExpression	String	Yes	Scheduling Cron Expression Note: This field may return null, indicating that no valid value can be obtained.
DelayTime	Integer	Yes	Delayed Execution Time, unit=minutes Note: This field may return null, indicating that no valid value can be obtained.
StartupTime	Integer	Yes	Start Execution Time Note: This field may return null, indicating that no valid value can be obtained.
RetryWait	Integer	Yes	Retry Wait Time, unit=minutes Note: This field may return null, indicating that no valid value can be obtained.
RetryAble	Integer	Yes	Whether to Retry, 1 represents retryable Note: This field may return null, indicating that no valid value can be obtained.
TaskAction	String	Yes	Scheduling Configuration - Elastic Cycle Configuration, available for Hour/Weekly/Month/Year schedules. For hourly tasks scheduled at 0, 3, 4 o'clock, it would be '0,3,4' Note: This field may return null, indicating that no valid value can be obtained.
TryLimit	Integer	Yes	Limit on Number of Runs Note: This field may return null, indicating that no valid value can be obtained.
RunPriority	Integer	Yes	Running Priority Note: This field may return null, indicating that no valid value can be obtained.
TaskType	TaskTypeOpsDto	Yes	Task TypeNote: This field may return null, indicating that no valid value can be obtained.
BrokerIp	String	Yes	Specified Running Nodes Note: This field may return null, indicating that no valid value can be obtained.
ClusterId	String	Yes	Cluster Name Note: This field may return null, indicating that no valid value can be obtained.
MinDateTime	String	Yes	Minimum Data Time Note: This field may return null, indicating that no valid value can be obtained.
MaxDateTime	String	Yes	Maximum Data Time Note: This field may return null, indicating that no valid value can be obtained.
ExecutionTTL	Integer	Yes	Runtime Timeout Note: This field may return null, indicating that no valid value can be obtained.
SelfDepend	String	Yes	Self-Dependency Type Note: This field may return null, indicating that no valid value can be obtained.
LeftCoordinate	Float	Yes	Left Coordinate Note: This field may return null, indicating that no valid value can be obtained.
TopCoordinate	Float	Yes	Top Coordinate Note: This field may return null, indicating that no valid value can be obtained.
Notes	String	Yes	Task Remark Note: This field may return null, indicating that no valid value can be obtained.
InstanceInitStrategy	String	Yes	Task Initialization Strategy Note: This field may return null, indicating that no valid value can be obtained.
YarnQueue	String	Yes	Compute Queue Note: This field may return null, indicating that no valid value can be obtained.
LastSchedulerCommitTime	String	Yes	Latest Schedule Submission Time Note: This field may return null, indicating that no valid value can be obtained.
NormalizedJobStartTime	String	Yes	Task Start Time Calculated by cron Expression Note: This field may return null, indicating that no valid value can be obtained.
SchedulerDesc	String	Yes	Scheduling Plan Description Note: This field may return null, indicating that no valid value can be obtained.
ResourceGroup	String	Yes	Compute Resource Group Note: This field may return null, indicating that no valid value can be obtained.
Creator	String	Yes	Task Creator Note: This field may return null, indicating that no valid value can be obtained.
DependencyRel	String	Yes	Task Dependency Type: and, or Note: This field may return null, indicating that no valid value can be obtained.
DependencyWorkflow	String	Yes	Task Workflow Dependency: yes, no Note: This field may return null, indicating that no valid value can be obtained.
EventListenerConfig	String	Yes	Event Listening Configuration Note: This field may return null, indicating that no valid value can be obtained.
EventPublisherConfig	String	Yes	Event-driven Configuration Note: This field may return null, indicating that no valid value can be obtained.
VirtualTaskStatus	String	Yes	Virtual Task Status Note: This field may return null, indicating that no valid value can be obtained.
TaskLinkInfo	LinkOpsDto	Yes	Task Dependency Edge Details Note: This field may return null, indicating that no valid value can be obtained.
ProductName	String	Yes	Task Product TypeNote: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	Yes	Project IDNote: This field may return null, indicating that no valid value can be obtained.
ProjectIdent	String	Yes	Project IdentifierNote: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	Yes	Project nameNote: This field may return null, indicating that no valid value can be obtained.
OwnId	String	Yes	Main Account userId Note: This field may return null, indicating that no valid value can be obtained.
UserId	String	Yes	User userId Note: This field may return null, indicating that no valid value can be obtained.
TenantId	String	Yes	Tenant ID Note: This field may return null, indicating that no valid value can be obtained.
UpdateUser	String	Yes	Updater's Nickname Note: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	Yes	Update timeNote: This field may return null, indicating that no valid value can be obtained.
UpdateUserId	String	Yes	Updater's userId Note: This field may return null, indicating that no valid value can be obtained.
TaskTypeId	Integer	Yes	Task Type ID Note: This field may return null, indicating that no valid value can be obtained.
TaskTypeDesc	String	Yes	Task Type Description Note: This field may return null, indicating that no valid value can be obtained.
ShowWorkflow	Boolean	Yes	Whether to Display Workflow Note: This field may return null, indicating that no valid value can be obtained.
FirstSubmitTime	String	Yes	First Submission Time Note: This field may return null, indicating that no valid value can be obtained.
FirstRunTime	String	Yes	First Execution Time Note: This field may return null, indicating that no valid value can be obtained.
ScheduleDesc	String	Yes	Scheduling Description Note: This field may return null, indicating that no valid value can be obtained.
CycleNum	Integer	Yes	CycleNote: This field may return null, indicating that no valid value can be obtained.
Crontab	String	Yes	ExpressionsNote: This field may return null, indicating that no valid value can be obtained.
StartDate	String	Yes	Start Date Note: This field may return null, indicating that no valid value can be obtained.
EndDate	String	Yes	End Date Note: This field may return null, indicating that no valid value can be obtained.
CycleUnit	String	Yes	Cycle Unit Note: This field may return null, indicating that no valid value can be obtained.
InitStrategy	String	Yes	Initialization Strategy Note: This field may return null, indicating that no valid value can be obtained.
Layer	String	Yes	Hierarchy Note: This field may return null, indicating that no valid value can be obtained.
SourceServiceId	String	Yes	Source Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
SourceServiceType	String	Yes	Source Data Source Type Note: This field may return null, indicating that no valid value can be obtained.
TargetServiceId	String	Yes	Target Data Source ID Note: This field may return null, indicating that no valid value can be obtained.
TargetServiceType	String	Yes	Target Data Source Type Note: This field may return null, indicating that no valid value can be obtained.
TasksStr	String	Yes	Subtask List Note: This field may return null, indicating that no valid value can be obtained.
Submit	Boolean	Yes	Whether the Task Version Has Been Submitted Note: This field may return null, indicating that no valid value can be obtained.
ExecutorGroupId	String	No	Resource Group IDNote: This field may return null, indicating that no valid value can be obtained.
ExecutorGroupName	String	No	Resource Group NameNote: This field may return null, indicating that no valid value can be obtained.

TaskScriptContent

Task execution script

Used by actions: DescribeTaskScript.

Name	Type	Description
ScriptContent	String	Script content Base64 encoded Note: This field may return null, indicating that no valid value can be obtained.

TaskTag

Task Tag, can be used as a condition for retrieving tasks

Used by actions: DescribeOperateOpsTasks.

Name	Type	Required	Description
TagName	String	Yes	Tag Name
TagValues	Array of String	Yes	Tag Value List

TaskTypeCnt

Used by actions: DescribeSchedulerTaskTypeCnt.

Name	Type	Description
Number	String	Statistical value Note: This field may return null, indicating that no valid value can be obtained.
TaskType	String	Task TypeNote: This field may return null, indicating that no valid value can be obtained.
TypeName	String	Type name Note: This field may return null, indicating that no valid value can be obtained.

TaskTypeMap

Task Type Map

Used by actions: DagInstances, DescribeScheduleInstances, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances.

Name	Type	Required	Description
Key	Integer	No	key
Value	String	No	value

TaskTypeOpsDto

Basic Information of Task Type

Used by actions: DagInstances, DescribeAllByFolderNew, DescribeDependTaskLists, DescribeScheduleInstances, DescribeSuccessorOpsTaskInfos, DescribeTaskRunHistory, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId, DiagnosePro, KillScheduleInstances, RunForceSucScheduleInstances, RunRerunScheduleInstances.

Name	Type	Required	Description
TypeDesc	String	No	Task Type Description Note: This field may return null, indicating that no valid value can be obtained.
TypeId	Integer	No	Task Type ID Note: This field may return null, indicating that no valid value can be obtained.
TypeSort	String	No	Task Type Categorization Note: This field may return null, indicating that no valid value can be obtained.

TaskVersionInstance

Task Instance Basic Information

Used by actions: DescribeIntegrationTask.

Name	Type	Description
InstanceVersion	Integer	Instance Version Number Note: This field may return null, indicating that no valid value can be obtained.
VersionDesc	String	Instance Description Note: This field may return null, indicating that no valid value can be obtained.
ChangeType	Integer	0, "Add",1, "Modify" Note: This field may return null, indicating that no valid value can be obtained.
SubmitterUin	String	Version Submitter UIN Note: This field may return null, indicating that no valid value can be obtained.
InstanceDate	String	Submission Date Note: This field may return null, indicating that no valid value can be obtained.
InstanceStatus	Integer	0, "Disabled",1, "Enabled (Production)" Note: This field may return null, indicating that no valid value can be obtained.

ThresholdValue

Data quality threshold

Used by actions: CommitRuleGroupTask, CreateRule, DescribeRule, DescribeRuleExecDetail, DescribeRuleExecResults, DescribeRuleGroupExecResultsByPage, DescribeRules, ModifyRule.

Name	Type	Required	Description
ValueType	Integer	No	Threshold type 1. Low threshold 2. High threshold 3. Normal threshold 4. Enumerated values Note: This field may return null, indicating that no valid value can be obtained.
Value	String	No	ThresholdNote: This field may return null, indicating that no valid value can be obtained.

TopTableStat

Quality Overview Table Ranking Results

Used by actions: DescribeTopTableStat.

Name	Type	Description
AlarmTables	Array of TopTableStatItem	Alarm Table List
PipelineTables	Array of TopTableStatItem	Block Table List

TopTableStatItem

Quality Overview Table Ranking Elements

Used by actions: DescribeTopTableStat.

Name	Type	Description
TableId	String	Table Id
TableName	String	Table nameNote: This field may return null, indicating that no valid value can be obtained.
Cnt	Integer	Number

UserFileInfo

Development Space - Data Development Script Information Response Body

Used by actions: DeleteFilePath, GetFileInfo.

Name	Type	Required	Description
ResourceId	String	No	Resource ID Note: This field may return null, indicating that no valid value can be obtained.
FileName	String	No	File NameNote: This field may return null, indicating that no valid value can be obtained.
FileExtensionType	String	No	File Type, such as jar, zip, etc. Note: This field may return null, indicating that no valid value can be obtained.
Type	String	No	File Upload Type, Resource Management as resource Note: This field may return null, indicating that no valid value can be obtained.
Md5Value	String	No	File MD5 Value Note: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	No	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
UpdateTime	String	No	Update timeNote: This field may return null, indicating that no valid value can be obtained.
Size	Integer	No	File Size, in bytes Note: This field may return null, indicating that no valid value can be obtained.
LocalPath	String	No	Local Path Note: This field may return null, indicating that no valid value can be obtained.
LocalTempPath	String	No	Local Temporary Path Note: This field may return null, indicating that no valid value can be obtained.
RemotePath	String	No	Remote Path Note: This field may return null, indicating that no valid value can be obtained.
OwnerName	String	No	File Owner's Name Note: This field may return null, indicating that no valid value can be obtained.
Owner	String	No	File owner's uin Note: This field may return null, indicating that no valid value can be obtained.
PathDepth	Integer	No	File depth Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	No	Project IDNote: This field may return null, indicating that no valid value can be obtained.
ExtraInfo	Array of ParamInfo	No	Additional information Note: This field may return null, indicating that no valid value can be obtained.
ZipPath	String	No	Absolute path of local temporary compressed file Note: This field may return null, indicating that no valid value can be obtained.
Bucket	String	No	File's belonging bucket Note: This field may return null, indicating that no valid value can be obtained.
Region	String	No	Region of the file's belonging bucket Note: This field may return null, indicating that no valid value can be obtained.
DeleteName	String	No	NoNote: This field may return null, indicating that no valid value can be obtained.
DeleteOwner	String	No	NoNote: This field may return null, indicating that no valid value can be obtained.
Operator	String	No	NoNote: This field may return null, indicating that no valid value can be obtained.
OperatorName	String	No	NoNote: This field may return null, indicating that no valid value can be obtained.
EncodeExtraInfo	String	No	Additional information base64 encoded Note: This field may return null, indicating that no valid value can be obtained.

WeightInfo

Weight Information

Used by actions: ModifyDimensionWeight.

Name	Type	Required	Description
Weight	Integer	Yes	Weight
QualityDim	Integer	Yes	Dimension Type 1:Accuracy, 2:Uniqueness, 3:Integrity, 4:Consistency, 5:Timeliness, 6:Validity

WorkFlowExecuteDto

Workflow Execution Information

Used by actions: DescribeWorkflowExecuteById.

Name	Type	Required	Description
StartTime	String	No	Start TimeNote: This field may return null, indicating that no valid value can be obtained.
EndTime	String	No	End timeNote: This field may return null, indicating that no valid value can be obtained.
Status	Integer	No	Workflow Execution Status 0: Waiting to run, 1: Running, 2: Completed, 3: Error Note: This field may return null, indicating that no valid value can be obtained.

WorkFlowExecuteDtoByPage

Paging Query Workflow Canvas Run Start and End Time

Used by actions: DescribeWorkflowExecuteById.

Name	Type	Required	Description
TotalCount	Integer	No	Total numberNote: This field may return null, indicating that no valid value can be obtained.
Items	Array of WorkFlowExecuteDto	No	data Note: This field may return null, indicating that no valid value can be obtained.
PageSize	Integer	No	Page sizeNote: This field may return null, indicating that no valid value can be obtained.

Workflow

Workflow Information

Used by actions: DescribeFolderWorkflowList.

Name	Type	Description
WorkflowId	String	Workflow ID
Owner	String	Person in Charge Note: This field may return null, indicating that no valid value can be obtained.
OwnerId	String	Responsible Person ID Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	Project ID
ProjectIdent	String	Project Identifier
ProjectName	String	Project name
WorkflowDesc	String	RemarksNote: This field may return null, indicating that no valid value can be obtained.
WorkflowName	String	Workflow name
FolderId	String	Parent Folder ID
UserGroupId	String	Workflow User Group ID If there are multiple, separate with semicolons: a;b;c Note: This field may return null, indicating that no valid value can be obtained.
UserGroupName	String	Workflow User Group Name If there are multiple, separate with semicolons: a;b;c Note: This field may return null, indicating that no valid value can be obtained.

WorkflowCanvasOpsDto

Workflow Canvas Details

Used by actions: DescribeAllByFolderNew, DescribeWorkflowCanvasInfo, DescribeWorkflowListByProjectId, FindAllFolder.

Name	Type	Required	Description
WorkflowId	String	No	Workflow IDNote: This field may return null, indicating that no valid value can be obtained.
WorkflowDesc	String	No	Workflow Detail Description Note: This field may return null, indicating that no valid value can be obtained.
WorkflowName	String	No	Workflow nameNote: This field may return null, indicating that no valid value can be obtained.
FolderId	String	No	Parent Folder IDNote: This field may return null, indicating that no valid value can be obtained.
FolderIds	Array of String	No	Associated Folder IDs Note: This field may return null, indicating that no valid value can be obtained.
Tasks	Array of TaskOpsDto	No	Task ListNote: This field may return null, indicating that no valid value can be obtained.
Links	Array of LinkOpsDto	No	Task Dependency Edge List Note: This field may return null, indicating that no valid value can be obtained.
UserGroupId	String	No	Workflow User Group ID, if multiple, separated by semicolons: a;b;c Note: This field may return null, indicating that no valid value can be obtained.
UserGroupName	String	No	Workflow User Group Name, if multiple, separated by semicolons: a;b;c Note: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	No	Project IDNote: This field may return null, indicating that no valid value can be obtained.
ProjectIdent	String	No	Project IdentifierNote: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	No	Project nameNote: This field may return null, indicating that no valid value can be obtained.
Owner	String	No	Person in ChargeNote: This field may return null, indicating that no valid value can be obtained.
OwnerId	String	No	Responsible User ID Note: This field may return null, indicating that no valid value can be obtained.

WorkflowExtOpsDto

Workflow

Used by actions: DescribeOpsWorkflows.

Name	Type	Description
TaskCount	Integer	Number of Tasks Count Note: This field may return null, indicating that no valid value can be obtained.
FolderName	String	File NameNote: This field may return null, indicating that no valid value can be obtained.
WorkFlowId	String	Workflow IDNote: This field may return null, indicating that no valid value can be obtained.
Owner	String	Person in ChargeNote: This field may return null, indicating that no valid value can be obtained.
OwnerId	String	Person in charge userId\nNote: This field may return null, indicating that no valid value can be obtained.
ProjectId	String	Project IDNote: This field may return null, indicating that no valid value can be obtained.
ProjectIdent	String	Project IdentifierNote: This field may return null, indicating that no valid value can be obtained.
ProjectName	String	Project nameNote: This field may return null, indicating that no valid value can be obtained.
WorkFlowDesc	String	Workflow DescriptionNote: This field may return null, indicating that no valid value can be obtained.
WorkFlowName	String	Workflow nameNote: This field may return null, indicating that no valid value can be obtained.
FolderId	String	Workflow file id\nNote: This field may return null, indicating that no valid value can be obtained.
Status	String	Workflow statusNote: This field may return null, indicating that no valid value can be obtained.
CreateTime	String	Workflow creation time\nNote: This field may return null, indicating that no valid value can be obtained.
ModifyTime	String	Last update time\nNote: This field may return null, indicating that no valid value can be obtained.

WorkflowExtOpsDtoPage

User production workflow list pagination

Used by actions: DescribeOpsWorkflows.

Name	Type	Description
TotalCount	Integer	Total Record Count Note: This field may return null, indicating that no valid value can be obtained.
Items	Array of WorkflowExtOpsDto	Record List Note: This field may return null, indicating that no valid value can be obtained.

WorkflowSchedulerOpsDto

Workflow Scheduling Details

Used by actions: DescribeWorkflowInfoById.

Name	Type	Description
CreateTime	String	Creation TimeNote: This field may return null, indicating that no valid value can be obtained.
Creator	String	CreatorNote: This field may return null, indicating that no valid value can be obtained.
ModifyTime	String	Modification TimeNote: This field may return null, indicating that no valid value can be obtained.
DelayTime	Integer	Latency, unit=minute Note: This field may return null, indicating that no valid value can be obtained.
StartupTime	Integer	Start Time, unit=minute Note: This field may return null, indicating that no valid value can be obtained.
SelfDepend	String	Task Dependency Type Note: This field may return null, indicating that no valid value can be obtained.
StartTime	String	Start TimeNote: This field may return null, indicating that no valid value can be obtained.
EndTime	String	End timeNote: This field may return null, indicating that no valid value can be obtained.
TaskAction	String	Specified Running Time, Specified Time: e.g., Monday:1 Note: This field may return null, indicating that no valid value can be obtained.
CycleType	String	Scheduling Cycle Type, Time Unit Note: This field may return null, indicating that no valid value can be obtained.
CycleStep	Integer	Scheduling Period, Interval Step unit=minute Note: This field may return null, indicating that no valid value can be obtained.
CrontabExpression	String	Scheduling Cron Expression Note: This field may return null, indicating that no valid value can be obtained.
ExecutionStartTime	String	Execution Time Left Closed Interval Note: This field may return null, indicating that no valid value can be obtained.
ExecutionEndTime	String	Execution Time Right Closed Interval Note: This field may return null, indicating that no valid value can be obtained.
InstanceInitStrategy	String	Task Instance Initialization Strategy Note: This field may return null, indicating that no valid value can be obtained.
WorkflowId	String	Workflow IDNote: This field may return null, indicating that no valid value can be obtained.
DependencyWorkflow	String	Workflow Self-Dependency Note: This field may return null, indicating that no valid value can be obtained.
SchedulerDesc	String	Scheduling Plan Interpretation Note: This field may return null, indicating that no valid value can be obtained.
FirstSubmitTime	String	First Submission Time of Workflow Note: This field may return null, indicating that no valid value can be obtained.
LatestSubmitTime	String	Latest Submission Time of Workflow Note: This field may return null, indicating that no valid value can be obtained.

WorkflowTaskCountOpsDto

Workflow Task Statistics

Used by actions: DescribeWorkflowTaskCount.

Name	Type	Description
Count	Integer	Number of Workflow Tasks Note: This field may return null, indicating that no valid value can be obtained.
TypeCount	Array of PairDto	Task Type Dimension Statistics Note: This field may return null, indicating that no valid value can be obtained.
CycleCount	Array of PairDto	Task Cycle Type Dimension Statistics Note: This field may return null, indicating that no valid value can be obtained.

tencent cloud

Sign Up

Log in

Recent Pages

Data Types

AdhocDetail

AdhocRecord

AgentStatus

AlarmEventInfo

AlarmIndicatorInfo

AlarmInfo

AlarmReceiverInfo

Apply

ApproveModify

ApproveType

AttributeItemDTO

BaseClusterInfo

BaseTenant

BaseUser

BatchCreateTaskVersionDTO

BatchOperateResult

BatchOperateResultOpsDto

BatchOperationOpsDto

BatchOpsDTO

BatchResult

BatchReturn

BytesSpeed

CollectionFolderOpsDto

CollectionInstanceOpsDto

ColumnAggregationLineage

ColumnBasicInfo

ColumnData

ColumnItem

ColumnLineageInfo

ColumnMeta

CommonContent

CommonId

CommonIdOpsDto

CompareResult

CompareResultItem

CompareRule

CompareRuleItem

Content

CreateMakeDatetimeInfo

DailyScoreInfo

DataCheckStat

DataSourceInfo

DataSourceInfoPage

DatabaseInfo

DatabaseMeta

DatasourceBaseInfo

DependencyConfig

DescribeApply

DescribeBatchOperateTaskDTO

DescribeBatchOperateTaskPage

DescribeFolderWorkflowListData

DiagnoseRep

DimensionCount

DimensionScore

DimensionScoreInfo

DlcDataGovernPolicy

DlcExpiredSnapshotsInfo

DlcMergeManifestsInfo

DlcRemoveOrphanFilesInfo

DlcRewriteDataInfo

DrInstanceOpsDto

DrInstanceOpsDtoPage

EventBatchCaseDTO

EventCaseAuditLogOptDto

EventCaseAuditLogVOCollection

EventCaseConsumeLogOptDto

EventCaseConsumeLogOptDtoCollection

EventCaseDTO

EventCaseOpsDto

EventListenerOpsDto

EventOpsDto

FailMessage

FieldConfig

Filter

FilterOptional