Open Data table schemas

Updated at:

DataWorks Open Data provides tables and views for collecting metadata across dimensions. This topic lists the currently available tables and views and describes their schemas.

Metadata

DataWorks generates these metadata tables and sample metrics tables from metadata about tables, tasks, instances, workspaces, members, and projects in the current tenant. Schemas may change as the service evolves. The console shows the definitive schema.

Asset table issue details (asset_table_issues)

Partition field:dt

Description:Data governance issue details for tables

Field

Type

Description

tenant_id

string

DataWorks tenant

meta_entity_id

string

Corresponding metadata entity ID

uuid

string

Unique table key

meta_entity_type

string

Corresponding metadata type, such as maxcompute-table

entity_type

string

Entity type, such as table, view, or materialized_view

account_id

string

Main account that owns the asset

datasource_type

string

Data source type, such as EMR or MC

datasource_id

string

Engine name (MC: projectName; EMR: clusterId; Holo: databaseName)

catalog_name

string

DLF catalog when metadata is in DLF

database_name

string

Database name (EMR dbName)

schema_name

string

Schema name

rule_id

string

Governance item ID

rule_name_zh

string

Chinese name of governance item

rule_name_en

string

English name of governance item

category

string

Dimension to which the item belongs

deduct_score_tenant

string

Tenant-wide deduction score, with four decimal places

deduct_score_owner

string

Owner deduction score, with four decimal places

cost

string

Wasted resources

project_id

string

DataWorks project workspace

dt

string

Date partition (logical partition field), format YYYYMMDD

Asset table metrics (asset_table_profiles)

Partition field:dt

Description:Table metrics

Field

Type

Description

tenant_id

bigint

Source tenant ID

meta_entity_id

string

Corresponding metadata entity ID

meta_entity_type

string

Corresponding metadata type, such as maxcompute-table

entity_type

string

Entity type, such as table, view, or materialized_view

account_id

string

Main account that owns the asset

datasource_type

string

Data source type, such as EMR or MC

datasource_id

string

Engine name (MC: projectName; EMR: clusterId; Holo: databaseName)

catalog_name

string

DLF catalog when metadata is in DLF

database_name

string

Database name (EMR dbName)

schema_name

string

Schema name

uuid

string

Unique table key

name

string

Table name

owner

string

Asset owner

last_access_timestamp

bigint

Last table access time

meta_modified_timestamp

bigint

Table metadata modification timestamp (13 digits)

data_modified_timestamp

bigint

Table data modification timestamp (13 digits)

create_timestamp

bigint

Table creation time

comment

string

Table comment

partition_keys

string

Partition keys

tags

string

Asset tags

governance_rule_finding_count

bigint

Number of governance issues

governance_rule_finding_history_count

string

Historical number of asset governance items

governance_health_score

string

Asset governance score

governance_health_level

string

Asset governance score level

is_partitioned

bigint

Whether the table is partitioned

content_size

bigint

Logical size

record_num

bigint

Number of records

life_cycle

string

Lifecycle

partition_count

bigint

Number of partitions

view_count_monthly

bigint

Number of views in the past month

access_count

bigint

Number of accesses

upstream_table_count

bigint

Number of upstream tables

upstream_table_detail

string

Upstream table details

downstream_table_count

bigint

Number of downstream tables

downstream_table_detail

string

Downstream table details

producing_project_ids

string

Workspaces involved in table production

producing_tasks_count

bigint

Number of nodes involved in table production

producing_tasks_detail

string

Details of nodes involved in table production

using_tasks_count

bigint

Number of nodes that use the table

using_tasks_detail

string

Details of nodes that use the table

quality_rule_count

bigint

Number of quality rules

quality_monitor_count

bigint

Number of quality monitoring metrics

quality_rule_7_days_failed_count

bigint

Number of quality rules that failed

quality_monitor_7_days_failed_count

bigint

Number of quality monitoring metrics that failed

dt

string

Date partition (logical partition field), format YYYYMMDD

Asset task issue details (asset_task_issues)

Partition field:dt

Description:Data governance issue details for tasks

Field

Type

Description

tenant_id

string

DataWorks tenant ID

node_id

string

Scheduled node ID

node_name

string

Node name

node_type

string

Task type: SQL, SQLCost, LOT, or CUPID

node_owner

string

Owner baseId

priority

string

Priority

rule_id

string

Governance item ID

rule_name_zh

string

Chinese name of governance item

rule_name_en

string

English name of governance item

category

string

Governance domain

deduct_score_tenant

string

Tenant-wide deduction score, with four decimal places

deduct_score_owner

string

Owner deduction score, with four decimal places

cost

string

Governance benefit

project_id

string

DataWorks project ID

dt

string

Date partition (logical partition field), format YYYYMMDD

