API Category
Last updated:2026-03-13 12:14:11
Project Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateProject | Create a project | 20 |
| ListProjects | View the project detail list | 20 |
| GetProject | View the project detail | 20 |
| UpdateProject | This API is used to update a project. | 20 |
| DisableProject | Disable a project | 20 |
| EnableProject | Activate a project | 20 |
| CreateProjectMember | Create a project member | 20 |
| ListProjectMembers | View the project member list | 20 |
| DeleteProjectMember | Remove a project member | 20 |
| GrantMemberProjectRole | Grant a project role to a member | 20 |
| RemoveMemberProjectRole | Revoke a project role of a member | 20 |
| AddCalcEnginesToProject | Associate an engine with a certain project | 20 |
| ListProjectRoles | View the project-level role detail list | 20 |
| CreateDataSource | Creates a data source | 20 |
| ListDataSources | View a data source list | 20 |
| GetDataSource | View a data source detail | 20 |
| UpdateDataSource | Updates a data source | 20 |
| GetDataSourceRelatedTasks | Queries the associated task list of a data source | 20 |
| DeleteDataSource | Deletes a data source | 20 |
| ListTenantRoles | View the global-level role detail list | 20 |
Resource Group APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateResourceGroup | Creates resource groups | 20 |
| ListResourceGroups | View a resource group list | 20 |
| GetResourceGroupMetrics | View monitoring metrics of a specific resource group | 20 |
| UpdateResourceGroup | This API is used to update resource groups. | 20 |
| AssociateResourceGroupToProject | Associate a resource group with a certain project | 20 |
| DissociateResourceGroupFromProject | Unbind the resource group associated with a project | 20 |
| DeleteResourceGroup | Destroy a resource group | 20 |
Data Asset - Data Dictionary APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| AuthorizePrivileges | Authorization | 20 |
| RevokePrivileges | Revoke permission | 20 |
Data Development APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateTaskFolder | Create a task folder | 20 |
| CreateWorkflowFolder | Create a workflow folder | 20 |
| GetTaskFolder | View task folder details | 20 |
| GetWorkflowFolder | View workflow folder details | 20 |
| ListTaskFolders | View task folder list | 20 |
| ListWorkflowFolders | View workflow folder list | 20 |
| UpdateTaskFolder | Update a task folder | 20 |
| UpdateWorkflowFolder | Update a workflow folder | 20 |
| DeleteTaskFolder | Delete a task folder | 20 |
| DeleteWorkflowFolder | Deletes a workflow folder | 20 |
| CreateTriggerWorkflow | Create a scheduling workflow | 20 |
| CreateWorkflow | Creates a workflow | 20 |
| ListTriggerWorkflows | Query the workflow list of query scheduling | 20 |
| ListWorkflows | This API is used to query the list of workflows. | 20 |
| UpdateTriggerWorkflow | Refresh scheduling workflow information | 20 |
| UpdateTriggerWorkflowPartially | Refresh partial scheduling workflow information | 20 |
| UpdateWorkflow | Update workflow information | 20 |
| GetTriggerWorkflow | Retrieve workflow scheduling information | 20 |
| GetWorkflow | Retrieve workflow information | 20 |
| DeleteTriggerWorkflow | Delete a scheduling workflow | 20 |
| DeleteWorkflow | Deletes a workflow | 20 |
| CreateTask | Create a task | 20 |
| CreateTriggerTask | Create a workflow scheduling task | 20 |
| ListTasks | Queries the task list | 20 |
| ListTriggerTasks | Query the workflow task list | 20 |
| GetTask | Retrieve task details | 20 |
| GetTriggerTask | Retrieve workflow scheduling task details | 20 |
| GetTaskCode | View task code | 20 |
| GetTriggerTaskCode | View the workflow scheduling task code | 20 |
| ListTaskVersions | View task version list | 20 |
| ListTriggerTaskVersions | View the workflow scheduling task version list | 20 |
| GetTaskVersion | View task version detail | 20 |
| GetTriggerTaskVersion | View the workflow scheduling task version detail | 20 |
| UpdateTask | Updates a task | 20 |
| UpdateTaskPartially | Update a task partial attribute | 20 |
| UpdateTriggerTask | Updates a workflow scheduling task | 20 |
| UpdateTriggerTaskPartially | Updates a workflow task partial attribute | 20 |
| ListDownstreamTasks | View downstream task list | 20 |
| ListDownstreamTriggerTasks | View the downstream task list of the scheduling workflow | 20 |
| ListUpstreamTasks | View upstream task list | 20 |
| ListUpstreamTriggerTasks | View the upstream task list of the scheduling workflow | 20 |
| SubmitTask | Submits a task | 20 |
| SubmitTriggerTask | Submit a workflow scheduling task | 20 |
| DeleteTask | Deletes a task | 20 |
| DeleteTriggerTask | Delete a workflow scheduling task | 20 |
| CreateResourceFolder | Create a resource folder | 20 |
| GetResourceFolder | Query a resource folder details | 20 |
| ListResourceFolders | View resource folder list | 20 |
| DeleteResourceFolder | Delete a resource folder | 20 |
| UpdateResourceFolder | Updates a resource folder | 20 |
| CreateResourceFile | Creates a resource file | 20 |
| ListResourceFiles | View resource file list | 20 |
| GetResourceFile | View resource file details | 20 |
| UpdateResourceFile | Update a resource file | 20 |
| DeleteResourceFile | Delete a resource file | 20 |
| DeleteWorkflowPermissions | Delete workflow folder permission | 20 |
| GetMyWorkflowMaxPermission | Check current user's recursive maximum permission scope for workflow folder | 20 |
| ListWorkflowPermissions | Retrieve the workflow folder permission list | 20 |
| CreateWorkflowPermissions | Configure workflow folder permission | 20 |
Ops Center APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| GetOpsTaskCode | Retrieve task code | 20 |
| PauseOpsTasksAsync | Pause tasks in batches asynchronously | 20 |
| GetOpsTask | Obtaining Task Details | 20 |
| ListOpsTasks | Obtain Task List | 20 |
| StartOpsTasks | Start tasks asynchronously in batch | 20 |
| UpdateOpsTasksOwner | Modify the task owner | 20 |
| StopOpsTasksAsync | Asynchronously deactivate tasks in batch | 20 |
| GetOpsWorkflow | Get workflow details | 20 |
| ListUpstreamOpsTasks | Retrieve task upstream | 20 |
| ListDownstreamOpsTasks | Retrieve task downstream | 20 |
| ListOpsWorkflows | Retrieve the workflow list | 20 |
| CreateDataBackfillPlan | Create a data backfill plan | 20 |
| GetDataBackfillPlan | View replenishment plan configuration detail | 20 |
| ListDataBackfillInstances | Retrieve all instances of a single backfill | 20 |
| ListUpstreamTaskInstances | Get the direct upstream of an instance | 20 |
| ListDownstreamTaskInstances | Get the direct downstream of an instance | 20 |
| GetTaskInstanceLog | Query the scheduling instance log content | 20 |
| GetTaskInstance | Get instance details | 20 |
| ListTaskInstances | Search the scheduling instance list | 20 |
| SetSuccessTaskInstancesAsync | Batch configure instances (async) | 20 |
| KillTaskInstancesAsync | Batch terminate instances (async) | 20 |
| RerunTaskInstancesAsync | Batch rerun instances (async) | 20 |
| ListTaskInstanceExecutions | Get instance execution list | 20 |
| CreateOpsAlarmRule | Set Alarm rules | 20 |
| GetOpsAlarmRule | Query Alarm rule details | 20 |
| ListOpsAlarmRules | Search the Alarm rule list | 20 |
| UpdateOpsAlarmRule | Modifies alarm rules | 20 |
| DeleteOpsAlarmRule | Deletes alarm rules | 20 |
| GetAlarmMessage | Query alert information details | 20 |
| ListAlarmMessages | Search the Alarm information list | 20 |
| GetOpsAsyncJob | Query async operation details in ops center | 20 |
| CreateTriggerWorkflowRun | Runs the workflow | 20 |
| DeleteDataBackfillPlanAsync | Asynchronously delete a replenishment plan | 20 |
| GetOpsTriggerWorkflow | View workflow details | 20 |
| GetTriggerTaskRun | View task running details | 20 |
| GetTriggerWorkflowRun | Query workflow running details | 20 |
| KillTriggerWorkflowRuns | Terminate running | 20 |
| ListOpsTriggerWorkflows | View workflow list | 20 |
| ListTriggerWorkflowRuns | Query workflow operation | 20 |
| RerunTriggerWorkflowRunAsync | Rerun an operation | 20 |
| UpdateOpsTriggerTasksOwner | Modify the trigger task owner | 20 |
Data Exploration APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateCodeFolder | Create a code folder | 20 |
| CreateCodeFile | Create a code file | 20 |
| CreateSQLScript | Adds an SQL script | 20 |
| DeleteCodeFolder | Delete a code folder | 20 |
| DeleteSQLFolder | Delete an SQL folder | 20 |
| DeleteCodeFile | Delete a code file | 20 |
| DeleteSQLScript | Delete an SQL script | 20 |
| ListCodeFolderContents | Get folder content | 20 |
| ListSQLFolderContents | Retrieve the content list of an sql folder | 20 |
| GetCodeFile | View code file details | 20 |
| GetSQLScript | View SQL script details | 20 |
| ListSQLScriptRuns | Query SQL run history | 20 |
| UpdateCodeFolder | Update the code folder | 20 |
| UpdateSQLFolder | Renames an SQL folder | 20 |
| UpdateCodeFile | Update a code file | 20 |
| UpdateSQLScript | Update an SQL script and configurations | 20 |
| RunSQLScript | Run an SQL script | 20 |
| StopSQLScriptRun | Stop running an SQL script | 20 |
| CreateCodePermissions | Configure CodeStudio entity permission | 20 |
| GetMyCodeMaxPermission | View the current user's maximum permission scope for the CodeStudio entity | 20 |
| ListCodePermissions | View CodeStudio entity permission | 20 |
| DeleteCodePermissions | Delete CodeStudio entity permission | 20 |
| CreateSQLFolder | Creates an SQL folder | 20 |
| GetCodeFolder | Retrieve codestudio folder details | 20 |
| GetSQLFolder | Retrieve SQL folder details | 20 |
Asset APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| ListLineage | Query lineage list | 20 |
| RegisterLineage | Register lineage | 20 |
| DeleteLineage | Delete lineage | 20 |
| ListCatalog | Query a category tree list | 20 |
| ListColumnLineage | Query table column lineage list | 20 |
| ListDatabase | Query the database list with parameter | 20 |
| ListProcessLineage | Query task lineage list | 20 |
| ListSchema | Query database mode list with parameter | 20 |
| ListTable | Query the data table list with parameter | 20 |
| GetTable | Access table details | 20 |
| GetTableColumns | Obtains the field list of a table | 20 |
Data Security APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| ListPermissions | Obtain resource permission details | 20 |
Data Quality APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| ListQualityRuleTemplates | Quality rule template query interface | 20 |
Platform Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DeleteProject | Deletes a project | 20 |
Data Source Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeDataSourceAuthority | Data source management-view data source permission | 20 |
| AuthorizeDataSource | Authorize a data source | 20 |
| RevokeDataSourceAuthorization | Revoke data source permission | 20 |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback