Dataphin:List of OpenAPI operations

API (old interface)

API (new interface)

API description

Instance O&M

GetInstanceDownstream

-

Queries the downstream instances of a specified instance.

GetPhysicalInstanceLog

-

Gets the execution logs of an instance. If the instance is rerun multiple times, multiple logs are generated.

GetScriptInstance

-

Queries script instance information, including the instance status and runtime.

InstanceFixData

-

Reruns downstream instances to fix trace data. You can force a rerun for downstream instances that are affected. This operation:

• Generates compute costs.

• Affects data output.

ListNormalInstance

-

Gets a paginated list of instances based on specified query conditions. Instance types include recurring instances and one-time instances.

OperateBatchInstance

-

• Performs batch operations on physical instances and logical table task instances. This feature is supported from version 295-2.

• Rerunning a node or its downstream nodes refreshes data and affects historical data.

• Rerunning a node or its downstream nodes incurs compute and storage costs.

• Suspending an instance is a high-risk operation and may prevent it from being scheduled. Use this command with caution.

The following O&M operations are supported for instances:

• RERUN: Reruns the node and refreshes data for the current data timestamp.

• PAUSE: Pauses an instance. If its downstream instances have not run, they are also suspended and cannot be scheduled.

• RESUME: Resumes a paused instance. After it is resumed, the instance is scheduled to run when its scheduling conditions are met.

• TERMINATE: Stops an instance. After it is stopped, the instance is not scheduled to run. If its downstream instances have not run, they are also suspended from scheduling.

• SET_SUCCESS: Sets the instance status to successful. This affects downstream scheduling. This is mainly used to forcefully update the instance scheduling status after you manually refresh data, which allows downstream instances to be scheduled.

To rerun downstream instances, use the InstanceFixData API.

OperateInstance

-

(Use the new OperateBatchInstanceRequest API instead) Performs O&M operations on an instance. The available commands include the following:

• RERUN: Reruns an instance. Only successful or failed instances can be rerun. After the rerun, data is resent, and resource usage fees are incurred.

• PAUSE: Pauses an instance. If its downstream instances have not run, they are also suspended from scheduling.

• RESUME: Resumes a paused instance. After it is resumed, the instance is scheduled to run when its scheduling conditions are met.

• TERMINATE: Stops an instance. After it is stopped, the instance is not scheduled to run. If its downstream instances have not run, they are also suspended from scheduling.

• SET_SUCCESS: Sets the instance status to successful. This affects downstream scheduling. This is mainly used to forcefully update the instance scheduling status after you manually refresh data, which allows downstream instances to be scheduled.

• RERUN_DOWNSTREAM: Reruns downstream instances. This refreshes the data for the current data timestamp of the instance and its selected downstream instances.

Rerunning an instance or its downstream instances incurs extra fees for running nodes.

Task Operations and Maintenance

ListSupplementDagrun

-

Lists the DagRun information for each data timestamp under a data backfill workflow based on query conditions.

ListSupplementInstance

-

Lists all node instances for a specific data timestamp in a data backfill workflow.

QueryInstanceUpDownStream

-

Queries the ancestor and descendant nodes of an instance. This API supports logical tables and code nodes. This feature is supported from version 295-2.

NodeSupplementCommand

-

Specifies the parameters for a data backfill request.

CreateNodeSupplement

-

Provides a general-purpose data backfill API. This feature is supported from version 295-2.

• Generates data backfill instances to run, which affects data in related output tables.

• Runs nodes, which incurs compute and storage costs.

CreatePhysicalNodeSupplement

-

Creates a data backfill instance for a physical node. We recommend that you use the CreateNodeSupplement API.

• Refreshes data, which affects historical data.

• Refreshes node data, which incurs compute and storage costs.

GetPhysicalNode

-

Queries physical scheduling nodes.

GetPhysicalNodeByOutput

-

Queries physical nodes by output name.

GetPhysicalNodeContent

-

Queries the code of a scheduling node.

GetPhysicalNodeOperationLog

-

Queries the operation logs of a node.

ListDevDependency

-

Queries the upstream dependencies configured for a developer node.

ListNodes

-

Queries the list of scheduling nodes.

PausePhysicalNode

-

Pauses the scheduling of a physical node. This is a high-risk operation. It pauses node scheduling, and downstream nodes cannot be triggered. This API currently supports only offline code nodes and integration nodes.

QueryDagFromPhysicalNode

-

Queries the ancestor and descendant nodes of a node, starting from a physical node.

QueryNodeUpDownStream

-

Provides a general-purpose API for querying ancestor and descendant nodes. This feature is supported from version 295-2.

QueryOperationSubmitStatus

-

Queries the submission status of a data backfill after it is performed in high-volume mode. This feature is supported from version 295-2.

ResumePhysicalNode

-

Resumes the scheduling of a physical node.