Asset task metrics (asset_task_profiles)

Partition field:dt

Description:Task metrics

Field

Type

Description

tenant_id

bigint

Source tenant ID

data_asset_id

string

Asset ID in the module, corresponding to task.id

name

string

Asset name, corresponding to task.name

project_id

bigint

Workspace

project_env

string

Environment: PROD for production; DEV for development

owner

string

Asset owner

create_user

string

Creator

create_time

bigint

Creation time

modify_user

string

Modifier

modify_time

bigint

Modification time

trigger_type

string

Trigger type: Scheduler for periodic scheduling; Manual for manual trigger

trigger_recurrence_type

string

Normal: normal run; Manual: manual task; Pause: paused; Skip: dry run

trigger_cron

string

Cron expression

type

bigint

Code type of the task. For node codes, see https://help.aliyun.com/zh/dataworks/user-guide/node-development-of-data-studio

script_parameters

string

Parameter information

priority

bigint

Task priority, from 1 to 8. A higher value means higher priority. Default: 1

trigger_start_time

bigint

Start date when scheduling is allowed

trigger_end_time

bigint

End date when scheduling is allowed

runtime_resource_group_id

bigint

Resource group ID of the node

runtime_cu

string

CUs consumed by scheduler execution

baseline_id

bigint

Baseline ID of the node

rerun_times

bigint

Maximum task reruns

rerun_interval

bigint

Rerun interval in milliseconds

rerun_mode_type

string

AllAllowed: rerun after success or failure; FailureAllowed: rerun only after failure; AllDenied: rerun after neither success nor failure

tags

string

Asset tags

tags_count

bigint

Number of asset tags

input_table_count

bigint

Number of input tables

output_table_count

bigint

Number of output tables

input_table_detail

string

Input table details

output_table_detail

string

Output table details

upstream_node_count

bigint

Number of upstream nodes

downstream_node_count

bigint

Number of downstream nodes

governance_rule_finding_count

bigint

Number of governance issues

governance_rule_finding_history_count

string

Historical number of asset governance items

governance_health_score

string

Asset score

governance_health_level

string

Asset score level

engine_datasource_id

string

Compute engine ID

engine_instance_count

bigint

Number of compute engine jobs

engine_instance_run_time

bigint

Compute engine job runtime

engine_instance_comput_volume_cost

string

Compute consumption

engine_instance_cu_cost

string

CUs consumed by compute engine execution

engine_instance_cpu_cost

string

CPU consumption

engine_instance_mem_cost

string

Memory consumption

engine_instance_exist_data_skew

bigint

Data skew

engine_instance_suggestions

string

Skew recommendations

engine_instance_data_skew_ids

string

Job IDs with data skew

engine_instance_ids

string

Job IDs

task_instance_wait_time_cost_sum

bigint

Total waiting time

task_instance_wait_time_cost_max

bigint

Maximum instance waiting time

task_instance_run_time_cost_sum

bigint

Total runtime

task_instance_run_time_cost_max

bigint

Maximum runtime

task_instance_7_days_wait_time_cost_max

bigint

Maximum instance waiting time in the past seven days

task_instance_7_days_run_time_cost_max

bigint

Maximum instance runtime in the past seven days

task_instance_count

bigint

Number of instances

task_instance_7_days_failed_count

bigint

Number of failed instances

task_instance_7_days_failed_day_count

bigint

Number of days with failures

task_instance_7_days_frezeed_day_count

bigint

Number of days frozen

task_instance_7_days_dry_run_day_count

bigint

Number of days skipped

quality_monitor_count

bigint

Number of data quality monitoring metrics

quality_monitor_7_days_failed_count

bigint

Number of failed data quality monitoring metrics

di_task_resource_group_id

string

Data integration resource group ID of the node

di_task_is_public_network

bigint

Whether the data integration task uses public network traffic

di_task_concurrency

bigint

Concurrency

di_task_total_records

bigint

Number of synchronized records

di_task_total_bytes

bigint

Amount of synchronized data

di_task_source_type

string

Source type

di_task_target_type

string

Destination type

di_task_run_time_cost

bigint

Data integration task runtime

di_task_wait_time_cost

bigint

Data integration task waiting time

dt

string

Date partition (logical partition field), format YYYYMMDD

Catalogs (catalogs)

Field

Type

Description

datasource_type

string

Data source type, such as DLF or StarRocks.

datasource_id

string

Data source ID, such as a StarRocks cluster ID or the primary account ID that owns DLF.

name

string

Catalog name.

type

string

Catalog type, such as Hive or JDBC.

comment

string

Catalog comment.

location

string

Catalog path.

properties

string

Properties and parameters (JSON string).

owner

string

Catalog owner. Depending on the data source type, this may be an Alibaba Cloud account UID or a database account.

