OpenAPI rate limiting and version requirements-Dataphin(Dataphin)-阿里云帮助中心

Learn about the API throttling levels and Dataphin version requirements for different features.

Limitations

RAM roles do not support OpenAPI calls.
To ensure application stability, Dataphin classifies OpenAPI into three levels: Level 1, Level 2, and Level 3. For information about the rate limiting levels and call quotas for different versions, see Call quotas for different Dataphin versions.

Permissions

The DataphinOpenAPIFullAccess system permission allows you to call all OpenAPI operations.
The DataphinOpenAPIReadOnlyAccess system permission allows you to call read-only OpenAPI operations.

Data development

Group	API	Description	Rate limit level	Minimum version
Directory tree	CreateDirectory	Creates a directory in the directory tree for items such as computing tasks, data integration, and synchronization tasks.	Level 2	Agile Edition
	DeleteDirectory	Deletes a directory from the directory tree.	Level 3	Agile Edition
	UpdateFileName	Updates the name of a file.	Level 2	Agile Edition
	UpdateFileDirectory	Moves a file to a different location in the directory tree.	Level 2	Agile Edition
	GetDirectoryTree	Retrieves the directory structure of a folder.	Level 1	Agile Edition
	ListFiles	Lists files in a directory tree.	Level 1	Agile Edition
Data architecture	CreateBizEntity	Creates a business entity.	Level 3	Intelligent Edition
	DeleteBizEntity	Deletes a business entity.	Level 3	Intelligent Edition
	GetBizEntityInfo	Gets details of a business entity.	Level 1	Intelligent Edition
	GetBizEntityInfoByVersion	Gets details for a specific version of a business entity.	Level 1	Intelligent Edition
	ListBizEntities	Lists business entities.	Level 2	Intelligent Edition
	OfflineBizEntity	Takes a business entity offline.	Level 2	Intelligent Edition
	OnlineBizEntity	Brings a business entity online.	Level 2	Intelligent Edition
	UpdateBizEntity	Updates a business entity.	Level 2	Intelligent Edition
	CreateBizUnit	Creates a business unit.	Level 3	Intelligent Edition
	CreateDataDomain	Creates a data domain.	Level 3	Intelligent Edition
	DeleteBizUnit	Deletes a business unit.	Level 3	Intelligent Edition
	DeleteDataDomain	Deletes a data domain.	Level 3	Intelligent Edition
	GetBizUnitInfo	Gets business unit information by ID.	Level 3	Intelligent Edition
	GetDataDomainInfo	Gets details of a data domain.	Level 3	Intelligent Edition
	ListBizUnits	Lists business units for the current tenant.	Level 2	Intelligent Edition
	ListDataDomains	Lists data domains.	Level 3	Intelligent Edition
	UpdateBizUnit	Updates a business unit.	Level 3	Intelligent Edition
	UpdateDataDomain	Updates a data domain.	Level 3	Intelligent Edition
Ad hoc query	CreateAdHocFile	Creates an ad hoc query file.	Level 3	Agile Edition
	DeleteAdHocFile	Deletes an ad hoc query file.	Level 3	Agile Edition
	UpdateAdHocFile	Updates an ad hoc query file.	Level 2	Agile Edition
	GetAdHocFile	Retrieves an ad hoc query file.	Level 1	Agile Edition
	StopAdHocTask	Stops an ad hoc query task.	Level 2	Agile Edition
	GetAdHocTaskResult	Gets the result of an ad hoc query task.	Level 2	Agile Edition
	ExecuteAdHocTask	Executes an ad hoc query task.	Level 2	Agile Edition
	GetAdHocTaskLog	Gets the log of an ad hoc query task.	Level 1	Agile Edition
	ExecuteDDL	Executes a DDL statement to create a table in a specified data source.	/	Agile Edition
Unstructured data	CreateWorkFlowByJson	Creates an unstructured data workflow from a JSON script.	Level 1	Basic Edition
	CreateDataset	Creates a dataset.	Level 1	Basic Edition
	DeleteDataset	Deletes a dataset.	Level 1	Basic Edition
	GetDataset	Gets details of a dataset.	Level 3	Basic Edition
	ListDatasets	Lists datasets.	Level 3	Basic Edition
	UpdateDataset	Updates dataset information.	Level 1	Basic Edition
	GetLlmModelProviders	Gets a list of large model service providers and their available models.	/	Basic Edition
	GetLlmModelProviderByName	Gets a large model service provider and its available models by name.	/	Basic Edition
Operation record	ListOperationRecord	Lists operation records.	Level 2	Agile Edition
	GetOperationRecordRunCode	Gets the code for an operation record.	Level 2	Agile Edition
	GetOperationRecordById	Gets an operation record by its ID.	Level 2	Agile Edition
	GetOperationRecordDetail	Gets the details, log, and results of an operation record.	Level 1	Agile Edition