RunManualNode

-

Runs a one-time node. This feature is supported from version 295-2.

• Generates a one-time scheduling node, which affects related tables.

• Runs the node, which incurs compute and storage costs.

RunTriggerNode

-

Runs a trigger-based node.

SearchSupplementDownStream

-

Queries the downstream nodes for a data backfill. This feature is supported from version 295-2.

• Supports multi-node deployment.

• Supports logical table fields.

GetJobInfo

-

Queries real-time job information.

SyncEngineJobGraph

-

Allows the internal DLab platform to sync shadow trace node parameters to Dataphin nodes.

Alert messages

GetAlertEvent

-

Gets alert event details.

QueryAlertEvents

ListAlertEvent

Queries multiple alert events based on specified conditions.

QueryAlertNotifications

ListAlertNotification

Queries multiple push records based on specified conditions.

API (old interface)

API (new interface)

API description

Data architecture

CreateBusinessEntity

CreateBizEntity

Creates business entities, including business objects and business activities.

DeleteBusinessEntity

DeleteBizEntity

Deletes business entities. You can batch delete business entities of the same type. When deleting, specify the business entity type. Supported types are business objects and business activities.

DescribeBusinessEntity

GetBizEntityInfo

Queries the details of business entities, including business objects and business activities.

DescribeBusinessEntityByVersion

GetBizEntityInfoByVersion

Queries the version details of business entities in the development environment. For Basic projects, this is the production environment. The details include business objects and business activities.

ListBusinessEntities

ListBizEntities

Performs a paged query of the business entity list in a flat structure.

You can perform a fuzzy search based on the domain ID and name, subject area ID and name, business entity subtype, owner ID, instantiation status, business entity status, and business entity name. If you do not set search conditions, the business entity list is queried within the tenant scope.

OfflineBusinessEntity

OfflineBizEntity

Takes business entities offline. You can batch take business entities of the same type offline. When taking them offline, specify the business entity type. Supported types are business objects and business activities.

SubmitBusinessEntity

OnlineBizEntity

Publishes business entities. You can batch publish business entities of the same type. When publishing, specify the business entity type. Supported types are business objects and business activities.

UpdateBusinessEntity

UpdateBizEntity

Updates business entities, including business objects and business activities.

CreateBizUnit

-

Creates a data domain.

CreateDataDomain

-

Creates a subject area.

DeleteBizUnit

-

Deletes a data domain. A data domain cannot be deleted if it is associated with projects, subject areas, business filters, atomic metrics, derived metrics, logical fact tables, logical dimension tables, or aggregate tables.

DeleteDataDomain

-

Deletes a subject area. A subject area cannot be deleted if it has child subject areas or business entities.

DescribeBizUnit

GetBizUnitInfo

Gets domain information based on the data domain ID.

DescribeDataDomain

GetDataDomainInfo

Views subject area information.

ListBizUnits

-

Lists all data domains, without distinguishing between DEV and PROD environments.

ListDataDomains

-

Gets a list of subject areas. You can search by data domain ID, parent subject area ID, subject area name, code, or description.

UpdateBizUnit

-

Updates an existing data domain.

UpdateDataDomain

-

Updates a subject area.

Common Definitions

UpdateGlobalVariable

-

Edits a global variable. You can edit regular variables and global variables for account passwords.

Ad hoc query files

CreateAdHocFile

-

Creates an ad hoc query file.

CreateAdHocFileNew

CreateAdHocFile

Creates an ad hoc query file.

CreateFolder

-

Creates a folder in the navigation tree. This supports features such as compute nodes and data integration sync nodes.

DeleteAdHocFile

-

Deletes an ad hoc query file.

DeleteFolder

-

Deletes a folder from the navigation tree.

GetAdHocFile

-

Queries an ad hoc query file.

ListFiles

-

Queries files in a navigation tree folder.

MoveFile

-

Moves a file in the navigation tree.

RenameFile

-

Renames a file in the navigation tree.

UpdateAdHocFile

-

Updates an ad hoc query file.

UpdateAdHocFileNew

UpdateAdHocFileNew

Updates an ad hoc query file.

Modeling development common

QueryObjectVersionListById

-

Gets a list of version information for modeling development objects. You can query version information for atomic metrics, business filters, and derived metrics.

Business filters

ListBizCondition

-

Performs a paged query of a list of business filters. If you do not set search conditions, the business filters in the specified project are queried by default.

QueryBizConditionById

-

Gets business filter data.

QueryBizConditionVerDetailById

-

Gets the details of a business filter version.

QueryHomoBizConditionById

-

Gets data for business filters from the same source. Same source means that the business filters originate from the same logical table. A business filter can have three calculation logics with different time granularities, so it may originate from three logical tables with different time granularities.

Metrics

GetLogicalDefinitionSubTree

-