create_timestamp

bigint

Creation timestamp (13 digits).

update_timestamp

bigint

Modification timestamp (13 digits).

meta_entity_id

string

Unique catalog ID (API-friendly and compliant with the metadata entity ID format).

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Columns (columns)

Field

Type

Description

datasource_type

string

Data source type, such as DLF or StarRocks.

datasource_id

string

Data source ID, such as a StarRocks cluster ID, the primary account ID that owns DLF or MaxCompute, or an RDS instance ID.

catalog_name

string

Catalog name, populated if the data source type supports catalogs.

database_name

string

Database name.

schema_name

string

Schema name, populated if the data source type supports schemas.

table_name

string

Table name.

name

string

Column name.

type

string

Column type.

comment

string

Comment.

ordinal_position

bigint

Column ordinal position (starting at 1).

is_primary_key

boolean

Whether the column is a primary key.

is_nullable

boolean

Whether NULL is allowed.

is_partition_key

boolean

Whether the column is a partition key.

properties

string

Properties and parameters (JSON string).

business_description

string

Business description.

meta_entity_id

string

Unique column ID (API-friendly and compliant with the metadata entity ID format).

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Databases (databases)

Field

Type

Description

datasource_type

string

Data source type, such asdlf, starrocks, maxcompute, holodb, mysql, and others.

datasource_id

string

Data source ID, such as a StarRocks cluster ID, the primary account ID that owns DLF or MaxCompute, or an RDS instance ID.

catalog_name

string

Catalog name, populated if the data source type supports catalogs.

name

string

Database name.

type

string

Database type.

comment

string

Database comment.

location

string

Database path.

properties

string

Properties and parameters (JSON string).

owner

string

Database owner. Depending on the data source type, this may be an Alibaba Cloud account UID or a database account.

is_external

boolean

Whether this is an external database.

create_timestamp

bigint

Creation timestamp (13 digits).

update_timestamp

bigint

Modification timestamp (13 digits).

meta_entity_id

string

Unique database ID (API-friendly and compliant with the metadata entity ID format).

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Table- and column-level lineage (lineages)

Field

Type

Description

source_meta_entity_id

string

Unique source ID (API-friendly and compliant with the metadata entity ID format).

source_raw_entity_type

string

Source entity type. If the source metadata is unmanaged, source_meta_entity_type is empty and source_raw_entity_type identifies it.

source_uuid

string

Unique source ID (friendly for page access).

target_meta_entity_id

string

Unique destination ID (API-friendly and compliant with the metadata entity ID format).

target_raw_entity_type

string

Destination entity type. If the destination metadata is unmanaged, target_meta_entity_type is empty and target_raw_entity_type identifies it.

target_uuid

string

Unique destination ID (friendly for page access).

compute_engine

string

Compute engine, such as MaxCompute, DataX, or Hologres.

transform_type

string

Conversion task type in the engine, such as SQL, DATAX, DATAX_STREAM, EXTERNAL_TABLE_MAPPING, STORAGE_MAPPING, or API_MAPPING.

task_id

bigint

DataWorks scheduled task ID. See the tasks table. Empty for lineage that was not triggered by DataWorks scheduling.

task_instance_id

bigint

DataWorks scheduled task instance ID. See the tasks_instances table. Empty for lineage that was not triggered by DataWorks scheduling.

lineage_time

bigint

Time when lineage occurred (milliseconds).

granularity

string

Lineage level, such as TABLE or COLUMN.

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Partitions (partitions)

Field

Type

Description

datasource_type

string

Data source type, such as MaxCompute, DLF, or StarRocks.

datasource_id

string

Data source ID, such as a StarRocks cluster ID, the primary account ID that owns DLF or MaxCompute, or an RDS instance ID.

catalog_name

string

Catalog name, populated if the data source type supports catalogs.

database_name

string

Database name.

schema_name

string

Schema name, populated if the data source type supports schemas.

table_name

string

Table name.

name

string

Partition name (partition specification).

create_timestamp

bigint

Creation timestamp (13 digits).

update_timestamp

bigint

Modification timestamp (13 digits).

content_size

bigint

Partition size in bytes.

properties

string

Properties and parameters (JSON string).

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Resource groups (resource groups)

Field

Type

Description

resource_group_id

bigint

Resource group ID.

resource_group_identifier

string

Resource group identifier.

resource_group_type

bigint

Resource group type (1: scheduling resource group; 2: MaxCompute resource group; 4: data integration resource group).

resource_group_mode

bigint

Resource group mode (1: prepaid; 2: pay-as-you-go; 3: developer edition, MaxCompute only).

resource_group_status

bigint

Resource group status (0: normal; 1: frozen; 2: deleted; 3: creating; 4: creation failed; 5: updating; 6: update failed; 7: deleting; 8: deletion failed).

