API standards and multilingual preset SDKs
The OpenAPI of this product (dataworks-public/2020-05-18) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Tenant
|
API |
Title |
Description |
| AddProjectMemberToRole | AddProjectMemberToRole | Assigns a role to a member of a DataWorks workspace. Before you call this operation, you must add your account to a DataWorks workspace as a member. |
| RemoveProjectMemberFromRole | RemoveProjectMemberFromRole | Removes a role from a user in a DataWorks workspace. |
| ListProjectIds | ListProjectIds | Queries the IDs of the workspaces on which a specific Alibaba Cloud account or RAM user has permissions in a specific region. |
| ChangeResourceManagerResourceGroup | ChangeResourceManagerResourceGroup | Changes the resource group of a resource. |
| ListMeasureData | ListMeasureData | Queries the statistics on the number of phone call-based alerts or text message-based alerts reported within the tenant to which your account belongs during the previous 30 days. |
Metadata
|
API |
Title |
Description |
| GetMetaDBInfo | GetMetaDBInfo | Queries the basic metadata information about a compute engine instance. |
| GetMetaDBTableList | GetMetaDBTableList | Retrieves all tables in the specified Engine Instance. |
| CheckMetaTable | CheckMetaTable | Checks whether a metatable exists. |
| CheckMetaPartition | CheckMetaPartition | Checks whether a partition in a MaxCompute metatable exists. |
| SearchMetaTables | SearchMetaTables | Queries metatables based on specific conditions. |
| GetMetaTableBasicInfo | GetMetaTableBasicInfo | Queries the basic information about a metatable. |
| GetMetaTableColumn | GetMetaTableColumn | Queries the field information of a metatable. |
| GetMetaTablePartition | GetMetaTablePartition | Retrieves a list of partitions for a table. |
| GetMetaTableOutput | GetMetaTableOutput | Queries the output information of a metatable. |
| GetMetaTableChangeLog | GetMetaTableChangeLog | Queries the change logs of a metatable. |
| GetMetaTableIntroWiki | GetMetaTableIntroWiki | Queries the instructions on how to use a table. |
| CreateMetaCategory | CreateMetaCategory | Creates a category. |
| DeleteMetaCategory | DeleteMetaCategory | Deletes a category. |
| UpdateMetaCategory | UpdateMetaCategory | Updates a category. |
| GetMetaCategory | GetMetaCategory | Queries the information about a category tree. |
| GetMetaTableListByCategory | GetMetaTableListByCategory | Queries metatables in a specified category. |
| AddToMetaCategory | AddToMetaCategory | Adds a metatable to a specified category. |
| DeleteFromMetaCategory | DeleteFromMetaCategory | Removes a table from a specified category. |
| UpdateMetaTable | UpdateMetaTable | This operation updates the metadata of a table. |
| UpdateMetaTableIntroWiki | UpdateMetaTableIntroWiki | Updates the instructions on how to use a table. If no instruction on how to use the table is available, the instructions that are configured by calling this operation are added. |
| ListMetaDB | ListMetaDB | Queries a list of metadatabases. |
| UpdateTableModelInfo | UpdateTableModelInfo | Modifies the information about a table, such as the table folder, level, and category. |
| CreateTableTheme | CreateTableTheme | Creates a table theme. This operation will be replaced soon. We recommend that you do not call this operation. |
| DeleteTableTheme | DeleteTableTheme | Deletes a table theme. This operation will be replaced soon. We recommend that you do not call this operation. |
| UpdateTableTheme | UpdateTableTheme | Updates a table theme. This operation will be replaced soon. We recommend that you do not call this operation. |
| ListTableTheme | ListTableTheme | Lists table themes. This operation will be replaced soon. We recommend that you do not call this operation. |
| GetMetaTableThemeLevel | GetMetaTableThemeLevel | Fetches topics and hierarchy metadata for tables |
| CreateTableLevel | CreateTableLevel | Creates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation. |
| UpdateTableLevel | UpdateTableLevel | Updates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation. |
| DeleteTableLevel | DeleteTableLevel | Deletes a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation. |
| ListTableLevel | ListTableLevel | Lists hierarchy levels. This operation will be replaced soon. We recommend that you do not call this operation. |
| GetMetaCollectionDetail | GetMetaCollectionDetail | Queries the information about a collection. |
| RegisterLineageRelation | RegisterLineageRelation | Registers the lineage between self-managed entities to DataWorks. |
Data integration
|
API |
Title |
Description |
| CreateDISyncTask | CreateDISyncTask | Creates a data synchronization task. |
| DeleteDISyncTask | DeleteDISyncTask | Deletes a real-time synchronization task. |
| UpdateDISyncTask | UpdateDISyncTask | Updates a data synchronization task. |
| TestNetworkConnection | TestNetworkConnection | Tests the network connectivity between a data source and a resource group. |
| GetDISyncTask | GetDISyncTask | Retrieves the details of a synchronization task or a data synchronization solution. |
| DeployDISyncTask | DeployDISyncTask | Deploys a real-time synchronization task. |
| GetDISyncInstanceInfo | GetDISyncInstanceInfo | Queries the status of a real-time synchronization task or a data synchronization solution. |
| GenerateDISyncTaskConfigForUpdating | GenerateDISyncTaskConfigForUpdating | Generates the configuration for updating a real-time synchronization task in Data Integration. |
| QueryDISyncTaskConfigProcessResult | QueryDISyncTaskConfigProcessResult | Queries the result of an asynchronous task for generating synchronization task configurations. |
| GetDIAlarmRule | GetDIAlarmRule | Retrieves the details of an alert rule configured for a synchronization task. |
Data modeling
|
API |
Title |
Description |
| QueryPublicModelEngine | QueryPublicModelEngine | Retrieves information about Data Modeling objects created by using fast modeling language (FML) statements. |
Operations center
|
API |
Title |
Description |
| GetAlertMessage | GetAlertMessage | Queries alert information based on the alert ID that is specified by the AlertId parameter. |
| ListAlertMessages | ListAlertMessages | Queries a list of alerts. |
| GetBaselineConfig | GetBaselineConfig | Queries the configurations of a baseline. |
| ListNodesByBaseline | ListNodesByBaseline | Queries nodes in a baseline. |
| ListBaselineConfigs | ListBaselineConfigs | Queries a list of baselines. |
| GetBaselineKeyPath | GetBaselineKeyPath | The information about the events that are associated with the instance. |
| GetBaselineStatus | GetBaselineStatus | Retrieves the status of a baseline instance. |
| ListBaselineStatuses | ListBaselineStatuses | Queries a list of baseline instances. |
| DeleteRemind | DeleteRemind | Deletes a custom monitoring alert rule. |
| CreateRemind | CreateRemind | Creates a custom alert rule. |
| GetRemind | GetRemind | Queries the information about a custom alert rule. |
| ListReminds | ListReminds | Queries a list of custom alert rules. |
| GetTopicInfluence | GetTopicInfluence | Queries baseline instances affected by an event. |
| ListNodeInputOrOutput | ListNodeInputOrOutput | Queries the input and output information about a node. Only the ancestor or descendant nodes at the nearest level can be queried each time. |
| SuspendInstance | SuspendInstance | Suspends an instance. |
| TopTenElapsedTimeInstance | TopTenElapsedTimeInstance | Queries the ranking of the running durations of instances. |
| TopTenErrorTimesInstance | TopTenErrorTimesInstance | Queries the ranking of nodes on which errors occur within the previous month. |
| GetInstanceStatusStatistic | GetInstanceStatusStatistic | Queries the number of instances that are in each state. |
| RunManualDagNodes | RunManualDagNodes | Runs nodes in a manually triggered workflow. Before you call this operation, make sure that the manually triggered workflow is committed and deployed. You can find a manually triggered workflow in Operation Center only after the manually triggered workflow is committed and deployed. |
| GetDag | GetDag | Queries the information about a directed acyclic graph (DAG). You can call the GetDag operation to query the information about the DAG for a manually triggered workflow, a manually triggered node, or a data backfill instance. However, you cannot query the information about the DAG for an auto triggered node or an auto triggered workflow. |
| ListDags | ListDags | Retrieves a list of directed acyclic graphs (DAGs) for a data backfill instance by operation sequence number (OpSeq). |
| ListNodesByOutput | ListNodesByOutput | Queries nodes based on the output of the nodes. |
| GetNodeParents | GetNodeParents | Queries a list of ancestor nodes of a node. |
| GetNodeChildren | GetNodeChildren | Queries a list of instances. |
| UpdateWorkbenchEventResult | UpdateWorkbenchEventResult | Returns the processing result sent by an extension after a process in Operation Center is blocked by the extension. |
| ListShiftPersonnels | ListShiftPersonnels | Queries a list of on-duty engineers in a shift schedule. |
| ListShiftSchedules | ListShiftSchedules | Queries a list of shift schedules in Operation Center. |
| ListInstanceHistory | ListInstanceHistory | Retrieves the run history of an instance. Each rerun generates a new historical record. |
| ListInnerNodes | ListInnerNodes | Retrieves a list of inner nodes within a node group or do-while node. This operation does not support querying the inner nodes of a PAI node. |
| GetBaseline | GetBaseline | Queries the information about a baseline based on its ID. |
| ListBaselines | ListBaselines | Obtains a list of baselines. |
| CreateBaseline | CreateBaseline | Creates a baseline. |
| UpdateBaseline | UpdateBaseline | Updates a baseline. |
Data quality
|
API |
Title |
Description |
| UpdateQualityFollower | UpdateQualityFollower | Updates a subscription. |
| UpdateQualityRule | UpdateQualityRule | Updates a specified quality rule. |
| DeleteQualityFollower | DeleteQualityFollower | Deletes a Follower from a partition expression. |
| GetQualityFollower | GetQualityFollower | Retrieves the followers of a Partition Expression. |
| CreateQualityFollower | CreateQualityFollower | Adds a follower to a partition expression to receive data quality alerts. |
| DeleteQualityEntity | DeleteQualityEntity | Deletes a partition expression. |
| GetQualityEntity | GetQualityEntity | Call `GetQualityEntity` to retrieve the partition expression. |
| CreateQualityEntity | CreateQualityEntity | Creates a partition expression for data quality. |
| CreateQualityRelativeNode | CreateQualityRelativeNode | Creates a Partition Expression Association. |
| DeleteQualityRelativeNode | DeleteQualityRelativeNode | DeleteQualityRelativeNode deletes a scheduling association. |
| ListQualityResultsByEntity | ListQualityResultsByEntity | Use `ListQualityResultsByEntity` to retrieve validation results based on a partition expression. |
| ListQualityResultsByRule | ListQualityResultsByRule | Validates the quality of a Data Source against Validation Rules and returns the Validation Results. |
Data service
|
API |
Title |
Description |
| GetDataServiceApi | GetDataServiceApi | Retrieves the details of a DataService Studio API in the development state. |
| UpdateDataServiceApi | UpdateDataServiceApi | Updates the information about an API in the development state in DataService Studio. |
| GetDataServicePublishedApi | GetDataServicePublishedApi | Retrieves the details of a published DataService Studio API. |
| ListDataServiceApiAuthorities | ListDataServiceApiAuthorities | Retrieves a list of APIs on which other users are granted access permissions. |
| ListDataServiceAuthorizedApis | ListDataServiceAuthorizedApis | Retrieves a list of APIs that you are authorized to access. |
| GetDataServiceApplication | GetDataServiceApplication | Retrieves the details of an application. |
| ListDataServiceApplications | ListDataServiceApplications | Retrieves a list of applications. |
| ListDataServiceFolders | ListDataServiceFolders | Retrieves a list of folders. |
| CreateDataServiceGroup | CreateDataServiceGroup | Creates a business process. |
| GetDataServiceGroup | GetDataServiceGroup | Retrieves the details of a business process. |
| ListDataServiceGroups | ListDataServiceGroups | Retrieves a list of business processes. |
Data protection
|
API |
Title |
Description |
| DsgUpdateDesensStatusList | Update the status of data masking switches | Update the status of data masking switches |
| DsgQueryDesensStatusList | Query data masking switch | Query data masking switch status |
| GetSensitiveData | GetSensitiveData | Queries the latest sensitive data in all the DataWorks workspaces of a tenant. |
| DsgQuerySensResult | DsgQuerySensResult | Retrieve sensitive data identification results from Data Security Guard. |
| QueryRecognizeRuleDetail | QueryRecognizeRuleDetail | Retrieves the details of a specified sensitive field in Data Security Guard. |
| DsgDesensPlanAddOrUpdate | DsgDesensPlanAddOrUpdate | Call the `DsgDesensPlanAddOrUpdate` API to create or edit a data desensitization rule. |
| DsgSceneQuerySceneListByName | DsgSceneQuerySceneListByName | Call the `DsgSceneQuerySceneListByName` API to retrieve a list of data masking scenarios. |
| DsgUserGroupAddOrUpdate | DsgUserGroupAddOrUpdate | Creates or updates a user group in Data Security Guard. |
| DsgUserGroupQueryList | DsgUserGroupQueryList | Call `DsgUserGroupQueryList` to query user groups in Data Security Guard (DSG). |
| DsgDesensPlanQueryList | DsgDesensPlanQueryList | Call the `DsgDesensPlanQueryList` API to query Data Security Guard's (DSG) data masking rules. |
| DsgQueryDefaultTemplates | DsgQueryDefaultTemplates | Retrieves available Sensitive Data Type Templates and the Desensitization Rules they support. Use the response from this API to configure your Desensitization Rules. |
Migration assistant
|
API |
Title |
Description |
| CreatePermissionApplyOrder | Create a permission request order | Creates a permission request order. Note: The 2020 edition of OpenAPI will be deprecated soon. Migrate to the 2024 edition of OpenAPI as soon as possible — ApplyResourceAccessPermission. |
| GetPermissionApplyOrderDetail | Query the details of a permission request order | Queries the details of a permission request order. Note: The 2020 version of OpenAPI will be discontinued. Please migrate to the 2024 version of OpenAPI as soon as possible — GetApplicationContents/GetProcessInstance. |
| ListPermissionApplyOrders | Query the list of permission application orders | Queries a list of permission application orders. Note: The 2020 version of OpenAPI will be discontinued at a scheduled time. Please migrate to the 2024 version of OpenAPI as soon as possible — ListMyApplications/ListPendingApprovals/ListMyRelatedApprovals. |
Security center
|
API |
Title |
Description |
| GetExtension | GetExtension | Retrieves the details of an extension. |
Open platform
|
API |
Title |
Description |
| GetMetaTableFullInfo | GetMetaTableFullInfo | Retrieves complete metadata for a table, including field details. |
| DeleteTable | DeleteTable | Deletes a MaxCompute table. |
| CreateTable | CreateTable | Creates a MaxCompute table. |
| CheckFileDeployment | CheckFileDeployment | Returns the check events for a file that is pending deployment in DataStudio. After a file is committed, DataWorks checks the file and generates events before deployment. Use the returned events to determine whether the file can proceed with deployment validation. |
| UpdateClusterConfigs | UpdateClusterConfigs | Updates the submodule configurations of a cluster in a workspace. Currently, only Spark parameters are supported. |
| AbolishDataServiceApi | AbolishDataServiceApi | Unpublishes a DataService Studio API. |
| AddMetaCollectionEntity | AddMetaCollectionEntity | Adds an entity to a collection. |
| AddRecognizeRule | AddRecognizeRule | Adds a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard. |
| ApprovePermissionApplyOrder | Approve a permission request order | Approves a permission request order. Note: The 2020 edition of OpenAPI will be discontinued. Migrate to the 2024 edition OpenAPI ApproveProcessInstance as soon as possible. |
| CallbackExtension | CallbackExtension | Sends the processing result of an extension point event by an extension to DataWorks. |
| CreateBusiness | CreateBusiness | Creates a workflow in DataStudio. |
| CreateConnection | CreateConnection | Adds a data source. |
| CreateDIAlarmRule | CreateDIAlarmRule | Creates an alert rule for a synchronization task. |
| CreateDIJob | CreateDIJob | Creates a new-version synchronization task. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres and batch synchronization of all data in a MySQL database to Hive. |
| CreateDataServiceApi | CreateDataServiceApi | Creates an API. |
| CreateDataServiceApiAuthority | CreateDataServiceApiAuthority | Grants the access permissions on an API in DataService Studio. |
| CreateDataServiceFolder | CreateDataServiceFolder | Creates a folder in DataService Studio. |
| CreateDataSource | CreateDataSource | Adds a data source to DataWorks. |
| CreateExportMigration | CreateExportMigration | Creates an export task. You can use this operation to create an export task but cannot use this operation to start the created export task. |
| CreateFile | CreateFile | Creates a file in DataStudio. You cannot call this operation to create files for Data Integration nodes. |
| CreateFolder | CreateFolder | The operation that you want to perform. Set the value to \\*\\*CreateFolder\\*\\*. |
| CreateImportMigration | CreateImportMigration | Creates an import task. The import task contains the import packages of data sources, nodes, and tables. |
| CreateMetaCollection | CreateMetaCollection | Creates a collection. |
| CreateProject | CreateProject | Creates a DataWorks workspace. |
| CreateProjectMember | CreateProjectMember | Adds a user to a DataWorks workspace. |
| CreateQualityRule | CreateQualityRule | Call CreateQualityRule to create a Quality Rule. |
| CreateResourceFile | CreateResourceFile | Creates or uploads a resource file in DataStudio. The feature that is implemented by calling this operation is the same as the resource creation feature provided in the integrated development environment (IDE). |
| CreateUdfFile | CreateUdfFile | Creates a file for a function in DataStudio. |
| DeleteBaseline | DeleteBaseline | Deletes a baseline based on its ID. You can delete a baseline only if the nodes in the baseline does not have ancestor nodes. You can call the UpdateBaseline operation to delete the relationships between the nodes and their ancestor nodes. |
| DeleteBusiness | DeleteBusiness | Deletes a workflow. |
| DeleteConnection | DeleteConnection | Removes a data source. |
| DeleteDIAlarmRule | DeleteDIAlarmRule | Deletes an alert rule for a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres. |
| DeleteDIJob | DeleteDIJob | Deletes a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres. |
| DeleteDataServiceApi | DeleteDataServiceApi | Deletes an API in DataService Studio. |
| DeleteDataServiceApiAuthority | DeleteDataServiceApiAuthority | Revokes the access permissions on an API. |
| DeleteDataSource | DeleteDataSource | Removes a data source. |
| DeleteFile | DeleteFile | Deletes a file from DataStudio. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of the DeploymentId parameter returned is used to call the GetDeployment operation to poll the status of the asynchronous process. |
| DeleteFolder | DeleteFolder | Deletes a folder from the Data Development page. |
| DeleteLineageRelation | DeleteLineageRelation | Delete lineage, supports deleting user-defined lineage relationships |
| DeleteMetaCollection | DeleteMetaCollection | Deletes a collection. |
| DeleteMetaCollectionEntity | DeleteMetaCollectionEntity | Deletes an entity from a collection. |
| DeleteProjectMember | DeleteProjectMember | Removes a user from a DataWorks workspace. |
| DeleteQualityRule | DeleteQualityRule | Deletes a data quality rule. |
| DeleteRecognizeRule | DeleteRecognizeRule | Deletes sensitive field types. |
| DeployFile | DeployFile | Deploys a file to the production environment. |
| DesensitizeData | DesensitizeData | Masks data. |
| DsgDesensPlanDelete | DsgDesensPlanDelete | Deletes a data masking rule created in Data Security Guard. |
| DsgDesensPlanUpdateStatus | DsgDesensPlanUpdateStatus | Modifies the status of a data masking rule. |
| DsgPlatformQueryProjectsAndSchemaFromMeta | DsgPlatformQueryProjectsAndSchemaFromMeta | Queries a list of compute engines of different types in the current tenant. |
| DsgRunSensIdentify | DsgRunSensIdentify | Starts a sensitive data identification task in Data Security Guard. |
| DsgSceneAddOrUpdateScene | DsgSceneAddOrUpdateScene | Adds or modifies a level-2 data masking scenario. |
| DsgScenedDeleteScene | DsgScenedDeleteScene | Deletes a level-2 data masking scenario created in Data Security Guard. |
| DsgStopSensIdentify | DsgStopSensIdentify | Stops a sensitive data identification task. |
| DsgUserGroupDelete | DsgUserGroupDelete | Deletes a user group configured in Data Security Guard. |
| DsgUserGroupGetOdpsRoleGroups | DsgUserGroupGetOdpsRoleGroups | Queries a list of MaxCompute roles that can be selected by the members of a user group when the user group is created or modified by the tenant in Data Security Guard. |
| DsgUserGroupQueryUserList | DsgUserGroupQueryUserList | Queries a list of users or roles of the current tenant. |
| DsgWhiteListAddOrUpdate | DsgWhiteListAddOrUpdate | Adds or modifies a data masking whitelist. |
| DsgWhiteListDeleteList | DsgWhiteListDeleteList | Deletes a data masking whitelist configured in Data Security Guard. |
| DsgWhiteListQueryList | DsgWhiteListQueryList | Queries a data masking whitelist. |
| EditRecognizeRule | EditRecognizeRule | Edits a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard. |
| EstablishRelationTableToBusiness | EstablishRelationTableToBusiness | Imports a table to a workflow. The call to this API operation is equivalent to performing the following operations: Go to the DataStudio page, find the desired workflow, and then click the workflow name. Right-click Table under the desired folder and select Import Table. |
| ExportDataSources | ExportDataSources | Exports a list of data sources. |
| GenerateDISyncTaskConfigForCreating | GenerateDISyncTaskConfigForCreating | Generates an ID for an asynchronous thread that is used to create a synchronization task in Data Integration. |
| GetBusiness | GetBusiness | Queries the information about a workflow. |
| GetDDLJobStatus | GetDDLJobStatus | Queries the status of a table creation, update, or deletion task. |
| GetDIJob | GetDIJob | Queries the information about a new-version synchronization task created in Data Integration. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres. |
| GetDataServiceApiTest | GetDataServiceApiTest | Queries the test results of an API in DataService Studio. |
| GetDataServiceFolder | GetDataServiceFolder | Queries a folder. |
| GetDataSourceMeta | GetDataSourceMeta | Queries the metadata of a specified data source. |
| GetDeployment | GetDeployment | Queries the information about a deployment package. |
| GetFile | GetFile | Queries the information about a file. |
| GetFileTypeStatistic | GetFileTypeStatistic | Queries the distribution of node types. |
| GetFileVersion | GetFileVersion | Queries the information about a file version. |
| GetFolder | GetFolder | You can call GetFolder to retrieve the details of a folder. |
| GetIDEEventDetail | GetIDEEventDetail | Queries the data snapshot of an extension point based on the ID of a message in DataWorks OpenEvent when the related extension point event is triggered. |
| GetInstance | GetInstance | Queries the information about an instance. |
| GetInstanceCountTrend | GetInstanceCountTrend | Queries the quantity trend of auto triggered instances. |
| GetInstanceLog | GetInstanceLog | Queries the logs of an instance. |
| GetInstanceStatusCount | GetInstanceStatusCount | Queries the statistics of instances in different states. |
| GetManualDagInstances | GetManualDagInstances | Queries the information about instances in a manually triggered workflow. |
| GetMetaColumnLineage | GetMetaColumnLineage | Queries the lineage of a field in a metatable. |
| GetMetaTableLineage | GetMetaTableLineage | Queries the lineage of a metatable. |
| GetMigrationProcess | GetMigrationProcess | Queries the progress of a migration task. |
| GetMigrationSummary | GetMigrationSummary | Queries the information about a migration task. |
| GetNode | GetNode | Indicates whether the request is successful. |
| GetNodeCode | GetNodeCode | Queries the code of a node. |
| GetNodeTypeListInfo | GetNodeTypeListInfo | Queries the information about node types, including the code and name of a node type. |
| GetOpRiskData | GetOpRiskData | Queries the records that are generated on a specified date for access to the high-risk sensitive data in all the DataWorks workspaces of a tenant. |
| GetOpSensitiveData | GetOpSensitiveData | Queries the records that are generated on a specified date for access to sensitive data in all the DataWorks workspaces of a tenant. |
| GetOptionValueForProject | GetOptionValueForProject | Queries the option settings of an extension in a workspace. |
| GetProject | GetProject | Queries the information about a DataWorks workspace. |
| GetProjectDetail | GetProjectDetail | Queries the information about a DataWorks workspace. |
| GetQualityRule | GetQualityRule | Gets information about a quality rule. |
| GetSuccessInstanceTrend | GetSuccessInstanceTrend | Queries the statistics of instances in different periods of a day. |
| GetTopic | GetTopic | Queries the information about an event. |
| ImportDataSources | ImportDataSources | Imports data sources from your on-premises machine to a specific DataWorks workspace. |
| ListBusiness | ListBusiness | Queries a list of workflows. |
| ListCalcEngines | ListCalcEngines | Queries a list of compute engines that are associated with a DataWorks workspace. |
| ListCheckProcesses | ListCheckProcesses | Queries the check results of extension point events. |
| ListClusterConfigs | ListClusterConfigs | Queries the configurations of submodules in a workspace. You can query information about SPARK parameters. |
| ListClusters | ListClusters | Queries clusters that are registered in DataWorks. E-MapReduce (EMR) clusters and Cloudera's Distribution Including Apache Hadoop (CDH) clusters are supported. |
| ListConnections | ListConnections | Queries a list of data sources. |
| ListDIAlarmRules | ListDIAlarmRules | Retrieves a list of alert rules configured for a synchronization task. |
| ListDIJobs | ListDIJobs | Retrieves a list of synchronization tasks. |
| ListDIProjectConfig | ListDIProjectConfig | Queries the default global configurations of synchronization solutions in a specified DataWorks workspace. |
| ListDataServiceApiTest | ListDataServiceApiTest | Queries the test records of a DataService Studio API. This API operation allows you to query only the test records that are generated within the previous month. |
| ListDataServiceApis | ListDataServiceApis | Queries a list of APIs in the development state. |
| ListDataServicePublishedApis | ListDataServicePublishedApis | Retrieves a list of published APIs. |
| ListDataSources | ListDataSources | Queries the data sources added to a DataWorks workspace. |
| ListDeployments | ListDeployments | Queries a list of deployment packages. This operation is equivalent to viewing a list of deployment packages on the Deployment Packages page of the DataWorks console. |
| ListEnabledExtensionsForProject | ListEnabledExtensionsForProject | Queries a list of built-in and custom extensions that are enabled in a workspace. |
| ListEntitiesByTags | ListEntitiesByTags | Queries a list of entities by tag. Only entities of the maxcompute-table type are supported. |
| ListEntityTags | ListEntityTags | Queries a list of tags of an entity. Only entities of the maxcompute-table type are supported. |
| ListExtensions | ListExtensions | Queries a list of extensions. |
| ListFileType | ListFileType | Queries the information about node types, such as the code and name. |
| ListFileVersions | ListFileVersions | Queries a list of file versions. |
| ListFiles | ListFiles | Queries a list of files. |
| ListFolders | ListFolders | Call the ListFolders operation to query for folders. |
| ListInstanceAmount | ListInstanceAmount | Queries the trend of the number of auto triggered node instances within a specified period of time. |
| ListInstances | ListInstances | Queries a list of instances. |
| ListLineage | ListLineage | Queries the ancestor or descendant lineage of an entity. |
| ListManualDagInstances | ListManualDagInstances | Queries the information about instances in a manually triggered workflow. |
| ListMetaCollectionEntities | ListMetaCollectionEntities | Queries the entities in a collection. |
| ListMetaCollections | ListMetaCollections | Retrieves a list of collections. Collections include data albums displayed on the Data Map page and categories created in data albums. You can filter collections by type. |
| ListMigrations | ListMigrations | Queries a list of migration tasks. |
| ListNodeIO | ListNodeIO | Queries the information about one level of ancestor or descendant nodes of a node. |
| ListNodes | ListNodes | The ID of the workspace. |
| ListProgramTypeCount | ListProgramTypeCount | Queries the distribution of different types of nodes. |
| ListProjectMembers | ListProjectMembers | Queries a list of existing members in a DataWorks workspace. |
| ListProjectRoles | ListProjectRoles | Queries a list of roles in a DataWorks workspace. |
| ListProjects | ListProjects | Queries a list of DataWorks workspaces of the tenant to which a user belongs. |
| ListQualityRules | ListQualityRules | Call ListQualityRules to retrieve quality rules that match a partition expression. |
| ListRefDISyncTasks | ListRefDISyncTasks | Queries synchronization tasks in Data Integration that use a specific data source. |
| ListResourceGroups | ListResourceGroups | Queries a list of resource groups of a specific type. |
| ListSuccessInstanceAmount | ListSuccessInstanceAmount | Queries the trend of the number of auto triggered node instances that are successfully run every hour on the hour of the current day. |
| ListTables | ListTables | Obtains tables of different data source types within a tenant by page. |
| ListTopics | ListTopics | Queries events. |
| OfflineNode | OfflineNode | Undeploys a node. |
| PublishDataServiceApi | PublishDataServiceApi | Publishes an API. |
| QueryDefaultTemplate | QueryDefaultTemplate | Queries the default data category and data sensitivity level template defined by Data Security Guard. |
| QueryRecognizeDataByRuleType | QueryRecognizeDataByRuleType | Queries the type of a sensitive data identification rule. |
| QueryRecognizeRulesType | QueryRecognizeRulesType | Queries the built-in sensitive data identification rule that is used to configure a sensitive field. |
| QuerySensClassification | QuerySensClassification | Queries data categories. |
| QuerySensLevel | QuerySensLevel | Queries data sensitivity levels in Data Security Guard. |
| QuerySensNodeInfo | QuerySensNodeInfo | Queries sensitive data identification rules. |
| RemoveEntityTags | RemoveEntityTags | Removes tags from an entity. Only entities of the maxcompute-table type are supported. |
| RestartInstance | RestartInstance | Restarts an instance. |
| ResumeInstance | ResumeInstance | Resumes a suspended instance. |
| RevokeTablePermission | RevokeTablePermission | Revokes permissions on a table from a user. |
| RunCycleDagNodes | RunCycleDagNodes | Creates a workflow to backfill data. |
| RunSmokeTest | RunSmokeTest | Creates a workflow to perform smoke testing. |
| RunTriggerNode | RunTriggerNode | Runs a manually triggered node. |
| SaveDataServiceApiTestResult | SaveDataServiceApiTestResult | Saves the test results of an API. |
| ScanSensitiveData | ScanSensitiveData | Checks whether input data contains sensitive data. |
| SearchNodesByOutput | SearchNodesByOutput | Queries a node based on the output. |
| SetDataSourceShare | SetDataSourceShare | Shares a data source to a specific DataWorks workspace or a specific user. |
| SetEntityTags | SetEntityTags | Configures tags for an entity. Only entities of the maxcompute-table type are supported. |
| SetSuccessInstance | SetSuccessInstance | Sets the state of a failed instance to successful. |
| StartDIJob | StartDIJob | Starts a synchronization task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres. |
| StartDISyncInstance | StartDISyncInstance | Starts a real-time synchronization task or a synchronization solution. |
| StartMigration | StartMigration | Starts a migration task. |
| StopDIJob | StopDIJob | Stops a new-version synchronization task. The following type of synchronization task is supported: real-time synchronization of all data in a MySQL database to Hologres. |
| StopDISyncInstance | StopDISyncInstance | Stops a real-time synchronization task. |
| StopInstance | StopInstance | Terminates an instance. |
| SubmitDataServiceApi | SubmitDataServiceApi | Submits an API in DataService Studio. |
| SubmitFile | SubmitFile | Submits a file to the development environment to create a corresponding task. |
| TerminateDISyncInstance | TerminateDISyncInstance | Undeploys a real-time synchronization task. |
| TestDataServiceApi | TestDataServiceApi | Tests a DataService Studio API in asynchronous mode. You can call the GetDataServiceApiTest operation to query the test result. |
| UpdateBusiness | UpdateBusiness | Updates a workflow. |
| UpdateConnection | UpdateConnection | Updates a data source. |
| UpdateDIAlarmRule | UpdateDIAlarmRule | Updates an alert rule for a synchronization task. |
| UpdateDIJob | UpdateDIJob | Updates a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres. |
| UpdateDIProjectConfig | UpdateDIProjectConfig | Modifies the default global configuration of synchronization solutions in a DataWorks workspace. |
| UpdateDataSource | UpdateDataSource | Updates a data source. |
| UpdateFile | UpdateFile | Updates a file. |
| UpdateFolder | UpdateFolder | Updates a folder. |
| UpdateIDEEventResult | UpdateIDEEventResult | Returns the check result of an extension point event to DataStudio after the extension point event is triggered during data development and checked by an extension. |
| UpdateMetaCollection | UpdateMetaCollection | Updates the name and comment of a collection. |
| UpdateNodeOwner | UpdateNodeOwner | Changes the owner of a node. |
| UpdateNodeRunMode | UpdateNodeRunMode | Freezes or unfreezes a node. |
| UpdateRemind | UpdateRemind | Modifies a custom alert rule. |
| UpdateTable | UpdateTable | Updates a MaxCompute table. |
| UpdateTableAddColumn | UpdateTableAddColumn | Updates the fields in a MaxCompute table. |
| UpdateUdfFile | UpdateUdfFile | Updates the file information about a function. |
Others
|
API |
Title |
Description |
| CreateDagComplement | Create a data backfill workflow | Calls CreateDagComplement to create a data backfill workflow. |
| CreateDagTest | Create a smoke test workflow | Creates a smoke test workflow by calling CreateDagTest. |
| CreateManualDag | Trigger the execution of a manual workflow | The manual workflow must have already been submitted and deployed in the UI, and the Operation Center must be able to find the corresponding manual workflow. Only then can this API be used. |
| GetNodeOnBaseline | Query the nodes on a baseline | Calls the GetNodeOnBaseline operation to query the nodes on a baseline. |
| GetInstanceConsumeTimeRank | Queries the ranking of instances by running duration | Queries the ranking of instances by running duration. |
| GetInstanceErrorRank | Obtains the error ranking of nodes in the last month | Calls GetInstanceErrorRank to obtain the error ranking of nodes in the last month. |