Gets the navigation tree structure of modeling development definition objects. This includes the navigation tree structure for atomic metrics, business filters, and derived metrics.

ListAtomicIndex

-

Performs a paged query of a list of atomic metrics. If you do not set search conditions, all original atomic metrics and composite metrics in the specified project are queried by default.

ListDerivedIndex

-

Performs a paged query of a list of derived metrics. If you do not set search conditions, all derived metrics, composite metrics, and registered metrics in the specified project are queried by default.

QueryAtomicIndexById

-

Gets atomic metric data.

QueryAtomicIndexVerDetailById

-

Gets atomic metric version details.

QueryDerivedIndexById

-

Gets derived metric data.

QueryDerivedIndexVerDetailById

-

Queries derived metric version details.

QueryHomoAtomicIndexById

-

Gets data for atomic metrics from the same source. Same source means that the atomic metrics originate from the same logical table. An atomic metric can have three calculation logics with different time granularities, so it may originate from three logical tables with different time granularities.

Logical tables

GetLogicalModelSubTree

-

Gets the navigation tree structure of logical table objects.

QueryDimTableById

-

Queries the details of a logical dimension table.

QueryFactTableById

-

Queries the details of a logical fact table.

QueryGranularityBySummaryId

-

Queries dimension information related to the statistic granularity of a logical aggregate table.

Offline code nodes

CancelTask

-

Stops a node. This feature is supported from version 3.5.3. This API is idempotent. If the node is already stopped, the call returns a normal response.

CloseJdbcConnection

-

Closes a Java Database Connectivity (JDBC) connection. This feature is supported from version 3.5.3.

CreateBatchTaskFile

CreateBatchTask

Creates an offline computing node.

CreateJdbcConnection

-

Creates a JDBC connection. This feature is supported from version 3.5.3.

DeleteBatchTaskFile

DeleteBatchTask

Deletes an offline computing node. You must take the node offline before deleting it.

ExecSqlByJdbc

-

Executes SQL statements using JDBC. This feature is supported from version 3.5.1.

ExecTask

ExecuteAdHocTask

Executes an ad hoc query node.

FetchSqlResult

-

Gets the results of an SQL execution. This feature is supported from version 3.5.3. After a node runs successfully, you can use this API to query its execution results. If the node has not finished running or has failed, this API returns empty data.

GetBatchTaskFile

GetBatchTaskInfo

Queries the details of an offline computing node.

GetBatchTaskFileByVersion

GetBatchTaskInfoByVersion

Queries the version details of an offline computing node in the development environment. For Basic projects, this is the production environment.

GetLineages

GetBatchTaskUdfLineages

Queries the custom lineage information of a node.

KillTask

StopAdHocTask

Stops an ad hoc query node.

ListBatchTaskFileVersions

GetBatchTaskVersions

Queries the historical versions of an offline computing node.

OfflineBatchTaskFile

OfflineBatchTask

Takes an offline computing node offline.

ParseDependency

ParseBatchTaskDependency

Parses the logical table dependencies of an offline computing node. Note that the upstream dependency information in the parsing result may include self-dependency nodes, where the ancestor node ID is the same as the node ID of the parsed code. You must handle this yourself.

QuerySqlTaskStatus

-

Gets the status of an SQL node. This feature is supported from version 3.5.1.

QueryTaskLog

GetAdHocTaskLog

Gets the run logs of an ad hoc query node.

QueryTaskResult

GetAdHocTaskResult

Gets the run results of an ad hoc query node.

SaveLineages

UpdateBatchTaskUdfLineages

Saves the custom lineage of a node.

SubmitBatchTaskFile

SubmitBatchTaskFileV2

Submits an offline computing node.

SubmitBatchTaskFileV2

SubmitBatchTask

Submits an offline computing task. This operation is an alternative to the SubmitBatchTaskFile operation. The difference between the SubmitBatchTaskFileV2 and SubmitBatchTaskFile operations:

If the task is submitted successfully, the SubmitBatchTaskFileV2 operation also returns the ID of the object to be published.

UpdateBatchTaskFile

UpdateBatchTask

Updates an offline computing node.

Real-time development nodes

GetDirectoryTree

-

Gets the storage folder for real-time nodes.

GetClusterQueueInfoByEnv

-

Gets the resource queue for real-time nodes.

GetQueueEngineVersionByEnv

-

Gets the engine version for real-time nodes.

CreateStreamBatchJobMapping

-

Creates a Flink SQL node.

GetStreamJobs

-

Gets a list of real-time nodes.

Pipelines

PipelineAsyncExeResult

-

Gets the status and result of an asynchronous execution.

FileInfo

-

Gets the information of files stored in a pipeline.

HopCommand

-

Configures a pipeline edge.

NodeRelationInternal

-

Configures a scheduling dependency.

PipelineCommand

-

Configures a pipeline.