is_exclusive_resource_group

boolean

Whether this is an exclusive resource group.

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Schemas (schemas)

Field

Type

Description

datasource_type

string

Data source type, such as HoloDB, MaxCompute, or PostgreSQL.

datasource_id

string

Data source ID, such as an RDS instance ID or the primary account ID that owns MaxCompute.

catalog_name

string

Catalog name, populated if the data source type supports catalogs.

database_name

string

Database name.

name

string

Schema name.

type

string

Schema type.

comment

string

Comment.

properties

string

Properties and parameters (JSON string).

owner

string

Schema owner. Depending on the data source type, this may be an Alibaba Cloud account UID or a database account.

create_timestamp

bigint

Creation timestamp (13 digits).

update_timestamp

bigint

Modification timestamp (13 digits).

meta_entity_id

string

Unique schema ID (API-friendly and compliant with the metadata entity ID format).

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Tables (tables)

Field

Type

Description

datasource_type

string

Data source type, such as DLF, StarRocks, MaxCompute, HoloDB, or MySQL.

datasource_id

string

Data source ID, such as a StarRocks cluster ID, the primary account ID that owns DLF or MaxCompute, or an RDS instance ID.

catalog_name

string

Catalog name, populated if the data source type supports catalogs.

database_name

string

Database name.

schema_name

string

Schema name, populated if the data source type supports schemas.

name

string

Table name.

type

string

Table type.

comment

string

Comment.

partition_keys

string

Partition keys, separated by English commas for multi-level partitions.

location

string

Table storage path.

properties

string

Properties and parameters (JSON string). For a view, this is its DDL definition.

owner

string

Table owner. Depending on the data source type, this may be an Alibaba Cloud account UID or a database account.

content_size

bigint

Storage size in bytes.

data_retention

map<string,string>

Data retention period or lifecycle. Values differ by table type: for a MaxCompute table, key is lifecycle and value is the table lifecycle, such as 365; for a DLF table, key is renention and value is the table lifecycle, such as 91; other types are not yet supported. If support is added, this documentation will be updated.

is_compressed

boolean

Whether the table is compressed.

is_temporary

boolean

Whether this is a temporary table.

entity_type

string

Entity type, such as table, view, or materialized_view.

input_format

string

Input format.

output_format

string

Output format.

serde_parameters

string

SerDe parameters.

serialization_lib

string

Serialization library.

create_timestamp

bigint

Table creation timestamp (13 digits).

meta_modified_timestamp

bigint

Table metadata modification timestamp (13 digits).

data_modified_timestamp

bigint

Table data modification timestamp (13 digits).

last_access_timestamp

bigint

Table last access timestamp (13 digits).

business_description

string

Business description or Chinese name.

meta_entity_id

string

Unique table ID (API-friendly and compliant with the metadata entity ID format).

For example:

  • maxcompute-table: primary account ID::project_name:schema_name:table_name.

  • holo-table: Hologres instance ID::sample_database:public_schema:table_name.

  • starrocks-table: cluster instance ID:default_catalog:sample_database::sample_table.

uuid

string

Table UUID, used to link to the table details page in DataWorks Data Map.

business_tags

array<string>

Business tags; tags set on the Data Map page are recorded in this field.

wikis

array<struct<`version`:bigint,`operator`:string,`update_timestamp`:bigint,`content`:string>>

Table usage description (version: version number; operator: submitter; update_timestamp: update timestamp, 13 digits; content: contents).

producing_tasks

array<bigint>

IDs of scheduled tasks that produce table data. See the tasks table.

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Task or workflow instances (task_instances)

Field

Type

Description

id

bigint

Task instance ID.

node_id

bigint

Task ID. See the tasks table.

node_type

bigint

For task types, see the node codes inNode Development Overview.

node_name

string

Task name.

description

string

Task description.

workflow_id

bigint

Workflow ID. See the tasks table.

workflow_name

string

Workflow name.

workflow_instance_id

bigint

Workflow instance ID.

workflow_instance_type

bigint

Workflow instance type (0: periodic scheduling; 1: manual task; 2: smoke test; 3: backfill; 4: one-time workflow; 5: manual workflow).

trigger_type

string

Trigger type (Scheduler or Manual).

trigger_recurrence

string

Run mode (0: normal; 1: manual; 2: paused; 3: dry run; 4: referenced).

timeout

bigint

Task execution timeout in hours.

rerun_mode

string

Rerun configuration (0: rerun after failure; 1: rerun after success or failure; 2: rerun disallowed).

run_number

bigint

Number of runs.

period_number

bigint

Cycle number.

baseline_id

bigint

Baseline ID.

priority

bigint

Task priority (1 to 8).

script_parameters

