OpenAPI list

API (old)

API (new)

Description

Instance O&M

GetInstanceDownstream

-

Retrieves the downstream instances of a specified instance.

GetPhysicalInstanceLog

-

Retrieves the execution log of an instance. If an instance was rerun multiple times, this API returns a log entry for each run.

GetScriptInstance

-

Retrieves the details of a script instance, including its status and runtime.

InstanceFixData

-

Reruns downstream tasks to repair data. You can force this operation on all affected downstream instances. This operation:

• Incurs computing cost.

• Affects data output.

ListNormalInstance

-

Returns a paginated list of instances that match the specified query criteria. Supported instance types include scheduled instances and manual instances.

OperateBatchInstance

-

• Performs batch O&M on instances, supporting both physical instances and logical table instances (since v295-2).

• Rerunning an instance or its downstream dependencies re-processes data and affects historical data.

• Rerunning an instance or its downstream dependencies incurs computing and storage cost.

• Pausing is a high-risk operation that may prevent instances from being scheduled. Use with caution.

The following O&M operations are supported for instances:

• RERUN: Reruns the instance and re-processes data for the node's current business date.

• PAUSE: Pauses the instance. If a downstream instance is not running, its scheduling is also suspended.

• RESUME: Resumes a paused instance. This is the reverse of the PAUSE operation. The instance runs once its scheduling conditions are met.

• TERMINATE: Terminates scheduling for an instance. The instance will not be scheduled to run. If a downstream instance is not running, its scheduling is also suspended.

• SET_SUCCESS: Sets the instance state to success. This affects downstream scheduling and is primarily used to forcibly update the instance's scheduling status after a manual data refresh, allowing downstream instances to run.

To rerun downstream tasks, use the InstanceFixData API.

OperateInstance

-

(Deprecated. Use the OperateBatchInstance API instead.) Performs an O&M operation on a single instance. The supported commands include:

• RERUN: Reruns an instance. Only instances in a 'Success' or 'Failed' state can be rerun. This re-processes the data and incurs resource usage fees.

• PAUSE: Pauses the instance. If a downstream instance is not running, its scheduling is also suspended.

• RESUME: Resumes a paused instance. This is the reverse of the PAUSE operation. The instance runs once its scheduling conditions are met.

• TERMINATE: Terminates scheduling for an instance. The instance will not be scheduled to run. If a downstream instance is not running, its scheduling is also suspended.

• SET_SUCCESS: Sets the instance state to success. This affects downstream scheduling and is primarily used to forcibly update the instance's scheduling status after a manual data refresh, allowing downstream instances to run.

• RERUN_DOWNSTREAM: Reruns the instance and selected downstream instances, re-processing data for the current business date.

Rerunning the instance or its downstream dependencies incurs additional costs.

Task O&M

ListSupplementDagrun

-

Lists the DagRun information for each business date in a data backfill workflow based on the specified query conditions.

ListSupplementInstance

-

Lists all node instances for a specific business date within a data backfill workflow.

QueryInstanceUpDownStream

-

Queries the upstream and downstream dependencies of an instance, supporting logical tables and code tasks (since v295-2).

NodeSupplementCommand

-

Parameters for a data backfill request.

CreateNodeSupplement

-

A general-purpose API for data backfill (supported since v295-2).

• Generates data backfill instances, affecting data in related output tables.

• Runs tasks and incurs computing and storage costs.

CreatePhysicalNodeSupplement

-

Creates a data backfill task for a physical node. Use the CreateNodeSupplement API instead.

• Re-processes data, affecting historical data.

• Re-processes node data, incurring computing and storage costs.

GetPhysicalNode

-

Retrieves a physical scheduling node.

GetPhysicalNodeByOutput

-

Retrieves a physical node by its output name.

GetPhysicalNodeContent

-

Retrieves the code content of a scheduling node.

GetPhysicalNodeOperationLog

-

Retrieves the operation log of a node.

ListDevDependency

-

Queries the configured upstream dependencies of a task in the development state.

ListNodes

-

Retrieves a list of scheduling nodes.

PausePhysicalNode

-

Pauses scheduling for a physical node (high-risk operation). This action prevents downstream tasks from being triggered. This operation currently supports only offline script tasks and pipeline integration tasks.

QueryDagFromPhysicalNode

-

Queries upstream and downstream nodes, starting from a physical node.

QueryNodeUpDownStream

-

A general-purpose API for querying upstream and downstream dependencies (supported since v295-2).

QueryOperationSubmitStatus

-

Use this API to query the submission status of a large-scale data backfill task (since v295-2).

ResumePhysicalNode

-

Resumes a paused physical node.

RunManualNode

-

Runs a manual node (supported since v295-2).

• Generates a manual scheduling node, affecting related tables.

• Runs a task and incurs computing and storage costs.

RunTriggerNode

-

Runs a triggered node.

SearchSupplementDownStream

-

Queries the downstream tasks for a data backfill (supported since v295-2).

• Supports multiple nodes.