PipelineObject

-

Specifies a pipeline object.

PipelineSettings

-

Configures a node channel.

PipelineTreeNodeBriefDTO

-

Brief information about the pipeline directory tree.

QueryPipelineDirectoryTreeCommand

-

Queries a pipeline directory tree.

ScheduleCommand

-

Configures pipeline scheduling.

StepCommand

-

Configures a pipeline step.

AsyncCreatePipeline

-

Asynchronously creates a pipeline with one click.

CreatePipeline

-

Creates a pipeline node.

CreatePipelineNode

-

Creates a real-time integration node. This includes only basic node information.

GetAsyncExeResult

-

Queries the status and result of an asynchronous execution.

GetPipeline

-

Queries the details of a pipeline node.

GetPipelineByVersion

-

Views the pipeline version details in the development environment. For Basic projects, this is the production environment.

ListAsyncExeResult

-

Performs a batch query of the status and results of asynchronous executions.

ListPipeline

-

Performs a batch query of pipeline nodes.

ListPipelineDirectoryTree

-

Performs a batch query of integration directory lists.

OfflineAndDeletePipeline

-

Takes a pipeline offline and deletes it. A deleted pipeline cannot be recovered.

OfflinePipeline

-

Takes a pipeline node offline.

SubmitPipeline

-

Submits a pipeline node.

UpdatePipeline

-

Updates a pipeline node.

Components (interfaces)

ADB for MySQl 2.0

-

Output widget.

ADB for MySQl 3.0

-

Input and output widgets.

ADB for PostgreSQL

-

Input and output widgets.

Column

-

Use the built-in Builder to construct this.

ColumnCalculation

-

Field calculation widget.

ColumnFilter

-

Filter widget.

ColumnMapping

-

Use the built-in Builder to construct this.

ColumnSelection

-

Field selection widget.

ConditedDistribution

-

Conditional distribution widget.

IBM DB2

-

Input and output widgets.

HBase

-

Input and output widgets.

Hive

-

Input and output widgets.

LogicTable

-

Logical table input widget.

MaxCompute

-

Input and output widgets.

MySQL

-

Input and output widgets.

OSS

-

Input and output widgets.

OceanBase

-

Input and output widgets.

Oracle

-

Input and output widgets.

PolarDB

-

Input and output widgets.

PolarDB-X (formerly DRDS)

-

Input and output widgets.

PostgreSQL

-

Input and output widgets.

SpeedLimit

-

Throttling widget.

SQL Server

-

Input and output widgets.

Tera Data

-

Input and output widgets.

Vertica

-

Input and output widgets.

Publish

GetLatestSubmitDetail

GetLatestSubmitDetail

Gets the details of the latest record to be published. This gets the details for a specific node record to be published from data processing, pipeline objects, or asset separation.

ListObjectsToPublish

ListSubmitRecords

Lists records to be published. This includes records for data processing, pipeline objects, and asset separation nodes.

ListPublishingHistory

ListPublishRecords

Lists publish records. This includes publish records for data processing, pipeline objects, and asset separation nodes.

PublishObject

PublishObjectList

Publishes objects. This is the publish API for data processing, pipeline objects, and asset separation nodes. Get the ID of the object to be published from the ListObjectsToPublish (list of records to be published) API.

Resources

CreateResource

-

Creates a resource.

DeleteResource

-

Deletes a resource.

GetGlobalResourceStorageCredential

GetFileStorageCredential

Gets the storage configuration for uploading resource files.

GetResource

-

Gets resource details.

GetResourceByVersion

-

Queries the resource version details in the development environment. For Basic projects, this is the production environment.

GetResourceStorageCredential

GetFileStorageCredential

Gets the storage configuration for uploading resource files. This is used to call the OSS software development kit (SDK) to upload files.

UpdateResource

-

Updates a resource.

Functions

CreateUdf

-

Creates a user-defined function.

DeleteUdf

-

Deletes a user-defined function.

GetUdf

-

Queries the details of a user-defined function.

GetUdfByVersion

-

Queries the version details of a user-defined function.

UpdateUdf

-

Updates a user-defined function.

API (old interface)

API (new interface)

API description

BindGroupToApp

-

Attaches an audience group to an application.

CreateGroupByImport

-

Imports an audience group.

CreateGroupPageQuery

-

Creates a paged query for an audience group.

DeleteGroup

-

Deletes an audience group.

DeleteGroupPage

-

Deletes the audience group paging service.

DeleteGroupVersion

-

Deletes an audience group version.

EditGroupPageQuery

-

Edits a paged query for an audience group.

GetComputeSourceFileStorageCredentials

-

Obtains an upload credential for a compute source configuration file. You can use the credential to upload the configuration file.

GetGroupPageApiCode

-

Gets the service invocation code for an audience group paged query.

GetOnlineClusterById

-

Gets audience group details based on the audience group ID.

GetOnlineFeatureById

-

Gets tag details based on the tag ID.

ListOnlineFeatures

-

Gets a list of published tags.

ListApplyFeaturesInProject

-

Gets a list of tags that have been requested in the current project.

ListApps

-

Gets a list of applications. (Added in V3.14.1)

ListFeaturesInProject

-

Gets a list of tags developed in the current project.

ListGroupPageSubscription

-

Gets a list of published paged query services for audience groups.

ListGroupsInApp

-

Queries the list of requested audience groups in an application. (Added in V3.14.1)

ListOnlineClusters

-

Gets a list of published audience groups.

ListTagsInApp

-

Queries the list of requested tags in an application. (Added in V3.14.1)

ListingGroup

-

Lists an audience group in the marketplace.

OfflineGroup

-

Takes an audience group offline.

OfflineGroupPage

-

Takes a paged service for an audience group offline.

OnlineGroupPageQuery

-

Publishes a paged query for an audience group.

PublishAndOnlineGroup

-

Publishes and lists an audience group version.

PublishGroup

-

Publishes an audience group version.

QueryGroupStatus

-

Gets the status of an audience group.

QueryGroupVersionStatus

-

Gets the status of an audience group version.

QuerySubscriptionStatus

-

Gets the status of an offline service for an audience group.

RevokeGroup

-

Revokes an audience group.

SaveGroup

-

Creates an audience group for the first time.

SaveGroupVersion

-

Creates an audience group version.

SubmitGroupVersion

-

Submits an audience group version.

SupplementGroupData

-

Performs a data backfill for an audience group.

SupplementGroupPageData

-

Performs a data backfill for the paged query service of an audience group.

UnlistingGroup

-

Delists an audience group. This operation does not require approval.

API (old interface)

API (new interface)

API description

Metadata

GetTableColumnLineage

-

Queries field lineage information.

GetTableLineage

-

Queries table lineage information.

GetTableLineageByTaskId

GetTableLineageByTaskId

Queries the related table lineage based on the node ID.

GetTableColumnLineageByTaskId

GetTableColumnLineageByTaskId

Queries the field lineage related to the node ID.

ListCatalogTableColumns

-

Queries the columns of an asset table.

ListLogicTableColumns

-

Queries the columns of a logical table.

ListRealtimeTableColumns

-

Queries the columns of a streaming table.

ListTableColumns

-

Queries the columns of a physical table.

ListTablePartitions

-

Queries physical partition data.

ListTables

-

Queries table metadata.

QueryLogicTable

-

Queries logical table details.

QueryRealtimeTable

-

Queries the details of a streaming table.

QueryTable

-

Provides an API to query physical tables.

QueryTableLineage

-

[Deprecated] Queries field lineage relationships. Streaming tables are not supported.

Use the new GetTableColumnLineage API instead.

RegisterAssetMetaData

-

Registers metadata for a new asset type.

ReportAsset

-

Reports an asset to Dataphin.

SearchCatalogTable

-

Deprecated. Queries asset table metadata. Use the new SearchCatalogTableV2 API.

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 mapping relations, including valid and invalid mappings.

CreateStandard

-

Creates a data standard.

CreateStandardRelations

-

Creates data standard association relationships.

CreateStandardSet

-

Creates a data standard set.

CreateStandardTemplate

-

Creates a data standard template.

CreateWordRoot

-

Creates a root.

DeleteLookupTable

-

Deletes a lookup table.

DeleteStandardRelations

-

Deletes data standard association relationships.

DeleteStandardSet

-

Deletes a data standard set.

DeleteWordRoot

-

Deletes a root.

FuzzySearchStandard

-

Performs a paged query for data standards that meet the specified query conditions.

DeleteStandard

-

Deletes a data standard.

GetStandardStatisticsOfType

-

Queries the number of data standards in a folder, counted by standard type.

QueryLookupTable

-

Queries a lookup table.

QueryMappingRelationByAsset

-

Queries mapping relations based on an asset object.

QueryMappingRelationByBelongAsset

-

Queries mapping relations based on the owning asset.

QueryStandard

-

Queries a data standard of a specified version and status based on the standard ID.

QueryStandardSet

-

Queries a data standard set based on the standard set ID.

QueryStandardTemplate

-

Queries a data standard template based on the standard template ID.

QueryWordRoot

-

Queries a root.

SubmitStandard

-

Publishes a data standard.

UnpublishStandard

-

Takes a published data standard offline.

UpdateLookupTable

-

Updates a lookup table.

UpdateStandard

-

Updates a data standard.

UpdateStandardSet

-

Updates a data standard set.

UpdateStandardTemplate

-

Updates a data standard template.

UpdateWordRoot

-

Updates a root.

Data Quality

AssignQualityRuleSchedules

-