string

Run script parameter list.

runtime_resource_group_id

bigint

ID of the resource group used to run the task.

runtime_resource_group_identifier

string

Identifier of the resource group used to run the task.

runtime_image

string

Runtime image ID.

runtime_cu

string

CUs consumed at runtime.

runtime_process_id

string

Runtime process ID.

runtime_gateway

string

Runtime gateway.

datasource_name

string

Data source name.

inputs_variables

array<struct<`name`:string,`type`:string,`value`:string>>

Input variable list.

outputs

array<struct<`output`:string,`type`:string>>

Output identifier list.

outputs_variables

array<struct<`name`:string,`type`:string,`value`:string>>

Output variable list.

tags

array<struct<`key`:string,`value`:string>>

Task tag list.

status

bigint

Task status (1: not run; 2: waiting for time; 3: waiting for resources; 4: running; 5: failed; 6: succeeded; 7: validating; 8: condition check; 9: waiting for trigger).

trigger_time

string

Trigger time.

bizdate

string

Business date.

started_time

string

Start time.

finished_time

string

End time.

project_id

bigint

Project ID. See the workspace_id field in the workspaces table.

project_env

string

Environment type (PROD or DEV).

owner

string

Owner account ID. See the users table.

create_time

string

Creation time.

modify_time

string

Modification time.

create_user

string

Creator account ID. See the users table.

modify_user

string

Modifier account ID. See the users table.

waiting_resource_time

string

Time spent waiting for resources.

waiting_trigger_time

string

Time spent waiting for trigger.

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Task or workflow definitions (tasks)

Field

Type

Description

id

bigint

Task ID.

name

string

Task name.

description

string

Task description.

type

bigint

For task types, see the node codes inNode Development Overview.

workflow_id

bigint

Workflow ID.

instance_mode

string

Instance generation mode.

  • T+1 (generated the next day)

  • Immediately (generated immediately)

baseline_id

bigint

Baseline ID.

priority

bigint

Task priority from 1 to 8. A higher value means higher priority. Default: 1.

timeout

bigint

Task execution timeout in hours.

rerun_mode

bigint

Whether the task can be rerun (0: only after failure; 1: after success or failure; 2: neither after success nor failure).

rerun_times

bigint

Retry count; effective when task reruns are allowed.

rerun_interval

bigint

Retry interval in seconds.

script_parameters

string

Run script parameter list.

trigger_type

string

Trigger type (Scheduler: periodic scheduling; Manual: manual trigger).

trigger_recurrence

bigint

Run mode on trigger (0: normal; 1: manual task; 2: paused; 3: dry run; 4: referenced task).

trigger_cron

string

Cron expression, effective when type=Scheduler.

trigger_start_time

string

Start of the periodic trigger validity period, effective when type=Scheduler.

trigger_end_time

string

End of the periodic trigger validity period, effective when type=Scheduler.

runtime_resource_group_id

bigint

ID of the resource group used to run the task.

runtime_image

string

Image ID configured for the task run.

runtime_cu

string

CUs configured for the task run.

datasource_name

string

Data source name.

inputs_variables

array<struct<`name`:string,`type`:string,`value`:string>>

Input variable list.

outputs

array<struct<`output`:string,`type`:string>>

Task output identifier list.

outputs_variables

array<struct<`name`:string,`type`:string,`value`:string>>

Output variable list.

dependencies

array<struct<`type`:string,`upstream_output`:string,`upstream_node_id`:bigint>>

Dependency information list.

related_workflow_id

bigint

Associated workflow ID.

tags

array<struct<`key`:string,`value`:string>>

Task tag list.

project_id

bigint

Project ID. See the workspace_id field in the workspaces table.

project_env

string

Environment type (PROD: production; DEV: development).

owner

string

Account ID of the task owner. See the users table.

create_time

string

Creation time.

modify_time

string

Modification time.

create_user

string

Account ID of the user who created the task. See the users table.

modify_user

string

Account ID of the user who modified the task. See the users table.

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Users (users)

Field

Type

Description

user_id

string

User ID.

user_nick

string

Account alias (display name).

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Workspace members (workspace members)

Field

Type

Description

workspace_id

bigint

Workspace ID. See the workspaces table.

user_id

string

User ID. See the users table.

user_status

bigint

User status (0: normal; 1: disabled; 2: deleted).

gmt_create_ts

bigint

Creation time (13-digit timestamp).

gmt_modified_ts

bigint

Modification time (13-digit timestamp).

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Workspaces (workspaces)

Field

Type

Description

workspace_id

bigint

Workspace ID.

workspace_name

string

Workspace name.

workspace_identifier

string

Workspace identifier.

workspace_description

string

Workspace description.

workspace_owner

string

Workspace owner ID. See the users table.

workspace_status