Offline integration	CreatePipeline	Creates an integration pipeline or an unstructured data workflow.	Level 3	Agile Edition
	CreatePipelineByAsync	Asynchronously creates an integration pipeline or an unstructured data workflow.	Level 3	Agile Edition
	OfflinePipeline	Takes a pipeline task offline.	Level 3	Agile Edition
	OfflinePipelineByAsync	Asynchronously takes a pipeline task offline.	Level 3	Agile Edition
	GetPipelineAsyncResult	Gets the result of an asynchronous pipeline.	Level 1	Agile Edition
	GetPipelineById	Gets a pipeline by its ID.	Level 1	Agile Edition
	UpdatePipeline	Updates a pipeline task.	Level 3	Agile Edition
	UpdatePipelineByAsync	Asynchronously updates an integration pipeline.	Level 3	Agile Edition
Offline computing task	GetOperationRecordRunCode	Gets the code of an operation record.	/	Agile Edition
	CreatePipelineNode	Creates a data integration task. Note This API is deprecated in v5.3.1 and later. Use `CreatePipeline` instead.	Level 3	Basic Edition
	ListPipelines	Lists tasks, including offline integration, , and unstructured data workflows (Data Ingestion, Offline Workflow, Real-time Workflow). Supports filtering by various criteria, including directory, keyword, task type, submission status, scheduling type, owner, tag, and creator.	/	Agile Edition
	CreateBatchTask	Creates an offline computing task.	Level 3	Agile Edition
	DeleteBatchTask	Deletes an offline computing task.	Level 3	Agile Edition
	GetBatchTaskInfo	Gets details of an offline computing task.	Level 1	Agile Edition
	SubmitPipelineById	Submits an integration pipeline by its OAQueryId.	/	Agile Edition
	GetBatchTaskVersions	Gets the version list for an offline computing task.	Level 2	Agile Edition
	GetBatchTaskUdfLineages	Gets the user-defined function (UDF) lineage for an offline computing task.	Level 2	Agile Edition
	GetBatchTaskInfoByVersion	Gets details for a specific version of an offline computing task.	Level 2	Agile Edition
	OfflineBatchTask	Takes an offline computing task offline.	Level 3	Agile Edition
	ParseBatchTaskDependency	Parses the logical table dependencies of an offline computing task. Note The parsing result for upstream dependencies may include self-dependencies (where the upstream node ID is the same as the current task node ID). You are responsible for handling these cases.	Level 3	Agile Edition
	UpdateBatchTaskUdfLineages	Updates the user-defined function (UDF) lineage of an offline computing task.	Level 3	Agile Edition
	SubmitBatchTask	Submits an offline computing task.	Level 3	Agile Edition
	UpdateBatchTask	Updates an offline computing task.	Level 3	Agile Edition
Offline computing task template	ListBatchTemplates	Lists offline computing task templates.	Level 3	Agile Edition
Offline computing task template	GetBatchTemplateVersions	Gets the version list for a template.	Level 3	Agile Edition
Real-time development task	GetStreamJobs	Gets a list of real-time development tasks.	Level 2	Basic Edition
	GetQueueEngineVersionByEnv	Gets the engine version information of a cluster.	Level 2	Basic Edition
	GetClusterQueueInfoByEnv	Gets an environment's cluster queue information.	Level 2	Basic Edition
	CreateStreamBatchJobMapping	Creates a stream-batch integration task.	Level 2	Basic Edition
Resource	GetResource	Gets details of a resource file.	Level 2	Agile Edition
	GetResourceByVersion	Gets details of a specific version of a resource file.	Level 2	Agile Edition
	UpdateResource	Updates a resource file.	Level 2	Agile Edition
	GetFileStorageCredential	Gets temporary read and write credentials for file storage.	Level 2	Agile Edition
	DeleteResource	Deletes a resource file.	Level 3	Agile Edition
	CreateResource	Creates a resource file.	Level 3	Agile Edition
Function	GetUdf	Gets details of a user-defined function.	Level 2	Agile Edition
	GetUdfByVersion	Gets details of a specific version of a user-defined function.	Level 2	Agile Edition
	UpdateUdf	Updates a user-defined function.	Level 2	Agile Edition
	DeleteUdf	Deletes a user-defined function.	Level 3	Agile Edition
	CreateUdf	Creates a user-defined function.	Level 3	Agile Edition
Publish	GetLatestSubmitDetail	Gets details of the latest submission record pending publication.	Level 2	Basic Edition
	ListSubmitRecords	Lists submission records that are pending publication.	Level 2	Basic Edition
	ListPublishRecords	Lists publication records.	Level 2	Basic Edition
	PublishObjectList	Publishes objects in a batch.	Level 2	Basic Edition