Attaches rules to schedule settings.

GetQualityAlert

-

Gets alert settings by monitored object ID.

GetQualityRule

-

Gets a quality rule object by ID.

GetQualityRuleTask

-

Gets a quality task object by ID.

GetQualityRuleTaskLog

-

Gets the log content of a quality task object by ID.

GetQualitySchedule

-

Gets a quality schedule object by ID.

GetQualityTemplate

-

Gets a quality template object by ID.

GetQualityWatch

-

Gets a quality monitored object by ID.

GetQualityWatchByObjectId

-

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

GetQualityWatchTask

-

Gets a monitoring task object by ID.

GetQualityWatchTaskLog

-

Gets the log content of a monitoring task object by ID.

ListQualitySchedules

-

Gets a list of schedule settings by monitored object ID.

OpenCloseQualityRules

-

Enables or disables quality rules in batches.

OpenCloseQualityWatches

-

Enables or disables quality monitored objects in batches.

PagedQueryQualityRuleTasks

-

Performs a paged query of quality rule tasks.

PagedQueryQualityRules

-

Performs a paged query of quality rules.

PagedQueryQualityTemplates

-

Performs a paged query of quality templates.

PagedQueryQualityWatchTasks

-

Performs a paged query of quality monitoring object tasks.

PagedQueryQualityWatches

-

Performs a paged query of quality monitored objects.

RemoveQualityRuleSchedules

-

Deletes the binding relationships between quality rules and schedules in batches.

RemoveQualityRules

-

Deletes quality rule objects in batches.

RemoveQualitySchedules

-

Deletes quality schedule objects in batches.

RemoveQualityTemplates

-

Deletes quality template objects in batches.

RemoveQualityWatches

-

Deletes quality monitored objects in batches.

SaveQualityAlert

-

Creates or modifies alert settings for a monitored object.

SaveQualityRule

-

Creates or modifies a quality rule.

SaveQualitySchedule

-

Creates or modifies schedule settings.

SaveQualityTemplate

-

Creates or modifies a quality template.

SaveQualityWatch

-

Adds a quality monitored object. You can add multiple types of quality monitored objects, including Dataphin tables, global tables, data sources, metrics, and streaming tables.

SubmitQualityRuleTasks

-

Submits rule tasks in batches. Trial runs are supported.

SubmitQualityWatchTasks

-

Submits verification tasks for monitored objects in batches.

Data security

AddSecurityLabel

-

Creates a security detection result. You can select an overwrite mode or modify an online security detection result.

CreateClassifyCatalog

-

Creates a data classification folder. A role with the Data Classification - Management permission can create any folder. An administrator of a level-1 folder can create folders only under that level-1 folder.

CreateSecurityClassify

-

Creates a security classification.

CreateSecurityLevel

-

Creates a security level.

GetSecretKeyByName

-

Queries key details based on the key name.

GetSecurityClassifyDetail

-

Queries data classification details based on the classification ID.

GetSecurityLabelById

-

Gets a detection result object by its ID.

GetSecurityLevelDetail

-

Queries data security level details based on the level ID.

PagedQuerySecurityIdentifyRecordsOfField

-

Performs a paged query of the detection details of security detection results.

PagedQuerySecurityLabels

-

Performs a paged query of security detection results.

RemoveClassifyCatalog

-

Deletes a data classification folder. A custom role with the Data Classification - Management permission can delete any folder. An administrator of a level-1 folder can delete only that level-1 folder and its subdirectories.

RemoveSecurityClassify

-

Deletes a security classification.

RemoveSecurityLabels

-

Deletes security detection results in batches.

RemoveSecurityLevel

-

Deletes a security level.

UpdateClassifyCatalog

-

Updates a data classification folder. A custom role with the Data Classification - Management permission can modify any folder. An administrator of a level-1 folder can modify only that level-1 folder and its subdirectories. For move operations, the operator must have administrator permissions for both the source and target level-1 folders.

UpdateSecurityClassify

-

Updates a security classification.

UpdateSecurityLabelsEnableStatus

-

Updates the active status of security detection results in batches.

UpdateSecurityLabelsIdentifyRule

-

Updates the detection rules attached to security detection results in batches.

UpdateSecurityLevel

-

Updates a security level.

DataService Studio

CreateDataServiceApi

-

Creates and submits a new DataService Studio API.

PublishDataServiceApi

-

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

ListApiByApp

-

Queries a list of authorized API details in an application.

QueryApiDocument

GetDataServiceApiDocument

Gets API documentation.

QueryApiLogPage

ListDataServiceApiCalls

Performs a log query for API calls in Service Monitoring.

QueryApiServiceGroup

GetDataServiceApiGroups

Queries a list of API service groups.

QueryApiServicePage

ListDataServicePublishedApis

Performs a paged query of a list of published APIs.

QueryErrorImpact