bigint

Workspace status (0: normal; 1: deleted; 2: initializing; 3: initialization failed; 4: manually disabled; 5: deleting; 6: deletion failed; 7: frozen for overdue payment).

dt

string

Date partition (logical partition field), format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Data quality rule instances (quality_rule_results)

Partition field:dt

Description:Data quality rule instances

Field

Type

Description

id

bigint

Primary key ID

scan_run_id

bigint

Quality monitoring instance ID

rule_id

bigint

Rule ID

rule_name

string

Rule name

status

string

Rule validation result: Pass, Error, Warn, Fail, or Running

severity

string

Rule severity: High or Normal

create_time

bigint

Creation time

modify_time

bigint

Most recent modification time

spec

string

Rule instance Spec

tags

array<string>

Rule instance tags

tenant_id

bigint

DataWorks tenant ID

project_id

bigint

DataWorks project workspace ID

meta_entity_id

string

Unique Data Map table entity ID

dt

string

Date partition, format YYYYMMDD. Value range: [TODAY-D, TODAY-1D]

Data quality rule metrics (quality_rules)

Partition field:dt

Description:Data quality rule metrics

Field

Type

Description

id

bigint

Primary key ID

scan_id

bigint

Quality monitoring ID

rule_name

string

Rule name

enabled

boolean

Whether the rule is enabled

severity

string

Rule business severity, enum: High or Normal

create_time

bigint

Creation time

modify_time

bigint

Most recent modification time

spec

string

Rule Spec

tags

array<string>

Rule tags

tenant_id

bigint

DataWorks tenant ID

project_id

bigint

DataWorks project workspace ID

meta_entity_id

string

Unique Data Map entity ID

pass_count

int

Number of rule checks that passed

warn_count

int

Number of rule checks that triggered the orange threshold

error_count

int

Number of rule checks that triggered the red threshold

fail_count

int

Number of rule checks that failed

dt

string

Date partition, format YYYYMMDD. Value range: [TODAY-D, TODAY-1D]

Data quality monitoring task instances (quality_scan_runs)

Partition field:dt

Description:Data quality monitoring task instances

Field

Type

Description

id

bigint

Primary key ID

scan_id

bigint

Quality monitoring ID

name

string

Monitoring name

status

string

Monitoring instance status: Pass, Warn, Error, Fail, or Running

post_action_type

string

Post-check monitoring action, enum: Alert or BlockTaskInstance

data_filter

string

Actual data range used for sampling

trigger_time

bigint

Scheduled task time

trigger_type

string

Data quality monitoring trigger type: ByManual, BySchedule, or ByQualityNode

create_time

bigint

Creation time

modify_time

bigint

Most recent update time

datasource_id

bigint

Data source ID of the table

datasource_type

string

Data source type

computing_resource_id

bigint

Compute engine ID

compute_resource_option

string

Compute resources used by data quality monitoring run

spec

string

Quality monitoring Spec

tenant_id

bigint

DataWorks tenant ID

project_id

bigint

DataWorks project workspace ID

owner

string

Quality monitoring owner

task_id

bigint

Scheduled task ID

task_instance_id

bigint

Scheduled task instance ID

meta_entity_id

string

Unique Data Map entity ID

table_name

string

Table name

catalog_name

string

Catalog name of the table

schema_name

string

Schema name of the table

database_name

string

Database name of the table

cluster_id

string

Cluster ID of the table

dt

string

Date partition, format YYYYMMDD. Value range: [TODAY-D, TODAY-1D]

Data quality monitoring task metrics (quality_scans)

Partition field:dt

Description:Data quality monitoring task metrics

Field

Type

Description

id

bigint

Primary key ID

name

string

Monitoring name

data_filter_type

string

Data range type: ByPartition or ByWhere

data_filter

string

Data range expression

trigger_type

string

Data quality monitoring trigger type: ByManual, BySchedule, or ByQualityNode

create_time

bigint

Creation time

modify_time

bigint

Most recent update time

computing_resource_id

bigint

Compute engine ID

compute_resource_option

string

Compute resources used by data quality monitoring run

spec

string

Data quality monitoring Spec

related_tasks

array<bigint>

Scheduled tasks associated with monitoring

tenant_id

bigint

DataWorks tenant ID

project_id

bigint

DataWorks project workspace ID

owner

string

Quality monitoring owner

datasource_id

string

Data source ID of the table

datasource_type

string

Data source type

meta_entity_id

string

Unique Data Map entity ID

table_name

string

Table name

catalog_name

string

Catalog name of the table

schema_name

string

Schema name of the table

database_name

string

Database name of the table

cluster_id

string

Cluster ID of the table

related_scheduler_task_count

int

Number of associated scheduled tasks

rule_count

int

Number of associated rules