O&M center

Group	API	Description	Throttling level	Minimum version
Instance O&M	FixData	Performs a data backfill. This operation reruns affected downstream instances, incurring compute costs and affecting data output.	Level 2	Agile Edition
	GetInstanceDownStream	Retrieves the downstream instances for a specified instance.	Level 2	Agile Edition
	GetInstanceUpDownStream	Queries the upstream and downstream instances for a specified instance. This operation supports logical tables and code-based tasks.	Level 2	Agile Edition
	OperateInstance	Performs batch maintenance operations on instances. This supports both physical instances and logical table instances.	Level 2	Agile Edition
	GetSupplementDagrunInstance	Lists all node instances within a data backfill workflow for a specific business date.	Level 1	Agile Edition
	GetPhysicalInstance	Retrieves the details of an instance.	Level 1	Agile Edition
	ListInstances	Queries a paginated list of instances.	Level 1	Agile Edition
Task O&M	GetNodeUpDownStream	Retrieves the upstream and downstream nodes for a specified node.	Level 2	Agile Edition
	ExecuteManualNode	Runs a manual task. Note This generates a manual scheduling node and affects related tables. Running the task incurs compute and storage costs.	Level 2	Agile Edition
	GetOperationSubmitStatus	Retrieves the submission status of a data backfill workflow.	Level 1	Agile Edition
	GetPhysicalInstanceLog	Retrieves the execution log for an instance.	Level 2	Agile Edition
	GetPhysicalNode	Queries a physical scheduling node.	Level 1	Agile Edition
	GetPhysicalNodeContent	Retrieves the code for a scheduling node.	Level 1	Agile Edition
	GetPhysicalNodeOperationLog	Queries the operation log of a node.	Level 1	Agile Edition
	GetSupplementDagrun	Retrieves a list of Dagruns for a data backfill workflow.	Level 1	Agile Edition
	ListNodeDownStream	Queries the downstream nodes for a specified node. You can use the result as a reference when creating a data backfill workflow.	Level 2	Agile Edition
	ListApprovalTasksByUser	Queries a paginated list of approval tasks related to the current user.	/	Agile Edition
	ListNodes	Queries a list of scheduling nodes.	Level 1	Agile Edition
	PausePhysicalNode	Pauses the scheduling of a physical node. A successful call prevents the task and its downstream tasks from triggering. This operation supports only offline code tasks and integration tasks.	Level 2	Agile Edition
	ResumePhysicalNode	Resumes the scheduling of a physical node.	Level 2	Agile Edition
	CreateNodeSupplement	Performs a general-purpose data backfill operation that supports both list mode and bulk mode. Note This operation generates data backfill instances, affecting the data output of related tables. Running the task incurs compute and storage costs.	Level 2	Agile Edition
	GetDevObjectDependency	Queries the upstream dependencies of an object in the development state.	Level 2	Agile Edition
	UpdateNodeOpsOwner	Updates the O&M owner for multiple nodes. (This operation applies only to offline tasks, including compute tasks, integration tasks, and logical tables. It does not support real-time tasks.)	/	Agile Edition
	ExecuteTriggerNode	Runs a trigger-based node.	/	Agile Edition
	GetPhysicalNodeByOutputName	Queries a physical node by its output name. This operation supports only offline code nodes and integration task nodes.	Level 1	Agile Edition
Alerts	GetAlertEvent	Retrieves the details of an alert event.	Level 1	Agile Edition
	ListAlertEvents	Queries multiple alert events based on specified conditions.	Level 1	Agile Edition
	ListAlertNotifications	Queries multiple notification records based on specified conditions.	Level 1	Agile Edition

Data permissions

Group	API	Description	Throttling level	Minimum version
permission management	CheckResourcePermission	Checks if a user has permissions on a specific resource.	Level 2	Agile Edition
	GrantResourcePermission	Grants a user permissions on a resource. Note Only a super administrator or resource owner (project administrator or data source administrator) can call this API. It currently supports tables and data sources.	Level 2	Agile Edition
	RevokeResourcePermission	Revokes permissions on a resource from a user. Note Only a super administrator or resource owner (project administrator or data source administrator) can call this API. It currently supports tables and data sources.	Level 2	Agile Edition

Data assets