GetDataServiceApiErrorImpactSummary

Analyzes the impact of API errors.

QueryIndicators

GetDataServiceApiCallSummary

Gets summary statistics for Service Monitoring calls.

QueryVisitTrend

GetDataServiceApiCallTrend

Analyzes access trends in Service Monitoring.

ApplyApi

ApplyDataServiceApiPermission

Requests API permissions.

QueryApiAuthPage

ListDataServiceAuthorizedApis (can be replaced by the existing ListAuthorizedDataServiceApiDetails API)

Queries a list of APIs that the current user has permission to access.

QueryApiGroup

GetDataServiceAuthorizedApiGroups

Queries a list of API groups for the current project.

QueryGroupApi

-

Queries a list of APIs in a group.

QueryPrivateApp

GetDataServiceAuthorizedAppsByGroupId

Queries a list of applications that the account has permission to access.

ApplyApp

ApplyDataServiceAppPermission

Requests application permissions.

QueryAppAuthPage

ListDataServiceAuthorizedApps

Queries a list of applications that the current user has permission to access.

QueryAppGroup

GetDataServiceAuthorizedAppGroups

Queries a list of application groups for the current project.

QueryGroupApp

GetDataServiceAppsByGroupId

Queries a list of applications in a group.

ApplyDataSource

-

Requests permissions for a Dataphin data source.

QueryDataSourceAppGroup

-

Queries a list of Dataphin data source groups.

QueryDataSourceAuthPage

-

Queries a paginated list of Dataphin data sources for which permissions have been requested, based on the project.

QueryDataSourceGroup

-

Queries the groups of the current tenant project.

QueryGroupDataSource

-

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

QueryLogicalTable

-

Queries the logical tables in a specified Dataphin data source.

QueryPhysicalTable

-

Queries the physical tables in a specified Dataphin data source.

QueryTableColumn

-

Queries the table fields 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 application owners.

ListAppAuthUser

GetDataServiceAppAuthorizedUsers

Lists users with application permissions.

QueryMyAppPage

ListDataServiceMyAppPermissions

Queries the applications for which you have permissions.

RecycleApp

RevokeDataServiceAppPermission

Revokes application permissions.

AuthorizeDataSource

-

Requests application authorization for a Dataphin data source.

QueryMyDataSourcePage

-

Queries a list of data sources for which I have permissions.

RecycleDataSource

-

Revokes permissions for a Dataphin data source.

ListAuthorizedDataServiceApiDetails

-

Lists information about authorized DataService Studio APIs.

ListManagerProject

GetDataServiceMyProjects

Provides a drop-down list of projects for which the current user is the owner.

ListDataphinDsPermissions

-

Checks whether the tenant of the current account has DataService Studio (Dataphin) permissions.

QueryDataSourceDocument

-

Queries data source details based on the data source ID (Dataphin data source document).

QueryDataSourceServicePage

-

Queries a paginated list of Dataphin data sources.

QueryApiImpactDetail

ListDataServiceApiImpacts

Lists API impact analysis results.

QueryApiMonitor

ListDataServiceApiMaintanceStatistics

Queries API O&M statistics.

CreateProjectUser

AddDataServiceProjectMember

Adds a project user and sets a role.

ListDataphinUser

GetDataServiceProjectMembers

Queries the user list of the current tenant project.

ListPrivilegedProject

GetDataServiceAuthorizedProjects

Queries a list of projects with permissions.

QueryProjectPage

ListDataServiceProjects

Performs a paged query of projects.

QueryProjectUserPage

-

Performs a paged query of a list of project members.

pageInfo

-

None.

ParseSql

ParseDataServiceSql

Translate SQL

SqlLegalityVerify

CheckDataServiceSqlLegality

Verifies and authenticates SQL.

API (old interface)

API (new interface)

API description

Purchased features

ListFeatures

-

Gets a list of features available to the current tenant.

Project management

AddProjectMembers

AddProjectMember

Adds project members. You can add members to Basic and DEV-PROD projects.

DeleteProjectMembers

DeleteProjectMember

Deletes project members. You can delete members from Basic and DEV-PROD projects.

GetProject

-

Gets project information based on the project ID and environment context.

GetProjectByName

-

Obtains project information based on the project name. When you query a project in the development environment, you must add the _dev suffix to the project name.

ListProjectByProjectType

-

Filters projects by project type.

ListProjectMembers

-

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

ListProjects

-

Filters projects by project type.

QueryProjectWhiteList

GetProjectWhiteLists

Queries the project whitelist based on the project ID.

UpdateProjectMembers

UpdateProjectMember

Updates project members. You can update members of 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. This API supports three modes: create a production data source only, create both development and production data sources, or create a development data source for an existing production data source.

DeleteDevProdModeDataSource

-