high_severity_rule_count

int

Number of associated strong rules

normal_severity_rule_count

int

Number of associated weak rules

enabled_rule_count

int

Number of enabled rules

enabled_high_severity_rule_count

int

Number of enabled strong rules

enabled_normal_severity_rule_count

int

Number of enabled weak rules

rule_instance_count

int

Number of rule instances today

high_severity_rule_instance_count

int

Number of strong rule instances today

normal_severity_rule_instance_count

int

Number of weak rule instances today

high_severity_rule_instance_pass_count

int

Number of strong rule instances that passed today

high_severity_rule_instance_warn_count

int

Number of strong rule instances with an orange exception today

high_severity_rule_instance_error_count

int

Number of strong rule instances with a red exception today

high_severity_rule_instance_fail_count

int

Number of strong rule instances that failed today

normal_severity_rule_instance_pass_count

int

Number of weak rule instances that passed today

normal_severity_rule_instance_warn_count

int

Number of weak rule instances with an orange exception today

normal_severity_rule_instance_error_count

int

Number of weak rule instances with a red exception today

normal_severity_rule_instance_fail_count

int

Number of weak rule instances that failed today

block_task_instance_count

int

Number of scheduled tasks blocked today

alert_rule_count

int

Number of configured alert subscriptions

sms_alert_rule_count

int

Number of configured SMS alert subscriptions

mail_alert_rule_count

int

Number of configured email alert subscriptions

phone_alert_rule_count

int

Number of configured phone alert subscriptions

ding_alert_rule_count

int

Number of configured DingTalk alert subscriptions

feishu_alert_rule_count

int

Number of configured Feishu alert subscriptions

weixin_alert_rule_count

int

Number of configured WeChat alert subscriptions

webhook_alert_rule_count

int

Number of configured custom webhook alert subscriptions

alert_times

int

Number of alerts triggered today

sms_alert_times

int

Number of SMS alerts triggered today

mail_alert_times

int

Number of email alerts triggered today

phone_alert_times

int

Number of phone alerts triggered today

ding_alert_times

int

Number of DingTalk alerts triggered today

feishu_alert_times

int

Number of Feishu alerts triggered today

weixin_alert_times

int

Number of WeChat alerts triggered today

webhook_alert_times

int

Number of custom webhook alerts triggered today

dt

string

Date partition, format YYYYMMDD. Value range: [TODAY-D, TODAY-1D]

Data quality table metrics (table_quality_summary)

Partition field:dt

Description:Data quality table metrics

Field

Type

Description

meta_entity_id

string

Unique Data Map table entity ID

project_id

bigint

DataWorks project workspace ID

table_name

string

Table name

schema_name

string

Schema name of the table

database_name

string

Database name of the table

catalog_name

string

Catalog name of the table

datasource_id

bigint

Data source ID of the table; NULL if data quality is not configured

tenant_id

bigint

DataWorks tenant ID

owner

string

Table owner

scan_count

int

Number of configured quality monitors

scheduler_related_scan_count

int

Number of quality monitors associated with scheduling

scan_run_count

int

Number of quality monitoring task instances today

alert_scan_run_count

int

Number of quality monitoring task instances that triggered alerts today

block_task_instance_scan_run_count

int

Number of quality monitoring task instances that blocked scheduled tasks today

rule_count

int

Number of configured rules

enabled_rule_count

int

Number of enabled rules

high_severity_rule_count

int

Number of configured strong rules

normal_severity_rule_count

int

Number of configured weak rules

rule_instance_count

int

Number of rule instances today

high_severity_rule_instance_count

int

Number of strong rule instances today

normal_severity_rule_instance_count

int

Number of weak rule instances today

high_severity_rule_instance_pass_count

int

Number of strong rule checks that passed today

high_severity_rule_instance_warn_count

int

Number of strong rule checks with an orange exception today

high_severity_rule_instance_error_count

int

Number of strong rule checks with a red exception today

high_severity_rule_instance_fail_count

int

Number of strong rule checks that failed today

normal_severity_rule_instance_pass_count

int

Number of weak rule checks that passed today

normal_severity_rule_instance_warn_count

int

Number of weak rule checks with an orange exception today

normal_severity_rule_instance_error_count

int

Number of weak rule checks with a red exception today

normal_severity_rule_instance_fail_count

int

Number of weak rule checks that failed today

dt

string

Date partition, format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D]

Examples metadata

Table metrics details (table_metrics_detail)

Field

Type

Description

datasource_type

string

Data source type.

datasource_id

string

Data source ID.

catalog_name

string

Catalog name.

database_name

string

Database name.

schema_name

string

Schema name.

table_name

string

Table name.

table_uuid

string

Table ID used to open table details.

meta_entity_id

string

Human-readable table ID.