• Supports logical table fields.

GetJobInfo

-

Retrieves information about a real-time job.

SyncEngineJobGraph

-

Enables the internal dlab platform to synchronize shadow data lineage task parameters to Dataphin tasks.

Alert messages

GetAlertEvent

-

Retrieves the details of an alert event.

QueryAlertEvents

ListAlertEvent

Queries for alert events that match specified criteria.

QueryAlertNotifications

ListAlertNotification

Queries for notification records that match specified criteria.

API (legacy)

API (current)

Description

Data architecture

CreateBusinessEntity

CreateBizEntity

Creates a business entity, such as a business object or a business activity.

DeleteBusinessEntity

DeleteBizEntity

Deletes one or more business entities of the same type. You must specify the business entity type, such as business object or business activity.

DescribeBusinessEntity

GetBizEntityInfo

Retrieves the details of a business entity, such as a business object or a business activity.

DescribeBusinessEntityByVersion

GetBizEntityInfoByVersion

Retrieves the version details of a business entity in the development environment (or production environment for Basic projects), including business objects and business activities.

ListBusinessEntities

ListBizEntities

Retrieves a paginated list of business entities in a flat structure.

You can perform a fuzzy search based on business unit ID or name, data domain ID or name, business entity subtype, owner ID, instantiation status, business entity status, and business entity name. Without search criteria, this API returns all business entities in the tenant.

OfflineBusinessEntity

OfflineBizEntity

Takes one or more business entities of the same type offline. You must specify the business entity type, such as business object or business activity.

SubmitBusinessEntity

OnlineBizEntity

Brings one or more business entities of the same type online. You must specify the business entity type, such as business object or business activity.

UpdateBusinessEntity

UpdateBizEntity

Updates a business entity, such as a business object or a business activity.

CreateBizUnit

-

Creates a business unit.

CreateDataDomain

-

Creates a data domain.

DeleteBizUnit

-

Deletes a business unit. You cannot delete a business unit that is associated with any projects, data domains, business qualifiers, atomic metrics, derived metrics, fact tables, dimension tables, or summary tables.

DeleteDataDomain

-

Deletes a data domain. You cannot delete a data domain that has child data domains or is associated with other objects, such as business entities.

DescribeBizUnit

GetBizUnitInfo

Retrieves information about a business unit by its ID.

DescribeDataDomain

GetDataDomainInfo

Retrieves information about a data domain.

ListBizUnits

-

Lists all business units from both development and production environments.

ListDataDomains

-

Retrieves a list of data domains. You can search by business unit ID, parent data domain ID, data domain name, code, or description.

UpdateBizUnit

-

Updates an existing business unit.

UpdateDataDomain

-

Updates a data domain.

Common definitions

UpdateGlobalVariable

-

Edits a global variable, including standard variables and those for account credentials.

Ad hoc query files

CreateAdHocFile

-

Creates an ad hoc query file.

CreateAdHocFileNew

CreateAdHocFile

Creates an ad hoc query file.

CreateFolder

-

Creates a directory in the menu tree for features such as compute tasks, data integration, and synchronization tasks.

DeleteAdHocFile

-

Deletes an ad hoc query file.

DeleteFolder

-

Deletes a directory from the menu tree.

GetAdHocFile

-

Retrieves an ad hoc query file.

ListFiles

-

Retrieves files in a menu tree directory.

MoveFile

-

Moves a file within the menu tree.

RenameFile

-

Renames a file in the menu tree.

UpdateAdHocFile

-

Updates an ad hoc query file.

UpdateAdHocFileNew

UpdateAdHocFileNew

Updates an ad hoc query file.

Common modeling and development

QueryObjectVersionListById

-

Retrieves the version history for a modeling and development object, including atomic metrics, business qualifiers, and derived metrics.

Business qualifiers

ListBizCondition

-

Retrieves a paginated list of business qualifiers. Without search criteria, this API returns all business qualifiers in the specified project.

QueryBizConditionById

-

Retrieves the details of a business qualifier.

QueryBizConditionVerDetailById

-

Retrieves the version details of a business qualifier.

QueryHomoBizConditionById

-

Retrieves details of same-source business qualifiers. 'Same-source' refers to business qualifiers that originate from the same logical table. A business qualifier can have three calculation logics for different time granularities, meaning it can originate from three logical tables with different time granularities.

Metrics

GetLogicalDefinitionSubTree

-

Retrieves the navigation tree structure for defined modeling objects, including atomic metrics, business qualifiers, and derived metrics.

ListAtomicIndex

-

Retrieves a paginated list of atomic metrics. Without search criteria, this API returns all native and derived atomic metrics in the specified project.

ListDerivedIndex

-

Retrieves a paginated list of derived metrics. Without search criteria, this API returns all derived and registered metrics in the specified project.

QueryAtomicIndexById

-

Retrieves the details of an atomic metric.

QueryAtomicIndexVerDetailById

-

Retrieves the version details of an atomic metric.

QueryDerivedIndexById