Group	OpenAPI name	Description	Rate limit level	Minimum version
Asset	GetTableLineageByTaskId	Queries table lineage.	Level 2	Agile Edition
	GetTableColumnLineageByTaskId	Queries column lineage.	Level 2	Agile Edition
	UpdateDataAssetsGovernObjectStatus	Batch updates the status of govern objects by their governance item IDs.	/	Agile Edition
	UpsertQualityArchiveTable	Creates or updates the exception archive table for a quality watch.	/	Agile Edition
	UpdateAssetAttributes	Updates asset attribute values.	/	Agile Edition
	SubmitAssetsOffShelve	Submits an asset for unpublishing.	/	Agile Edition
	AddRegisterLineage	Adds a registered lineage.	Level 2	Agile Edition
	GetAssetTypeAttributeCodes	Queries the attribute definitions of an asset type.	/	Agile Edition
	GetAssetAttributes	Queries asset attribute values.	/	Agile Edition
	ListAssetTopics	Lists published asset topics.	/	Agile Edition
	ListAssetDirectories	Lists published directories under a specified asset topic.	/	Agile Edition
	GetDataAssetsGovernObject	Gets the details of a govern object by its governance item ID.	/	Agile Edition
	ListQualityArchiveTables	Lists the exception archive tables for a specified quality watch.	/	Agile Edition
	ListGovernObjects	Lists govern objects by governance type and filter criteria.	/	Agile Edition
	DeleteRegisterLineage	Deletes a registered lineage.	Level 2	Agile Edition
	SubmitAssetsOnShelve	Submits an asset for publishing.	/	Agile Edition
	CreateBizMetric	Creates a business metric.	Level 3	Agile Edition
	UpdateBizMetric	Updates a business metric.	Level 3	Agile Edition
	DeleteBizMetric	Deletes a business metric.	Level 3	Agile Edition
	GetBizMetricByName	Gets the details of a business metric.	Level 2	Agile Edition
	ListCatalogAssets	Lists assets in the asset catalog. Supports both exact match and fuzzy search.	Level 2	Agile Edition
	GetCatalogAssetDetails	Gets the details of an asset in the asset catalog.	Level 2	Agile Edition
	GetTableLineages	Queries the table lineage of an asset.	/	Agile Edition
	GetBelongAssetMapping	Queries mapping relationships by the GUID of an owning asset.	/	Agile Edition
	GetAssetMappingRelations	Queries mapping relationships by the GUID of an asset.	/	Agile Edition
	ListTables	Gets a paginated list of asset table metadata.	/	Agile Edition
	GetTableColumnLineages	Queries the column lineage of an asset table.	/	Agile Edition
	GetTableColumns	Queries the columns of a Dataphin table. Supported table types include: dimension logical table, fact logical table, summary logical table, tag logical table, logical table view, physical table, physical view, and materialized view.	/	Intelligent Edition
Data standard	UpdateStandardWordRoot	Updates a word root.	/	Basic Edition
	CreateStandardWordRoot	Creates a word root.	/	Basic Edition
	CreateStandardTemplate	Creates a data standard template.	/	Basic Edition
	CreateStandardSet	Creates a standard set.	/	Basic Edition
	CreateStandardRelations	Creates standard relations.	/	Basic Edition
	CreateStandardMapping	Creates standard mappings, including valid and invalid mappings.	/	Basic Edition
	CreateStandardLookupTable	Creates a lookup table.	/	Basic Edition
	CreateStandard	Creates a data standard.	/	Basic Edition
	ListStandards	Queries a paginated list of data standards.	/	Basic Edition
	GetStandardWordRoot	Gets the details of a word root.	/	Basic Edition
	GetStandardTemplate	Gets the details of a data standard template.	/	Basic Edition
	GetStandardStatistics	Queries the number of standards in a directory, grouped by standard type.	/	Basic Edition
	GetStandardSet	Gets the details of a standard set.	/	Basic Edition
	GetStandardLookupTable	Gets the details of a lookup table.	/	Basic Edition
	GetStandard	Gets the details of a data standard.	/	Basic Edition
	UpdateStandardTemplate	Updates a data standard template.	/	Basic Edition
	UpdateStandardSet	Updates a standard set.	/	Basic Edition
	UpdateStandardMappingToInvalid	Marks standard mappings as invalid.	/	Basic Edition
	UpdateStandardLookupTable	Updates a lookup table.	/	Basic Edition
	UpdateStandard	Updates a data standard.	/	Basic Edition
	OfflineStandard	Takes a data standard offline.	/	Basic Edition
	PublishStandard	Publishes a data standard.	/	Basic Edition
	DeleteStandardWordRoot	Deletes a word root.	/	Basic Edition
	DeleteStandardValidMapping	Deletes a valid mapping.	/	Basic Edition
	DeleteStandardSet	Deletes a standard set.	/	Basic Edition
	DeleteStandardRelations	Batch deletes standard relations.	/	Basic Edition
	DeleteStandardLookupTable	Deletes a lookup table.	/	Basic Edition
	DeleteStandardInValidMapping	Deletes an invalid mapping.	/	Basic Edition
	DeleteStandard	Deletes a data standard.	/	Basic Edition