Deletes a data source. You can delete only the data source in the development environment, or delete both the development and production data sources. Dataphin does not allow a development data source to exist independently.

ListDataSourceDependency

GetDataSourceDependencies

Searches for data source dependencies. The API returns the result as a list.

SearchDataSourceConfig

-

Searches for data sources. The results are returned in pages. The data source structure is a development-production pair.

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

-

New API in V5.1. Gets a list of row-level permissions.

GetAccountByRowPermissionId

-

New API in V5.1. Gets all authorized accounts for a specific row-level permission based on the row-level permission ID.

ListAccountByRowPermissionId

-

Gets a list of accounts based on the row-level permission ID.

CreateRowPermission

-

New API in V5.1. Creates a row-level permission.

DeleteRowPermission

-

New API in V5.1. Deletes a row-level permission based on its ID.

UpdateRowPermissionBasicInfo

-

Updates the basic information of a row-level permission.

AddControlRule

-

Adds a control rule for row-level permissions.

UpdateControlRule

-

Updates a control rule for row-level permissions.

DeleteControlRule

-

Deletes a control rule for row-level permissions.

AddAssociatedTable

-

Adds row-level permission information for related tables.

DeleteAssociatedTable

-

Deletes row-level permission information for related tables.

ListRowPermissionByUserId

-

New API in V5.1. Gets a list of row-level permissions for a user.

UpdateRowPermission

-

New API in V5.1. Updates row-level permissions.

Compute source

CheckComputeSourceConnectivity

-

Checks the connectivity of a compute source configuration.

CheckComputeSourceConnectivityById

-

Checks project connectivity based on the project ID.

CreateComputeSource

-

Creates a compute source.

DeleteComputeSource

-

Deletes a compute source.

GetComputeSource

GetComputeSourceInfo

Gets compute source information based on the compute source ID.

GetComputeSourceFileCredentials

GetFileStorageCredential

Obtains an upload credential for a compute source configuration file. You can use the credential to upload the configuration file.

QueryComputeSource

ListComputeSources

Performs a batch query of compute sources.

SetTenantComputeEngine

UpdateTenantComputeEngine

Sets the tenant compute engine.

UpdateComputeSource

-

Updates a compute source.

Users and authorization

AddUser

-

Adds a user to a tenant.

BatchAddTenantMember

-

Adds users to a tenant in batches.

BatchGetUsers

-

Obtains user information in batches based on UserId.

BatchSyncUsers

-

Synchronizes tenant member information.

CheckResourcePermission

-

Checks whether a personal account or a tenant account has permission to operate on a specific resource.

CreateUserGroup

-

Creates a user group.

DeleteUserGroup

-

Deletes a user group.

GetDataSourceUserList

-

Queries users who have permissions for a data source based on the data source ID.

GetOpsTenant

-

Gets O&M tenant information.

GetPermissionChangeObjects

-

Gets the details of permission change objects.

GetProjectProduceUser

-

Gets the tenant account for a project.

GetRoleListByUserId

-

Gets a list of roles that a user has.

GetUserGroup

-

Gets user group details.

GetUserInfoBySourceId

-

Queries the corresponding Dataphin user information based on an external account ID.

GrantByResource

-

Grants permissions to a user based on a resource.

GrantPermissionToDataSource

-

Grants multiple permissions for a data source to multiple users. We recommend that you use the new GrantByResource API.

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 of a specific product.

ListAddableRoles

-

Configurable user roles for members (Management Center > Member Management).

ListAssetPermissionAudit

-

Gets a paginated list of permission operation audit information.

ListPermissionChangeLog

-

Gets permission change records using a cursor.

ListPermissionOperationAudit

-

Gets a paginated list of permission operation audit information.

ListDepts

-

Lists tenant departments.

ListUserGroup

-

Gets user group information in a paginated list.

ListUserGroupMember

-

Gets user group member information in a paginated list.

ListUsers

-

Gets user information in a paginated list.

MineTenants

-

Lists my tenant information.

QueryPagedAddableUsers

-

Queries users that can be added to a tenant.

QueryPagedDept

-

Performs a paged query of level-1 department information.

QueryPagedMembers

-

Performs a paged query of a member list.

RemoveUser

-

Deletes a user from a tenant.

RevokeByResource

-

Revokes user permissions based on a resource.

RevokePermissionFromDataSource

-

Removes user permissions from a data source. We recommend that you use the new RevokeByResource API.

UpdateTenantMemberStatus

-

Updates the enabled or disabled status of a tenant member.

UpdateTenantMembers

-

Updates tenant member information.

UpdateUserGroup

-

Updates user group member list information.

UpdateUserGroupSwitch

-

Modifies the enabled 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

-

Gets tenant-level roles based on a user ID.

ListTenantRoles

-

Gets tenant-level roles.

Python third-party packages

ListPythonModule

-

Performs a paged query of Python third-party packages.