-

Retrieves the details of a derived metric.

QueryDerivedIndexVerDetailById

-

Retrieves the version details of a derived metric.

QueryHomoAtomicIndexById

-

Retrieves details of same-source atomic metrics. 'Same-source' refers to atomic metrics that originate from the same logical table. An atomic metric can have three calculation logics for different time granularities, meaning it can originate from three logical tables with different time granularities.

Logical tables

GetLogicalModelSubTree

-

Retrieves the navigation tree structure for logical table objects.

QueryDimTableById

-

Retrieves the details of a dimension table.

QueryFactTableById

-

Retrieves the details of a fact table.

QueryGranularityBySummaryId

-

Retrieves the dimension details for a summary table's aggregation granularity.

Batch tasks

CancelTask

-

Terminates a task (supported since v3.5.3). This is an idempotent operation. If the task has already been terminated, the API returns a normal response.

CloseJdbcConnection

-

Closes a JDBC connection (supported since v3.5.3).

CreateBatchTaskFile

CreateBatchTask

Creates a batch task.

CreateJdbcConnection

-

Creates a JDBC connection (supported since v3.5.3).

DeleteBatchTaskFile

DeleteBatchTask

Deletes a batch task. The task must be offline before you can delete it.

ExecSqlByJdbc

-

Executes SQL statements over a JDBC connection (supported since v3.5.1).

ExecTask

ExecuteAdHocTask

Executes an ad hoc query task.

FetchSqlResult

-

Fetches the result of an SQL execution (supported since v3.5.3). Call this API after a task completes successfully to retrieve its results. If the task has not finished or has failed, this API returns empty data.

GetBatchTaskFile

GetBatchTaskInfo

Retrieves the details of a batch task.

GetBatchTaskFileByVersion

GetBatchTaskInfoByVersion

Retrieves the version details of a batch task in the development environment (or production environment for Basic projects).

GetLineages

GetBatchTaskUdfLineages

Retrieves the custom data lineage information for a task.

KillTask

StopAdHocTask

Stops an ad hoc query task.

ListBatchTaskFileVersions

GetBatchTaskVersions

Retrieves the version history of a batch task.

OfflineBatchTaskFile

OfflineBatchTask

Takes a batch task offline.

ParseDependency

ParseBatchTaskDependency

Parses the logical table dependencies for a batch task. Note: The upstream dependency information in the parsing result may include self-dependent nodes (where the upstream node ID is the same as the parsed task node ID). You must handle this case in your application.

QuerySqlTaskStatus

-

Retrieves the status of an SQL task (supported since v3.5.1).

QueryTaskLog

GetAdHocTaskLog

Retrieves the run log for an ad hoc query task.

QueryTaskResult

GetAdHocTaskResult

Retrieves the run result of an ad hoc query task.

SaveLineages

UpdateBatchTaskUdfLineages

Saves custom data lineage for a task.

SubmitBatchTaskFile

SubmitBatchTaskFileV2

Submits a batch task.

SubmitBatchTaskFileV2

SubmitBatchTask

Submits a batch task. This API can replace SubmitBatchTaskFile. Unlike the previous version, SubmitBatchTaskFileV2 also returns the submission record ID after a successful submission.

The SubmitBatchTaskFileV2 interface also returns the ID of the object to be released upon successful task submission.

UpdateBatchTaskFile

UpdateBatchTask

Updates a batch task.

Stream jobs

GetDirectoryTree

-

Retrieves the storage directory for stream jobs.

GetClusterQueueInfoByEnv

-

Retrieves the resource queue for stream jobs.

GetQueueEngineVersionByEnv

-

Retrieves the engine version for stream jobs.

CreateStreamBatchJobMapping

-

Creates a Flink SQL task.

GetStreamJobs

-

Retrieves a list of stream jobs.

Pipelines

PipelineAsyncExeResult

-

Contains the status and result of an asynchronous pipeline execution.

FileInfo

-

File information stored in a pipeline.

HopCommand

-

Configuration for a hop (edge) in a pipeline.

NodeRelationInternal

-

Scheduling dependency configuration.

PipelineCommand

-

Pipeline configuration.

PipelineObject

-

Pipeline object.

PipelineSettings

-

Task channel configuration.

PipelineTreeNodeBriefDTO

-

Brief information about the pipeline directory tree.

QueryPipelineDirectoryTreeCommand

-

Queries the pipeline directory tree.

ScheduleCommand

-

Pipeline scheduling configuration.

StepCommand

-

Configuration for a step in a pipeline.

AsyncCreatePipeline

-

Asynchronously creates a pipeline in a single step.

CreatePipeline

-

Creates a pipeline task.

CreatePipelineNode

-

Creates a real-time integration task (basic information only).

GetAsyncExeResult

-

Retrieves the status and result of an asynchronous execution.

GetPipeline

-

Retrieves the details of a pipeline task.

GetPipelineByVersion

-

Retrieves the version details of a pipeline in the development environment (or production environment for Basic projects).