Data quality	AssignQualityRuleOfAllRuleScopeSchedules	Binds a quality rule to a scheduling setting.	/	Basic Edition
	GetQualityArchiveTableProgress	Queries the progress and result of a task to create or update an exception archive table, by progress ID.	/	Basic Edition
	ListQualityWatches	Queries a paginated list of quality watches.	/	Basic Edition
	ListQualityWatchTasks	Queries a paginated list of quality watch tasks.	/	Basic Edition
	ListQualityTemplates	Queries a paginated list of quality templates.	/	Basic Edition
	ListQualityRules	Queries a paginated list of quality rules.	/	Basic Edition
	ListQualityRuleTasks	Queries a paginated list of quality rule tasks.	/	Basic Edition
	GetQualityWatchTaskLog	Gets the logs of a quality watch task.	/	Basic Edition
	GetQualityWatchTask	Gets a quality watch task.	/	Basic Edition
	GetQualityWatchByObjectId	Gets a quality watch record by the original ID of the watched object, such as the ID of a data source, table, or metric.	/	Basic Edition
	GetQualityWatch	Gets a quality watch.	/	Basic Edition
	GetQualityTemplate	Gets a quality template.	/	Basic Edition
	GetQualitySchedulesByWatchId	Gets a list of scheduling settings by a quality watch ID.	/	Basic Edition
	GetQualitySchedule	Gets a scheduling setting.	/	Basic Edition
	GetQualityRuleTaskLog	Gets the logs of a quality rule task.	/	Basic Edition
	GetQualityRuleTask	Gets the details of a quality rule task.	/	Basic Edition
	GetQualityRule	Gets a quality rule.	/	Basic Edition
	GetQualityAlertOfAllRuleScopeByWatchId	Gets the alert settings by a quality watch ID.	/	Basic Edition
	UpsertQualityWatchAlert	Creates or updates the alert settings for a quality watch.	/	Basic Edition
	UpsertQualityWatch	Creates or updates a quality watch. Supported types include Dataphin tables, global tables, data sources, metrics, and real-time meta tables.	/	Basic Edition
	UpsertQualityTemplate	Creates or updates a quality template.	/	Basic Edition
	UpsertQualitySchedule	Creates or updates a scheduling setting.	/	Basic Edition
	UpsertQualityRule	Creates or updates a quality rule.	/	Basic Edition
	UpdateQualityWatchSwitch	Batch enables or disables quality watches.	/	Basic Edition
	UpdateQualityRuleSwitch	Batch enables or disables quality rules.	/	Basic Edition
	SubmitQualityWatchTasks	Batch submits quality watch validation tasks.	/	Basic Edition
	SubmitQualityRuleTasks	Batch submits quality rule tasks. This operation supports dry runs.	/	Basic Edition
	RemoveQualityRuleSchedules	Batch unbinds quality rules from scheduling settings.	/	Basic Edition
	DeleteQualityWatches	Batch deletes quality watches.	/	Basic Edition
	DeleteQualityTemplates	Batch deletes quality templates.	/	Basic Edition
	DeleteQualitySchedules	Batch deletes scheduling settings.	/	Basic Edition
	DeleteQualityRules	Batch deletes quality rules.	/	Basic Edition
	UpdateSecurityLevel	Updates a data security level.	/	Basic Edition
	UpdateSecurityIdentifyResultStatus	Updates the effective status of a security identification result.	/	Basic Edition
	UpdateSecurityClassifyCatalog	Updates a data classification catalog.	/	Basic Edition
	UpdateSecurityClassify	Updates a data classification.	/	Basic Edition
	CreateSecurityLevel	Creates a data security level.	/	Basic Edition
	CreateSecurityIdentifyResult	Creates a security identification result.	/	Basic Edition
	CreateSecurityClassifyCatalog	Creates a data classification catalog.	/	Basic Edition
	CreateSecurityClassify	Creates a data classification.	/	Basic Edition
	ListSecurityClassify	Queries a paginated list of data classifications.	/	Basic Edition
	ListSecurityIdentifyResults	Queries a paginated list of security identification results.	/	Basic Edition
	ListSecurityIdentifyRecords	Queries a paginated list of identification records for a security identification result.	/	Basic Edition
	GetSecuritySecretKey	Gets a secret key value by its name.	/	Basic Edition
	GetSecurityLevel	Gets the details of a data security level.	/	Basic Edition
	GetSecurityIdentifyResult	Gets the details of a security identification result.	/	Basic Edition
	GetSecurityClassify	Gets the details of a data classification.	/	Basic Edition
	DeleteSecurityLevel	Deletes a data security level.	/	Basic Edition
	DeleteSecurityIdentifyResults	Batch deletes security identification results.	/	Basic Edition
	DeleteSecurityClassifyCatalog	Deletes a data classification catalog.	/	Basic Edition
	DeleteSecurityClassify	Deletes a data classification.	/	Basic Edition