content_size

bigint

Collected storage size. NULL if storage size collection is unsupported.

daily_rate_cs

decimal(16,6)

Day-over-day change rate of storage size.

avg_content_size_7d

bigint

Seven-day average storage size.

daily_rate_acs_7d

decimal(16,6)

Day-over-day change rate of the seven-day average storage size.

latest_data_update_time_31d

bigint

End time of the corresponding downstream instance in the 31-day lineage range; the maximum data_modified_timestamp. NULL if there were no updates in the 31-day range.

latest_data_update_task_id

bigint

ID of the scheduled task that most recently updated the table within 31 days.

latest_data_update_instance_id

bigint

Instance ID of the scheduled task that most recently updated the table within 31 days.

latest_data_update_time_by_task

bigint

End time of the scheduled task instance that most recently updated the table within 31 days.

writing_task_ids

array<bigint>

Distinct IDs of scheduled tasks that wrote to the table on the current business date.

writing_task_ids_31d

array<bigint>

Distinct IDs of scheduled tasks that wrote to the table within the 31-day range.

latest_data_access_time_31d

bigint

End time of the corresponding upstream instance in the 31-day lineage range; the maximum last_access_timestamp. NULL if the table was not accessed in the 31-day range.

latest_data_access_task_id

bigint

ID of the scheduled task that most recently read the table within 31 days.

latest_data_access_instance_id

bigint

Instance ID of the scheduled task that most recently read the table within 31 days.

latest_data_access_time_by_task

bigint

End time of the corresponding upstream instance within the 31-day range.

reading_task_ids

array<string>

IDs of scheduled tasks that read the table.

reading_task_ids_31d

array<string>

Distinct IDs of scheduled tasks that read the table within the 31-day range.

direct_downstream_tables

array<string>

Direct downstream table IDs (uuid).

direct_upstream_tables

array<string>

Direct upstream table IDs (uuid).

dt

string

Date partition, format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Table metrics summary (table_metrics_summary)

Field

Type

Description

table_count

bigint

Number of tables.

daily_rate_tc

decimal(16,6)

Day-over-day change rate of table count.

avg_table_count_7d

bigint

Seven-day average table count.

daily_rate_atc_7d

decimal(16,6)

Day-over-day change rate of the seven-day average table count.

content_size

bigint

Collected storage size. NULL if storage size collection is unsupported.

daily_rate_cs

decimal(16,6)

Day-over-day change rate of storage size.

avg_content_size_7d

bigint

Seven-day average storage size.

daily_rate_acs_7d

decimal(16,6)

Day-over-day change rate of the seven-day average storage size.

updated_table_count

bigint

Number of tables updated within 31 days.

daily_rate_utc

decimal(16,6)

Day-over-day change rate of the number of tables updated within 31 days.

avg_updated_table_count_7d

bigint

Seven-day average number of tables updated within 31 days.

daily_rate_autc_7d

decimal(16,6)

Day-over-day change rate of the seven-day average number of tables updated within 31 days.

accessed_table_count

bigint

Number of tables read within 31 days.

daily_rate_atc

decimal(16,6)

Day-over-day change rate of the number of tables read within 31 days.

avg_accessed_table_count_7d

bigint

Seven-day average number of tables read within 31 days.

daily_rate_aatc_7d

decimal(16,6)

Day-over-day change rate of the seven-day average number of tables read within 31 days.

dt

string

Date partition, format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Task metrics details (task_metrics_detail)

Field

Type

Description

task_id

bigint

Task ID.

workflow_id

bigint

Workflow ID.

node_type

bigint

Task type.

project_id

bigint

Workspace ID.

week_number

bigint

Week number of the business date's year.

task_owner

string

Owner ID.

compute_resource_type

string

Compute resource type.

compute_resource_id

string

Compute resource ID, such as an MC project name, EMR cluster ID, or Hologres instance ID.

datasource_name

string

Data source name.

inst_success_count

bigint

Number of successful instances.

inst_failed_count

bigint

Number of failed instances.

inst_running_count

bigint

Number of running instances.

inst_abnormal_count

bigint

Number of instances with exceptions.

inst_not_started_count

bigint

Number of instances that have not run.

inst_runtime_cu

double

CUs consumed while instances ran.

task_avg_cu_31d

double

Average daily CU consumption of the task within 31 days.

dt

string

Date partition, format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].

Task metrics summary (task_metrics_summary)

Field

Type

Description

node_type

bigint

Node type.

inst_status

string

Instance status.

inst_count

bigint

Number of instances.

avg_inst_count_7d

double

Average number of instances over seven days.

granularity

string

Aggregation granularity: DAILY or WEEKLY.

dt

string

Date partition, format YYYYMMDD. Value range: [TODAY-31D, TODAY-1D].