ListAsyncExeResult

-

Retrieves a list of statuses and results for asynchronous executions.

ListPipeline

-

Retrieves a list of pipeline tasks.

ListPipelineDirectoryTree

-

Retrieves a list of integration directories.

OfflineAndDeletePipeline

-

Takes a pipeline offline and deletes it. This action is irreversible.

OfflinePipeline

-

Takes a pipeline task offline.

SubmitPipeline

-

Submits a pipeline task.

UpdatePipeline

-

Updates a pipeline task.

Components

ADB for MySQL 2.0

-

Output component for AnalyticDB for MySQL 2.0.

ADB for MySQL 3.0

-

Input and output component for AnalyticDB for MySQL 3.0.

ADB for PostgreSQL

-

Input and output component for AnalyticDB for PostgreSQL.

Column

-

Construct with the built-in Builder.

ColumnCalculation

-

Field calculation component.

ColumnFilter

-

Filter component.

ColumnMapping

-

Construct with the built-in Builder.

ColumnSelection

-

Field selection component.

ConditionalDistribution

-

Conditional distribution component.

IBM DB2

-

Input and output component.

HBase

-

Input and output component.

Hive

-

Input and output component.

Logical table

-

Logical table input component.

MaxCompute

-

Input and output component.

MySQL

-

Input and output component.

OSS

-

Input and output component.

OceanBase

-

Input and output component.

Oracle

-

Input and output component.

PolarDB

-

Input and output component.

PolarDB-X (formerly DRDS)

-

Input and output component.

PostgreSQL

-

Input and output component.

SpeedLimit

-

Rate limiting component.

SQL Server

-

Input and output component.

Teradata

-

Input and output component.

Vertica

-

Input and output component.

Publication

GetLatestSubmitDetail

GetLatestSubmitDetail

Retrieves the details of the latest submission record for a data processing task, pipeline object, or asset decoupling task.

ListObjectsToPublish

ListSubmitRecords

Lists submission records for data processing tasks, pipeline objects, and asset decoupling tasks.

ListPublishingHistory

ListPublishRecords

Lists publication records for data processing tasks, pipeline objects, and asset decoupling tasks.

PublishObject

PublishObjectList

Publishes objects such as data processing tasks, pipeline objects, and asset decoupling tasks. Call the ListSubmitRecords API to get the required submission ID.

Resources

CreateResource

-

Creates a resource.

DeleteResource

-

Deletes a resource.

GetGlobalResourceStorageCredential

GetFileStorageCredential

Retrieves credentials for uploading resource files.

GetResource

-

Retrieves the details of a resource.

GetResourceByVersion

-

Retrieves the version details of a resource in the development environment (or production environment for Basic projects).

GetResourceStorageCredential

GetFileStorageCredential

Retrieves credentials for uploading resource files with the OSS SDK.

UpdateResource

-

Updates a resource.

Functions

CreateUdf

-

Creates a user-defined function (UDF).

DeleteUdf

-

Deletes a user-defined function (UDF).

GetUdf

-

Retrieves the details of a user-defined function (UDF).

GetUdfByVersion

-

Retrieves the version details of a user-defined function (UDF).

UpdateUdf

-

Updates a user-defined function (UDF).

API (legacy)

API (new)

Description

BindGroupToApp

-

Binds a group to an application.

CreateGroupByImport

-

Imports a group.

CreateGroupPageQuery

-

Creates a paginated query for a group.

DeleteGroup

-

Deletes a group.

DeleteGroupPage

-

Deletes the paginated query service for a group.

DeleteGroupVersion

-

Deletes a group version.

EditGroupPageQuery

-

Edits a paginated query for a group.

GetComputeSourceFileStorageCredentials

-

Retrieves credentials to upload a compute source configuration file.

GetGroupPageApiCode

-

Retrieves the API code for a group's paginated query service.

GetOnlineClusterById

-

Retrieves the details of a group by its ID.

GetOnlineFeatureById

-

Retrieves the details of a tag by its ID.

ListOnlineFeatures

-

Retrieves a list of tags from the marketplace.

ListApplyFeaturesInProject

-

Retrieves a list of tags requested in the current project.

ListApps

-

Retrieves a list of applications. (New in v3.14.1)

ListFeaturesInProject

-

Retrieves a list of tags developed in the current project.

ListGroupPageSubscription

-

Retrieves a list of published, paginated query services for groups.

ListGroupsInApp

-

Retrieves a list of groups requested within an application. (New in v3.14.1)

ListOnlineClusters

-

Retrieves a list of groups from the marketplace.

ListTagsInApp

-

Retrieves a list of tags requested within an application. (New in v3.14.1)

ListingGroup

-

Lists a group in the marketplace.

OfflineGroup

-

Takes a group offline.

OfflineGroupPage

-

Takes the paginated query service for a group offline.

OnlineGroupPageQuery

-

Publishes a paginated query for a group.

PublishAndOnlineGroup

-

Publishes a group version and lists it in the marketplace.