Data service

Group		API name	Description	Throttling level	Minimum version
Data service	API management	CreateDataServiceApi	Creates and submits a new data service API.	Level 2	Agile Edition
		PublishDataServiceApi	Publishes a data service API to the production environment.	Level 3	Agile Edition
		ListDataServicePublishedApis	Retrieves a paginated list of published APIs.	Level 2	Agile Edition
		GetDataServiceApiGroups	Retrieves a list of data service API groups.	Level 1	Agile Edition
		GetDataServiceApiDocument	Retrieves the API documentation.	Level 2	Agile Edition
		ListApiByApp	Lists APIs by application.	Level 1	Agile Edition
		ListAuthorizedDataServiceApiDetails	Retrieves a list of fields for APIs requested by an application.	Level 1	Agile Edition
	API authorization	GrantDataServiceApi	Grants API authorization.	Level 3	Agile Edition
		RevokeDataServiceApi	Revokes API authorization.	Level 3	Agile Edition
		ApplyDataServiceApi	Requests permissions for a data service API.	Level 2	Agile Edition
		ListDataServiceMyApiPermissions	Retrieves a list of the API permissions you manage.	Level 1	Agile Edition
	Application management	ListDataServiceApps	Retrieves a list of all applications for the tenant.	Level 1	Agile Edition
		GetDataServiceApp	Retrieves the details of an application.	Level 1	Agile Edition
		CreateDataServiceApp	Creates a data service application.	Level 3	Agile Edition
		UpdateDataServiceApp	Updates a data service application.	Level 3	Agile Edition
		DeleteDataServiceApp	Deletes a data service application.	Level 3	Agile Edition
		ResetDataServiceAppSecret	Resets the application secret for a data service application.	Level 3	Agile Edition
		ApplyDataServiceApp	Requests permissions for a data service application.	Level 2	Agile Edition
		GetDataServiceAppsByGroupId	Retrieves a list of applications within a group.	Level 1	Agile Edition
	Application groups	GetDataServiceAppGroups	Retrieves a list of application groups for a data service project.	Level 1	Agile Edition
		CreateDataServiceAppGroup	Creates an application group.	Level 3	Agile Edition
		UpdateDataServiceAppGroup	Updates an application group.	Level 3	Agile Edition
		DeleteDataServiceAppGroup	Deletes an application group.	Level 3	Agile Edition
		GetDataServiceAuthorizedAppsByGroupId	Retrieves authorized applications in a specified application group.	Level 1	Agile Edition
	Application members	GetDataServiceAppMembers	Retrieves application members.	Level 2	Agile Edition
		AddDataServiceAppMember	Adds an application member.	Level 3	Agile Edition
		UpdateDataServiceAppMember	Updates an application member.	Level 3	Agile Edition
		RemoveDataServiceAppMember	Removes an application member.	Level 3	Agile Edition
		GetDataServiceAppAuthorizedUsers	Retrieves users authorized for an application.	Level 1	Agile Edition
	Project management	GetDataServiceMyProjects	Retrieves projects owned by the current user.	Level 1	Agile Edition
		GetDataServiceAuthorizedProjects	Retrieves authorized projects.	Level 1	Agile Edition
		GetDataServiceProjectAddableUsers	Retrieves users you can add as project members.	Level 1	Agile Edition
		AddDataServiceProjectMember	Adds a user to a data service project and assigns a role.	Level 2	Agile Edition
	Permission query	ListDataServiceMyAppPermissions	Retrieves applications the current user can access.	Level 1	Agile Edition
	Permission query	ListDataServiceAuthorizedApps	Retrieves applications the current user can access.	Level 1	Agile Edition
	Operations Monitoring	GetDataServiceApiCallTrend	Retrieves API call trends.	Level 1	Agile Edition
		GetDataServiceApiCallSummary	Retrieves a summary of API call statistics.	Level 1	Agile Edition
		ListDataServiceApiCallStatistics	Retrieves API call statistics.	Level 3	Agile Edition
		ListDataServiceApiCalls	Retrieves a paginated list of data service call logs.	Level 2	Agile Edition
		ListDataServiceApiImpacts	Retrieves a paginated list of impacts from abnormal data service API calls.	Level 2	Agile Edition
		GetDataServiceApiErrorImpact	Retrieves a summary of API error impacts.	Level 2	Agile Edition

Platform management