PublishGroup

-

Publishes a group version.

QueryGroupStatus

-

Retrieves the status of a group.

QueryGroupVersionStatus

-

Retrieves the status of a group version.

QuerySubscriptionStatus

-

Retrieves the status of the offline service for a group.

RevokeGroup

-

Revokes a group.

SaveGroup

-

Creates a group.

SaveGroupVersion

-

Creates a new group version.

SubmitGroupVersion

-

Submits a group version.

SupplementGroupData

-

Backfills data for a group.

SupplementGroupPageData

-

Backfills data for the paginated query service of a group.

UnlistingGroup

-

Unlists a group from the marketplace (approval not required).

API (legacy)

API (new)

Description

Metadata

GetTableColumnLineage

-

Queries column lineage.

GetTableLineage

-

Queries table lineage.

GetTableLineageByTaskId

GetTableLineageByTaskId

Queries table lineage by task ID.

GetTableColumnLineageByTaskId

GetTableColumnLineageByTaskId

Queries column lineage by task ID.

ListCatalogTableColumns

-

Lists the columns of an asset table.

ListLogicTableColumns

-

Lists the columns of a logic table.

ListRealtimeTableColumns

-

Lists the columns of a real-time metatable.

ListTableColumns

-

Lists the columns of a physical table.

ListTablePartitions

-

Lists physical partitions.

ListTables

-

Lists table metadata.

QueryLogicTable

-

Queries the details of a logic table.

QueryRealtimeTable

-

Queries the details of a real-time metatable.

QueryTable

-

Queries the details of a physical table.

QueryTableLineage

-

[Deprecated] Queries column lineage. Real-time metatables are not supported.

Use the GetTableColumnLineage API instead.

RegisterAssetMetaData

-

Registers the metadata for a new asset type.

ReportAsset

-

Reports an asset to Dataphin.

SearchCatalogTable

-

[Deprecated] Queries asset table metadata. Use the SearchCatalogTableV2 API instead.

Data standard

CancelInvalidMappingRelation

-

Cancels an invalid mapping relation.

CancelValidMappingRelation

-

Cancels a valid mapping relation.

ChangeValidMappingRelationToInvalid

-

Changes a valid mapping relation to an invalid one.

CreateLookupTable

-

Creates a lookup table.

CreateMappingRelations

-

Creates both valid and invalid mapping relations.

CreateStandard

-

Creates a data standard.

CreateStandardRelations

-

Creates standard relations.

CreateStandardSet

-

Creates a standard set.

CreateStandardTemplate

-

Creates a standard template.

CreateWordRoot

-

Creates a word root.

DeleteLookupTable

-

Deletes a lookup table.

DeleteStandardRelations

-

Deletes standard relations.

DeleteStandardSet

-

Deletes a standard set.

DeleteWordRoot

-

Deletes a word root.

FuzzySearchStandard

-

Performs a paginated search for standards that match the specified criteria.

DeleteStandard

-

Deletes a data standard.

GetStandardStatisticsOfType

-

Gets the number of standards in a directory, grouped by standard type.

QueryLookupTable

-

Queries the details of a lookup table.

QueryMappingRelationByAsset

-

Queries mapping relations by asset.

QueryMappingRelationByBelongAsset

-

Queries mapping relations by the owning asset.

QueryStandard

-

Queries a data standard by its ID, for a specific version and status.

QueryStandardSet

-

Queries a standard set by ID.

QueryStandardTemplate

-

Queries a standard template by ID.

QueryWordRoot

-

Queries the details of a word root.

SubmitStandard

-

Publishes a data standard.

UnpublishStandard

-

Takes a published standard offline.

UpdateLookupTable

-

Updates a lookup table.

UpdateStandard

-

Updates a data standard.

UpdateStandardSet

-

Updates a standard set.

UpdateStandardTemplate

-

Updates a standard template.

UpdateWordRoot

-

Updates a word root.

Data quality

AssignQualityRuleSchedules

-

Binds quality rules to scheduling settings.

GetQualityAlert

-

Gets the alert setting by monitored object ID.

GetQualityRule

-

Gets a quality rule by ID.

GetQualityRuleTask

-

Gets a quality task by ID.

GetQualityRuleTaskLog

-

Gets the logs of a quality task by ID.

GetQualitySchedule

-

Gets a scheduling setting by ID.

GetQualityTemplate

-

Gets a quality template by ID.

GetQualityWatch

-

Gets a monitored object by ID.

GetQualityWatchByObjectId

-

Gets a monitored object by its original ID, such as the ID of a data source, table, or metric.

GetQualityWatchTask

-

Gets a monitoring task by ID.

GetQualityWatchTaskLog

-

Gets the logs of a monitoring task by ID.

ListQualitySchedules

-

Lists the scheduling settings for a specified monitored object.

OpenCloseQualityRules

-

Enables or disables quality rules in a batch.

OpenCloseQualityWatches

-

Enables or disables monitored objects in a batch.

PagedQueryQualityRuleTasks

-

Performs a paginated query for quality rule tasks.

PagedQueryQualityRules

-

Performs a paginated query for quality rules.

PagedQueryQualityTemplates

-

Performs a paginated query for quality templates.

PagedQueryQualityWatchTasks

-

Performs a paginated query for monitoring tasks on monitored objects.

PagedQueryQualityWatches

-

Performs a paginated query for monitored objects.

RemoveQualityRuleSchedules

-

Unbinds quality rules from scheduling settings in a batch.

RemoveQualityRules

-

Deletes quality rules in a batch.

RemoveQualitySchedules

-

Deletes scheduling settings in a batch.

RemoveQualityTemplates

-

Deletes quality templates in a batch.

RemoveQualityWatches

-

Deletes monitored objects in a batch.

SaveQualityAlert

-

Creates or modifies an alert setting for a monitored object.

SaveQualityRule

-

Creates or modifies a quality rule.

SaveQualitySchedule

-

Creates or modifies a scheduling setting.

SaveQualityTemplate

-

Creates or modifies a quality template.

SaveQualityWatch

-

Creates or modifies a monitored object for data quality monitoring. Supported object types include Dataphin tables, global tables, data sources, metrics, and real-time metatables.

SubmitQualityRuleTasks

-

Submits quality rule tasks in a batch. Trial runs are supported.

SubmitQualityWatchTasks

-

Submits verification tasks for monitored objects in a batch.

Data security

AddSecurityLabel

-

Creates a security identification result. You can choose to overwrite existing results or modify results in the production environment.

CreateClassifyCatalog

-

Creates a data classification catalog. Users with the Data Classification - Management permission can create any catalog. Level-1 catalog administrators can create catalogs only under that catalog.

CreateSecurityClassify

-

Creates a security classification.

CreateSecurityLevel

-

Creates a security level.

GetSecretKeyByName

-

Queries the details of a secret key by name.

GetSecurityClassifyDetail

-

Queries the details of a security classification by ID.

GetSecurityLabelById

-

Gets a security identification result by ID.

GetSecurityLevelDetail

-

Queries the details of a security level by ID.

PagedQuerySecurityIdentifyRecordsOfField

-

Performs a paginated query for the security identification records of a specific field.

PagedQuerySecurityLabels

-

Performs a paginated query for security identification results.

RemoveClassifyCatalog

-

Deletes a data classification catalog. Users with the Data Classification - Management permission can delete any catalog. A level-1 catalog administrator can delete only that catalog and its subcatalogs.

RemoveSecurityClassify

-

Deletes a security classification.

RemoveSecurityLabels

-

Deletes security identification results in a batch.

RemoveSecurityLevel

-

Deletes a security level.

UpdateClassifyCatalog

-

Updates a data classification catalog. Users with the Data Classification - Management permission can modify any catalog. A level-1 catalog administrator can modify only that catalog and its subcatalogs. To move a catalog, the user must have administrator permissions for both the source and target level-1 catalogs.

UpdateSecurityClassify

-

Updates a security classification.

UpdateSecurityLabelsEnableStatus

-

Enables or disables security identification results in a batch.

UpdateSecurityLabelsIdentifyRule

-

Updates the identification rules for security identification results in a batch.

UpdateSecurityLevel

-

Updates a security level.

Data service

CreateDataServiceApi

-

Creates and submits a data service API.

PublishDataServiceApi

-

Publishes a specified version of an API to the production environment.

ListApiByApp

-

Lists details of APIs authorized for an application.

QueryApiDocument

GetDataServiceApiDocument

Gets an API document.

QueryApiLogPage

ListDataServiceApiCalls

Queries API call logs.

QueryApiServiceGroup

GetDataServiceApiGroups

Queries API service groups.

QueryApiServicePage

ListDataServicePublishedApis

Performs a paginated query for published APIs.

QueryErrorImpact

GetDataServiceApiErrorImpactSummary

Analyzes the impact of API errors.

QueryIndicators

GetDataServiceApiCallSummary

Queries a summary of API call statistics.

QueryVisitTrend

GetDataServiceApiCallTrend

Analyzes API access trends for monitoring.

ApplyApi

ApplyDataServiceApiPermission

Applies for API permissions.

QueryApiAuthPage

ListDataServiceAuthorizedApis (can be replaced by the existing ListAuthorizedDataServiceApiDetails API)

Lists the APIs that the current user is authorized to access.

QueryApiGroup

GetDataServiceAuthorizedApiGroups

Queries the API service groups in the current project.

QueryGroupApi

-

Queries APIs in a group.

QueryPrivateApp

GetDataServiceAuthorizedAppsByGroupId

Queries applications the current account is authorized to access.

ApplyApp

ApplyDataServiceAppPermission

Applies for application permissions.

QueryAppAuthPage

ListDataServiceAuthorizedApps

Queries applications the current user is authorized to access.

QueryAppGroup

GetDataServiceAuthorizedAppGroups

Queries application groups in the current project.