Group	API name	Description	Throttling level	Minimum version
User and authorization	TransferOwnershipForAllObject	Transfers ownership of all objects from one user to another.	Level 3	Agile
	RetryTransferOwnership	Retries a failed ownership transfer task.	Level 3	Agile
	GetTransferInfo	Gets the progress of an ownership transfer task by its ID.	Level 2	Agile
	SyncDepartment	Synchronizes department information.	/	Agile
	SyncDepartmentUser	Synchronizes department member information.	/	Agile
	AddTenantMembers	Adds users to a tenant in batches. Note Only super administrators and system administrators can call this API.	Level 3	Agile
	AddTenantMembersBySourceUser	Adds tenant members using their source user information.	Level 2	Agile
	AddUserGroupMember	Adds a member to a user group.	Level 2	Agile
	ListResourcePermissionOperationLog	Queries a paginated list of permission operation logs.	Level 3	Agile
	ListResourcePermissions	Queries a paginated list of permission grant records.	Level 3	Agile
	GetProjectProduceUser	Gets the production account for a project. Note Only super administrators can call this API.	Level 1	Agile
	CreateUserGroup	Creates a user group.	Level 3	Basic
	GetUserByAccessKey	Gets current user information from the AccessKey/SecretKey in the request signature.	/	Basic
	DeleteUserGroup	Deletes a user group.	Level 3	Basic
	GetUserBySourceId	Gets user details by source user ID.	Level 1	Agile
	GetUserGroup	Gets the details of a user group.	Level 1	Basic
	GetUsers	Gets information for multiple users by their UserIDs.	Level 1	Agile
	ListAddableRoles	Gets the global roles that can be assigned to tenant members. Note Only built-in global roles are supported. Custom global roles are not supported.	Level 1	Agile
	ListAddableUsers	Lists users that can be added to a tenant. Note Only super administrators and system administrators can call this API.	Level 1	Agile
	ListTenantMembers	Lists tenant members.	Level 1	Agile
	ListUserGroups	Lists user groups.	Level 1	Basic
	ListUserGroupMembers	Lists user group members.	Level 1	Basic
	RemoveTenantMember	Removes a member from a tenant. Note This API can be called by super administrators and system administrators.	Level 2	Agile
	RemoveUserGroupMember	Removes a member from a user group.	Level 2	Basic
	UpdateTenantMember	Updates a tenant member. Note Only super administrators and system administrators can call this API.	Level 2	Agile
	UpdateUserGroup	Updates a user group.	Level 3	Basic
	UpdateUserGroupSwitch	Toggles the enabled status of a user group.	Level 3	Basic
	GetMyTenants	Gets the current user's tenants.	Level 1	Agile
	GetMyRoles	Gets the current user's roles.	Level 1	Agile
Row-level permission	DeleteRowPermission	Deletes a row-level permission.	Level 3	Agile
	GetAccountByRowPermissionId	Gets all accounts authorized for a row-level permission.	Level 3	Agile
	ListRowPermission	Lists row-level permissions.	Level 3	Agile
	ListRowPermissionByUserId	Lists the row-level permissions for a specified user.	Level 3	Agile
	UpdateRowPermission	Updates a row-level permission.	Level 3	Agile
	CreateRowPermission	Creates a row-level permission.	Level 3	Agile
	GetRowPermissionByTableGuids	Gets row-level permissions by table GUIDs.	Level 3	Agile
	GetServerVersion	Gets the version of the Dataphin server.	/	Agile
Compute source	CheckComputeSourceConnectivity	Checks the connectivity of a compute source.	Level 3	Agile
	CheckComputeSourceConnectivityById	Checks the connectivity of a compute source by its ID.	Level 3	Agile
	ListComputeSources	Lists compute sources.	Level 2	Agile
	UpdateComputeSource	Updates a compute source. This operation can be performed by business sector administrators and project administrators.	Level 3	Agile
	GetComputeSource	Gets the details of a compute source by its ID.	Level 2	Agile
	DeleteComputeSource	Deletes a compute source.	Level 3	Agile
	CreateComputeSource	Creates a compute source. Note This operation can be performed by business sector administrators and project administrators.	Level 3	Agile
	GetSparkLocalClientInfo	Gets the Spark client information for the cluster associated with a compute source.	Level 2	Agile
Data source	GetDataSourceDependencies	Queries the integration tasks and Database SQL tasks affected by a data source change.	Level 3	Agile
	CheckDataSourceConnectivity	Checks the connectivity of a data source.	Level 3	Agile
	CheckDataSourceConnectivityById	Checks the connectivity of a data source by its ID.	Level 3	Agile
	CreateDataSource	Creates a data source. Note This operation can be performed by tenant administrators, data administrators, business sector administrators, project administrators, and operations administrators.	Level 3	Agile
	DeleteDataSource	Deletes a data source. Note This operation can be performed by tenant administrators, data administrators, business sector administrators, project administrators, and operations administrators.	Level 3	Agile
	UpdateDataSourceBasicInfo	Updates the basic information of a data source. Note This operation can be performed by tenant administrators, data administrators, business sector administrators, project administrators, and operations administrators.	Level 3	Agile
	UpdateDataSourceConfig	Updates the connection configuration of a data source. Note This operation can be performed by tenant administrators, data administrators, business sector administrators, project administrators, and operations administrators.	Level 3	Agile
	ListDataSourceWithConfig	Lists data sources and their configurations.	Level 2	Agile
	GetCheckConnectivityJobs	Queries the history of data source connectivity tests.	Level 3	Agile