QueryGroupApp

GetDataServiceAppsByGroupId

Queries applications in a group.

ApplyDataSource

-

Applies for Dataphin data source permissions.

QueryDataSourceAppGroup

-

Queries Dataphin data source groups.

QueryDataSourceAuthPage

-

Performs a paginated query for authorized Dataphin data sources within a project.

QueryDataSourceGroup

-

Queries the data source groups in the current tenant's projects.

QueryGroupDataSource

-

Lists the Dataphin data sources within a Dataphin data source group.

QueryLogicalTable

-

Queries the logic tables in a specified Dataphin data source.

QueryPhysicalTable

-

Queries the physical tables in a specified Dataphin data source.

QueryTableColumn

-

Queries the table columns of a Dataphin data source.

AuthorizeApi

GrantDataServiceApiPermission

Grants API permissions.

QueryMyApiPage

ListDataServiceMyApiPermissions

Lists API permissions.

RecycleApi

RevokeDataServiceApiPermission

Revokes API permissions.

AuthorizeApp

GrantDataServiceAppPermission

Grants application permissions.

GrantAppToUser

GetDataServiceAppAdmins

Queries the administrators of an application.

ListAppAuthUser

GetDataServiceAppAuthorizedUsers

Lists users with permissions for an application.

QueryMyAppPage

ListDataServiceMyAppPermissions

Queries applications the current user has permission to access.

RecycleApp

RevokeDataServiceAppPermission

Revokes application permissions.

AuthorizeDataSource

-

Authorizes an application to access a Dataphin data source.

QueryMyDataSourcePage

-

Queries data sources the current user has permission to access.

RecycleDataSource

-

Revokes Dataphin data source permissions.

ListAuthorizedDataServiceApiDetails

-

Lists details of authorized data service APIs.

ListManagerProject

GetDataServiceMyProjects

Lists projects where the current user is an administrator.

ListDataphinDsPermissions

-

Checks if the current tenant has permissions for the Dataphin data service.

QueryDataSourceDocument

-

Queries the details of a Dataphin data source by ID.

QueryDataSourceServicePage

-

Performs a paginated query for Dataphin data sources.

QueryApiImpactDetail

ListDataServiceApiImpacts

Lists the impact analysis results for an API.

QueryApiMonitor

ListDataServiceApiMaintanceStatistics

Queries API maintenance statistics.

CreateProjectUser

AddDataServiceProjectMember

Adds a user to a project and assigns a role.

ListDataphinUser

GetDataServiceProjectMembers

Lists users in the current tenant's projects.

ListPrivilegedProject

GetDataServiceAuthorizedProjects

Lists projects the current user is authorized to access.

QueryProjectPage

ListDataServiceProjects

Performs a paginated query for projects.

QueryProjectUserPage

-

Performs a paginated query for project members.

pageInfo

-

N/A.

ParseSql

ParseDataServiceSql

Parses SQL statements.

SqlLegalityVerify

CheckDataServiceSqlLegality

Validates and authorizes SQL statements.

API (old interface)

API (new interface)

Description

Purchased features

ListFeatures

-

Retrieves a list of features available to the current tenant.

Project management

AddProjectMembers

AddProjectMember

Adds members to a project. This operation supports Basic and DEV_PROD projects.

DeleteProjectMembers

DeleteProjectMember

Deletes members from a project. This operation supports Basic and DEV_PROD projects.

GetProject

-

Retrieves project information based on the project ID and environment.

GetProjectByName

-

Retrieves project information by project name. To query a project in the development environment, append the_dev suffix to the project name.

ListProjectByProjectType

-

Filters projects by project type.

ListProjectMembers

-

Retrieves a list of project members based on the project ID and environment.

ListProjects

-

Filters projects by project type.

QueryProjectWhiteList

GetProjectWhiteLists

Retrieves the project allowlist by project ID.

UpdateProjectMembers

UpdateProjectMember

Updates project members. This operation supports Basic and DEV_PROD projects.

Data sources

CheckDataSourceConnectivity

-

Checks the connectivity of a data source.

CheckExistDataSourceConnectivity

-

Checks the connectivity of an existing data source.

CreateDataSource

-

Creates a data source. You can create a data source for the production environment only, create data sources for both development and production environments, or add a development data source to an existing production data source.

DeleteDevProdModeDataSource

-

Deletes a data source. You can delete a data source from the development environment only or from both the development and production environments. In Dataphin, a development data source cannot exist independently.

ListDataSourceDependency

GetDataSourceDependencies

Searches for data source dependencies and returns them in a list.

SearchDataSourceConfig

-

Searches for data sources and returns a paginated list. The data sources are returned as development-production pairs.

UpdateDataSourceBasicInfo

-

Updates the basic information of a data source, such as its name and description.

UpdateDataSourceConfiguration

-

Updates the configuration of a data source, such as the connection URL, username, and password.

Row-level permissions

ListRowPermission

-

Retrieves a list of row-level permissions.

GetAccountByRowPermissionId

-

Retrieves all authorized accounts for a specific row-level permission by its ID.

ListAccountByRowPermissionId

-

Retrieves a list of accounts by row-level permission ID.

CreateRowPermission

-

Creates a new row-level permission.

DeleteRowPermission

-

Deletes a row-level permission by its ID.

UpdateRowPermissionBasicInfo

-

Updates the basic information of a row-level permission.

AddControlRule

-

Adds a control rule for a row-level permission.

UpdateControlRule

-

Updates a control rule for a row-level permission.

DeleteControlRule

-

Deletes a control rule for a row-level permission.

AddAssociatedTable

-

Adds row-level permission information for an associated table.

DeleteAssociatedTable

-

Deletes the row-level permission information for an associated table.

ListRowPermissionByUserId

-

Retrieves a list of row-level permissions for a user.

UpdateRowPermission

-

Updates a row-level permission.

Compute sources

CheckComputeSourceConnectivity

-

Checks the connectivity of a compute source configuration.

CheckComputeSourceConnectivityById

-

Checks the connectivity of a compute source by its ID.

CreateComputeSource

-

Creates a compute source.

DeleteComputeSource

-

Deletes a compute source.

GetComputeSource

GetComputeSourceInfo

Retrieves information about a compute source by its ID.

GetComputeSourceFileCredentials

GetFileStorageCredential

Retrieves credentials for uploading compute source configuration files.

QueryComputeSource

ListComputeSources

Lists compute sources.

SetTenantComputeEngine

UpdateTenantComputeEngine

Sets the compute engine for a tenant.

UpdateComputeSource

-

Updates a compute source.

Users and authorization

AddUser

-

Adds a user to a tenant. This adds the user to Dataphin on the Management Center > Member Management > Member Management page.

BatchAddTenantMember

-

Adds users to a tenant in batches. This adds the users to Dataphin on the Management Center > Member Management > Member Management page.

BatchGetUsers

-

Retrieves user information in batches byUserId.

BatchSyncUsers

-

Synchronizes tenant member information.

CheckResourcePermission

-

Checks whether a personal or production account has permissions on a specific resource.

CreateUserGroup

-

Creates a user group.

DeleteUserGroup

-

Deletes a user group.

GetDataSourceUserList

-

Queries users who have permissions on a data source by data source ID.

GetOpsTenant

-

Retrieves O&M tenant information.

GetPermissionChangeObjects

-

Retrieves details about objects affected by permission changes.

GetProjectProduceUser

-

Retrieves the production account for a project.

GetRoleListByUserId

-

Retrieves the list of roles assigned to a user.

GetUserGroup

-

Retrieves details for a user group.

GetUserInfoBySourceId

-

Retrieves the Dataphin user information mapped to an external account ID.

GrantByResource

-

Grants permissions on a resource to a user.

GrantPermissionToDataSource

-

Grants multiple permissions on a data source to multiple users. Use the GrantByResource API instead.

GrantRole

-

Grants a role to a user. This API is deprecated. To set tenant-level roles, use the UpdateTenantMembers API.

IsProductAdmin

-

Checks whether the current user is a super administrator for a product.

ListAddableRoles

-

Retrieves roles that can be assigned to members (in Management Center > Member Management).

ListAssetPermissionAudit

-

Retrieves a paginated list of asset permission audit records.

ListPermissionChangeLog

-

Retrieves permission change records using a cursor.

ListPermissionOperationAudit

-

Retrieves a paginated list of permission operation audit records.

ListDepts

-

Lists the departments in a tenant.

ListUserGroup

-

Retrieves a paginated list of user group information.

ListUserGroupMember

-

Retrieves a paginated list of user group members.

ListUsers

-

Retrieves a paginated list of user information.

MineTenants

-

Lists the tenants of the current user.

QueryPagedAddableUsers

-

Retrieves a paginated list of users who can be added to a tenant.

QueryPagedDept

-

Retrieves a paginated list of top-level department information.

QueryPagedMembers

-

Retrieves a paginated list of members.

RemoveUser

-

Removes a user from a tenant.

RevokeByResource

-

Revokes a user's permissions on a resource.

RevokePermissionFromDataSource

-

Revokes a user's permissions on a data source. Use the RevokeByResource API instead.

UpdateTenantMemberStatus

-

Updates the enabled or disabled status of a tenant member.

UpdateTenantMembers

-

Updates tenant member information.

UpdateUserGroup

-

Updates the member list of a user group.

UpdateUserGroupSwitch

-

Changes the enabled or disabled status of a user group.

AddUserToUserGroup

-

Adds a user to a user group.

RemoveUserFromUserGroup

-

Removes a user from a user group.

UpdateTenantMembersStatus

-

Enables or disables a user.

ListTenantRolesByUserId

-

Retrieves tenant-level roles by user ID.

ListTenantRoles

-

Retrieves tenant-level roles.

Python third-party packages

ListPythonModule

-

Retrieves a paginated list of Python third-party packages.