Project	CreateDevProdProject	Creates a Dev-Prod (dual-environment) project.	/	Agile
	CreateBasicProject	Creates a Basic (single-environment) project.	/	Agile
	CheckProjectHasDependency	Checks whether a project has dependencies, such as tasks.	Level 3	Agile
	GetProject	Gets the details of a project by its ID.	Level 1	Agile
	GetProjectByName	Gets the details of a project by its name.	Level 1	Agile
	AddProjectMember	Adds a project member. Note This operation can be performed by project administrators.	Level 2	Agile
	GetProjectWhiteLists	Gets the whitelist of a project.	Level 1	Agile
	UpdateDevProdProject	Updates a Dev-Prod (dual-environment) project.	/	Agile
	UpdateBasicProject	Updates a Basic (single-environment) project. The project name cannot be changed and must be provided in the request.	/	Agile
	ListProjectMembers	Lists project members.	Level 1	Agile
	ListProjects	Lists projects.	Level 1	Agile
	DeleteProject	Deletes a project. This operation applies to both Basic and Dev-Prod projects.	/	Agile
	RemoveProjectMember	Removes a project member. Note This operation can be performed by project administrators.	Level 2	Agile
	ReplaceProjectWhiteLists	Updates the whitelist of a project.	Level 3	Agile
	UpdateProjectMember	Updates a project member.	Level 2	Agile
	UpdateTenantComputeEngine	Updates the tenant's compute settings.	Level 3	Agile
Cluster	UploadDataSourceFile	Uploads a file and returns a `FileId` to be used when creating a data source or compute source.	/	Agile
	CreateComputeCluster	Creates a cluster.	/	Agile
	GetComputeCluster	Gets the details of a cluster.	/	Agile
	UpdateComputeCluster	Updates a cluster.	/	Agile
	DeleteComputeCluster	Deletes a cluster.	/	Agile
	ListComputeClusters	Lists clusters.	/	Agile

Knowledge graph

Group	API	Description	Throttling level	Minimum version
Knowledge graph	ExportKgSchema	Exports the metadata definition of a knowledge graph.	Level 3	Basic Edition
	ImportKgSchema	Imports a graph model definition.	Level 1	Basic Edition
	PublishKgSchema	Publishes a graph model.	Level 1	Basic Edition
	GetKgSchemaPublishResult	Returns the publish result of a graph model.	Level 3	Basic Edition
	CreateKgEntity	Creates an entity record in a knowledge graph.	Level 1	Basic Edition
	UpdateKgEntity	Updates an entity record in a knowledge graph.	Level 1	Basic Edition
	DeleteKgEntity	Deletes an entity record.	Level 1	Basic Edition
	GetKgEntity	Returns the details of an entity record in a knowledge graph.	Level 3	Basic Edition
	ListKgEntity	Returns a paginated list of entity records in a knowledge graph.	Level 3	Basic Edition
	BatchCreateKgEntity	Creates multiple entity records in a knowledge graph.	Level 1	Basic Edition
	ExecKgGremlin	Executes a custom Gremlin query.	/	Basic Edition
	GetKgAuthorizedWorkspaces	Returns a list of workspaces authorized to access the knowledge graph.	/	Basic Edition
	SearchKgBySemantic	Retrieves entity or relation records from a knowledge graph using semantic search.	/	Basic Edition
	CreateKgRelation	Creates a relation record in a knowledge graph.	Level 1	Basic Edition
	UpdateKgRelation	Updates a relation record in a knowledge graph.	Level 1	Basic Edition
	DeleteKgRelation	Deletes a relation record.	Level 1	Basic Edition
	GetKgRelation	Returns the details of a relation record in a knowledge graph.	Level 3	Basic Edition
	ListKgRelation	Returns a paginated list of relation records in a knowledge graph.	Level 3	Basic Edition
	BatchCreateKgRelation	Creates multiple relation records in a knowledge graph.	Level 1	Basic Edition
	ExecKgCypher	Executes a custom Cypher query.	Level 2	Basic Edition
	GetKgNeighbor	Returns the neighbor nodes of a specified node in the graph.	Level 3	Basic Edition