OpenAPI rate limits and version requirements

Updated at:

API rate limiting levels and Dataphin version requirements vary by feature.

Limits

  • RAM roles do not support calling OpenAPI.

  • To ensure application stability, Dataphin categorizes OpenAPI into three throttling levels: Level 1, Level 2, and Level 3. For details on throttling levels and API call quotas, see API call quotas for different Dataphin versions.

Permissions

  • The DataphinOpenAPIFullAccess system permission lets you call all OpenAPI operations.

  • The DataphinOpenAPIReadOnlyAccess system permission lets you call read-only OpenAPI operations.

Data development

Group

API name

Description

Rate limit

Minimum version

directory tree

CreateDirectory

Creates a directory in the directory tree for features 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 a file name.

Level 2

Agile Edition

UpdateFileDirectory

Moves a file to a different location in the directory tree.

Level 2

Agile Edition

GetDirectoryTree

Retrieves the directory tree of a folder.

Level 1

Agile Edition

ListFiles

Lists files in the 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

Retrieves the details of a business entity.

Level 1

Intelligent Edition

GetBizEntityInfoByVersion

Retrieves the details of 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

Retrieves the details of a business unit.

Level 3

Intelligent Edition

GetDataDomainInfo

Retrieves the details of a data domain.

Level 3

Intelligent Edition

ListBizUnits

Lists all 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 task.

Level 2

Agile Edition

GetAdHocTaskResult

Retrieves the result of an ad-hoc task.

Level 2

Agile Edition

ExecuteAdHocTask

Executes an ad-hoc task.

Level 2

Agile Edition

GetAdHocTaskLog

Retrieves the log of an ad-hoc task.

Level 1

Agile Edition

unstructured data

CreateWorkFlowByJson

Creates an unstructured 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

Retrieves a dataset.

Level 3

Basic Edition

ListDatasets

Lists datasets.

Level 3

Basic Edition

UpdateDataset

Updates a dataset.

Level 1

Basic Edition

execution record

ListOperationRecord

Retrieves a paginated list of execution records.

Level 2

Agile Edition

GetOperationRecordRunCode

Retrieves the code for an execution record.

Level 2

Agile Edition

GetOperationRecordById

Retrieves an execution record.

Level 2

Agile Edition

GetOperationRecordDetail

Retrieves the details of an execution record, including its log and result.

Level 1

Agile Edition

offline integration

CreatePipeline

Creates an integration pipeline or an unstructured workflow.

Level 3

Agile Edition

CreatePipelineByAsync

Asynchronously creates an integration pipeline or an unstructured workflow.

Level 3

Agile Edition

OfflinePipeline

Takes an integration pipeline offline.

Level 3

Agile Edition

OfflinePipelineByAsync

Asynchronously takes an integration pipeline offline.

Level 3

Agile Edition

GetPipelineAsyncResult

Retrieves the result of an asynchronous pipeline execution.

Level 1

Agile Edition

GetPipelineById

Retrieves an integration pipeline.

Level 1

Agile Edition

UpdatePipeline

Updates an integration pipeline.

Level 3

Agile Edition

UpdatePipelineByAsync

Asynchronously updates an integration pipeline.

Level 3

Agile Edition

batch task

GetOperationRecordRunCode

Retrieves the code for an execution 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

CreateBatchTask

Creates a batch task.

Level 3

Agile Edition

DeleteBatchTask

Deletes a batch task.

Level 3

Agile Edition

GetBatchTaskInfo

Retrieves the details of a batch task.

Level 1

Agile Edition

GetBatchTaskVersions

Retrieves a list of versions for a batch task.

Level 2

Agile Edition

GetBatchTaskUdfLineages

Retrieves the custom lineage of a batch task.

Level 2

Agile Edition

GetBatchTaskInfoByVersion

Retrieves the details of a specific version of a batch task.

Level 2

Agile Edition

OfflineBatchTask

Takes a batch task offline.

Level 3

Agile Edition

ParseBatchTaskDependency

Parses the logical table dependencies of a batch task.

Note

The result may include self-referencing nodes, where a node's upstream dependency is the node itself. You must handle these cases in your code.

Level 3

Agile Edition

UpdateBatchTaskUdfLineages

Updates the custom lineage of a batch task.

Level 3

Agile Edition

SubmitBatchTask

Submits a batch task.

Level 3

Agile Edition

UpdateBatchTask

Updates a batch task.

Level 3

Agile Edition

batch task template

ListBatchTemplates

Retrieves a paginated list of batch task templates.

Level 3

Agile Edition

GetBatchTemplateVersions

Retrieves a list of versions for a batch task template.

Level 3

Agile Edition

streaming job

GetStreamJobs

Retrieves streaming jobs.

Level 2

Basic Edition

GetQueueEngineVersionByEnv

Retrieves the engine version details for a cluster.

Level 2

Basic Edition

GetClusterQueueInfoByEnv

Retrieves the queue details for a cluster in an environment.

Level 2

Basic Edition

CreateStreamBatchJobMapping

Creates a unified stream-batch task.

Level 2

Basic Edition

resource

GetResource

Retrieves the details of a resource file.

Level 2

Agile Edition

GetResourceByVersion

Retrieves the details of a specific version of a resource file.

Level 2

Agile Edition

UpdateResource

Updates a resource file.

Level 2

Agile Edition

GetFileStorageCredential

Obtains temporary read/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

Retrieves the details of a user-defined function.

Level 2

Agile Edition

GetUdfByVersion

Retrieves the 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

Retrieves the details of the latest submission record.

Level 2

Basic Edition

ListSubmitRecords

Retrieves a paginated list of submission records.

Level 2

Basic Edition

ListPublishRecords

Retrieves a paginated list of publish records.

Level 2

Basic Edition

PublishObjectList

Publishes objects in a batch.

Level 2

Basic Edition

O&M Center

Group

API

Description

Rate limit level

Minimum version requirement

Instance O&M

FixData

Reruns data to correct errors. Forcibly rerunning affected downstream tasks incurs computing costs and alters data output.

Level 2

Agile Edition

GetInstanceDownStream

Retrieves the downstream instances for a specified instance.

Level 2

Agile Edition

GetInstanceUpDownStream

Retrieves the upstream and downstream instances of an instance. This API supports logical tables and code tasks.

Level 2

Agile Edition

OperateInstance

Performs batch operations on instances. This API supports physical instances and logical table instances.

Level 2

Agile Edition

GetSupplementDagrunInstance

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

Level 1

Agile Edition

GetPhysicalInstance

Retrieves instance information.

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 of a node.

Level 2

Agile Edition

ExecuteManualNode

Runs a manual task.

Note
  • This operation creates a manual scheduling node, which affects related tables.

  • Running the task incurs computing and storage costs.

Level 2

Agile Edition

GetOperationSubmitStatus

Retrieves the submission status of a supplement data 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

Queries the code content of a scheduling node.

Level 1

Agile Edition

GetPhysicalNodeOperationLog

Queries the operation log of a node.

Level 1

Agile Edition

GetSupplementDagrun

Retrieves the list of Dagruns for a supplement data workflow.

Level 1

Agile Edition

ListNodeDownStream

Lists downstream nodes. You can use the results as a reference when creating a supplement data workflow.

Level 2

Agile Edition

ListNodes

Queries a list of scheduling nodes.

Level 1

Agile Edition

PausePhysicalNode

Pauses the scheduling of a physical node. A successful call pauses task scheduling and prevents downstream tasks from being triggered. This API currently 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

A general-purpose API for supplementing data. It supports both list and massive modes.

Note
  • This operation creates supplement data instances and can affect data output for related tables.

  • Running the task incurs computing and storage costs.

Level 2

Agile Edition

GetDevObjectDependency

Queries the upstream dependencies of an object in the development state.

Level 2

Agile Edition

ExecuteTriggerNode

Runs a trigger node.

Agile Edition

GetPhysicalNodeByOutputName

Queries a physical node by its output name. This API 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

Lists alert events that match specified criteria.

Level 1

Agile Edition

ListAlertNotifications

Lists notification records that match specified criteria.

Level 1

Agile Edition

Data permissions

Group

API

Description

Rate limit level

Minimum version

Permission management

CheckResourcePermission

Checks whether a user has permissions to a specified resource.

Level 2

Agile Edition

GrantResourcePermission

Grants a user permissions to a resource.

Note

Only a super administrator and a resource owner (project administrator or data source administrator) can call this API. This API currently supports tables and data sources.

Level 2

Agile Edition

RevokeResourcePermission

Revokes a user's resource permissions.

Note

Only a super administrator and a resource owner (project administrator or data source administrator) can call this API. This API currently supports tables and data sources.

Level 2

Agile Edition

Data assets

Group

API

Description

Throttling level

Edition

Asset

GetTableLineageByTaskId

Retrieves table lineage.

Level 2

Agile Edition

GetTableColumnLineageByTaskId

Retrieves the column lineage for a table.

Level 2

Agile Edition

AddRegisterLineage

Adds a registered lineage.

Level 2

Agile Edition

DeleteRegisterLineage

Deletes a registered lineage.

Level 2

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

Retrieves the details of a business metric.

Level 2

Agile Edition

ListCatalogAssets

Queries assets in the asset catalog. This operation supports both exact match and fuzzy search.

Level 2

Agile Edition

GetCatalogAssetDetails

Retrieves the details of an asset in the asset catalog.

Level 2

Agile Edition

GetTableLineages

Retrieves the table lineage for an asset.

/

Agile Edition

GetBelongAssetMapping

Queries mapping relationships by the parent asset's GUID.

/

Agile Edition

GetAssetMappingRelations

Queries mapping relationships by asset GUID.

/

Agile Edition

ListTables

Retrieves a paginated list of asset table metadata.

/

Agile Edition

GetTableColumnLineages

Retrieves the column lineage for an asset table.

/

Agile Edition

GetTableColumns

Retrieves the columns of a Dataphin table. Supported table types include: dimension logical tables, fact logical tables, summary logical tables, tag logical tables, logical table views, physical tables, physical views, and materialized views.

/

Enterprise Edition

Data standards

UpdateStandardWordRoot

Updates a standard word root.

/

Basic Edition

CreateStandardWordRoot

Creates a standard word root.

/

Basic Edition

CreateStandardTemplate

Creates a data standard template.

/

Basic Edition

CreateStandardSet

Creates a standard set.

/

Basic Edition

CreateStandardRelations

Creates relationships for a data standard.

/

Basic Edition

CreateStandardMapping

Creates mapping relationships for a data standard, including both valid and invalid mappings.

/

Basic Edition

CreateStandardLookupTable

Creates a lookup table for a data standard.

/

Basic Edition

CreateStandard

Creates a data standard.

/

Basic Edition

ListStandards

Retrieves a paginated list of data standards.

/

Basic Edition

GetStandardWordRoot

Retrieves the details of a standard word root.

/

Basic Edition

GetStandardTemplate

Retrieves the details of a data standard template.

/

Basic Edition

GetStandardStatistics

Queries the count of data standards in a directory, grouped by standard type.

/

Basic Edition

GetStandardSet

Retrieves the details of a standard set.

/

Basic Edition

GetStandardLookupTable

Retrieves the details of a lookup table for a data standard.

/

Basic Edition

GetStandard

Retrieves 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 a standard mapping relationship as invalid.

/

Basic Edition

UpdateStandardLookupTable

Updates a lookup table for a data standard.

/

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 standard word root.

/

Basic Edition

DeleteStandardValidMapping

Deletes a valid mapping relationship.

/

Basic Edition

DeleteStandardSet

Deletes a standard set.

/

Basic Edition

DeleteStandardRelations

Deletes data standard relationships in a batch.

/

Basic Edition

DeleteStandardLookupTable

Deletes a lookup table for a data standard.

/

Basic Edition

DeleteStandardInValidMapping

Deletes an invalid mapping relationship.

/

Basic Edition

DeleteStandard

Deletes a data standard.

/

Basic Edition

Data quality

AssignQualityRuleOfAllRuleScopeSchedules

Binds a quality rule to schedule settings.

/

Basic Edition

ListQualityWatches

Retrieves a paginated list of data quality watches.

/

Basic Edition

ListQualityWatchTasks

Retrieves a paginated list of data quality watch tasks.

/

Basic Edition

ListQualityTemplates

Retrieves a paginated list of quality templates.

/

Basic Edition

ListQualityRules

Retrieves a paginated list of quality rules.

/

Basic Edition

ListQualityRuleTasks

Retrieves a paginated list of quality rule tasks.

/

Basic Edition

GetQualityWatchTaskLog

Retrieves the logs for a monitoring task.

/

Basic Edition

GetQualityWatchTask

Retrieves a monitoring task.

/

Basic Edition

GetQualityWatchByObjectId

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

/

Basic Edition

GetQualityWatch

Retrieves a data quality watch.

/

Basic Edition

GetQualityTemplate

Retrieves a quality template.

/

Basic Edition

GetQualitySchedulesByWatchId

Retrieves a list of schedule settings by the monitoring object ID.

/

Basic Edition

GetQualitySchedule

Retrieves a quality schedule.

/

Basic Edition

GetQualityRuleTaskLog

Retrieves the logs for a quality task.

/

Basic Edition

GetQualityRuleTask

Retrieves the details of a quality task.

/

Basic Edition

GetQualityRule

Retrieves a quality rule.

/

Basic Edition

GetQualityAlertOfAllRuleScopeByWatchId

Retrieves the alert settings by the monitoring object ID.

/

Basic Edition

UpsertQualityWatchAlert

Creates or updates the alert settings for a monitoring object.

/

Basic Edition

UpsertQualityWatch

Creates or updates a quality watch. This operation supports various object types, including Dataphin tables, global tables, data sources, metrics, and real-time metatables.

/

Basic Edition

UpsertQualityTemplate

Creates or updates a quality template.

/

Basic Edition

UpsertQualitySchedule

Creates or updates schedule settings.

/

Basic Edition

UpsertQualityRule

Creates or updates a quality rule.

/

Basic Edition

UpdateQualityWatchSwitch

Enables or disables data quality watches in a batch.

/

Basic Edition

UpdateQualityRuleSwitch

Enables or disables quality rules in a batch.

/

Basic Edition

SubmitQualityWatchTasks

Submits validation tasks for monitoring objects in a batch.

/

Basic Edition

SubmitQualityRuleTasks

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

/

Basic Edition

RemoveQualityRuleSchedules

Unbinds quality rules from schedules in a batch.

/

Basic Edition

DeleteQualityWatches

Deletes data quality watches in a batch.

/

Basic Edition

DeleteQualityTemplates

Deletes quality templates in a batch.

/

Basic Edition

DeleteQualitySchedules

Deletes quality schedules in a batch.

/

Basic Edition

DeleteQualityRules

Deletes quality rules in a batch.

/

Basic Edition

UpdateSecurityLevel

Updates a data classification level.

/

Basic Edition

UpdateSecurityIdentifyResultStatus

Updates the 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 classification 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

ListSecurityIdentifyResults

Retrieves a paginated list of security identification results.

/

Basic Edition

ListSecurityIdentifyRecords

Retrieves a paginated list of identification records for security results.

/

Basic Edition

GetSecuritySecretKey

Retrieves a secret key value by its name.

/

Basic Edition

GetSecurityLevel

Retrieves the details of a data classification level.

/

Basic Edition

GetSecurityIdentifyResult

Retrieves the details of a security identification result.

/

Basic Edition

GetSecurityClassify

Retrieves the details of a data classification.

/

Basic Edition

DeleteSecurityLevel

Deletes a data classification level.

/

Basic Edition

DeleteSecurityIdentifyResults

Deletes security identification results in a batch.

/

Basic Edition

DeleteSecurityClassifyCatalog

Deletes a data classification catalog.

/

Basic Edition

DeleteSecurityClassify

Deletes a data classification.

/

Basic Edition

Data service

Group

OpenAPI name

Description

Rate limit 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 API documentation.

Level 2

Agile Edition

ListApiByApp

Retrieves a list of APIs by application.

Level 1

Agile Edition

ListAuthorizedDataServiceApiDetails

Retrieves the authorized API fields for an application.

Level 1

Agile Edition

API authorization

GrantDataServiceApi

Authorizes a data service API.

Level 3

Agile Edition

RevokeDataServiceApi

Revokes authorization for a data service API.

Level 3

Agile Edition

ApplyDataServiceApi

Requests permissions for a data service API.

Level 2

Agile Edition

ListDataServiceMyApiPermissions

Retrieves a list of API permissions managed by the current user.

Level 1

Agile Edition

Application management

ListDataServiceApps

Retrieves a list of all applications for a 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 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 in a group.

Level 1

Agile Edition

Application group

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 a list of applications in a group that the current user is authorized to access.

Level 1

Agile Edition

Application member

GetDataServiceAppMembers

Retrieves a list of application members.

Level 2

Agile Edition

AddDataServiceAppMember

Adds a member to an application.

Level 3

Agile Edition

UpdateDataServiceAppMember

Updates an application member.

Level 3

Agile Edition

RemoveDataServiceAppMember

Removes a member from an application.

Level 3

Agile Edition

GetDataServiceAppAuthorizedUsers

Retrieves a list of users authorized to access an application.

Level 1

Agile Edition

Project management

GetDataServiceMyProjects

Retrieves projects owned by the current user.

Level 1

Agile Edition

GetDataServiceAuthorizedProjects

Retrieves projects the current user is authorized to access.

Level 1

Agile Edition

GetDataServiceProjectAddableUsers

Retrieves a list of users who can be added 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 a list of application permissions managed by the current user.

Level 1

Agile Edition

ListDataServiceAuthorizedApps

Retrieves a list of applications that the current user is authorized to access.

Level 1

Agile Edition

O&M and monitoring

GetDataServiceApiCallTrend

Analyzes API access trends.

Level 1

Agile Edition

GetDataServiceApiCallSummary

Retrieves a summary of API call statistics.

Level 1

Agile Edition

ListDataServiceApiCallStatistics

Retrieves API call statistics for operational analysis.

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 the impact of API errors.

Level 2

Agile Edition

Platform management

Group

OpenAPI name

Description

API throttling level

Minimum version requirement

User and authorization

TransferOwnershipForAllObject

Transfers ownership of all objects in a single operation.

Level 3

Agile Edition

RetryTransferOwnership

Retries a failed ownership transfer task.

Level 3

Agile Edition

GetTransferInfo

Retrieves the progress of an ownership transfer task by its ID.

Level 2

Agile Edition

SyncDepartment

Synchronizes department information.

/

Agile Edition

SyncDepartmentUser

Synchronizes department member information.

/

Agile Edition

AddTenantMembers

Adds users to a tenant in batches.

Note

Only a super administrator or system administrator can call this API.

Level 3

Agile Edition

AddTenantMembersBySourceUser

Adds members to a tenant by using source user accounts.

Level 2

Agile Edition

AddUserGroupMember

Adds members to a user group.

Level 2

Agile Edition

ListResourcePermissionOperationLog

Lists permission operation logs.

Level 3

Agile Edition

ListResourcePermissions

Lists permission grant records.

Level 3

Agile Edition

GetProjectProduceUser

Retrieves the production account of a project.

Note

Only a super administrator can call this API.

Level 1

Agile Edition

CreateUserGroup

Creates a user group.

Level 3

Basic Edition

DeleteUserGroup

Deletes a user group.

Level 3

Basic Edition

GetUserBySourceId

Retrieves the details of a user by their source ID.

Level 1

Agile Edition

GetUserGroup

Retrieves the details of a user group.

Level 1

Basic Edition

GetUsers

Retrieves the details of one or more users by user ID.

Level 1

Agile Edition

ListAddableRoles

Retrieves 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 Edition

ListAddableUsers

Queries the users that can be added to a tenant.

Note

Only a super administrator or system administrator can call this API.

Level 1

Agile Edition

ListTenantMembers

Lists tenant members.

Level 1

Agile Edition

ListUserGroups

Lists user groups.

Level 1

Basic Edition

ListUserGroupMembers

Lists user group members.

Level 1

Basic Edition

RemoveTenantMember

Removes a member from a tenant.

Note

Only a super administrator or system administrator can call this API.

Level 2

Agile Edition

RemoveUserGroupMember

Removes a member from a user group.

Level 2

Basic Edition

UpdateTenantMember

Updates a tenant member.

Note

Only a super administrator or system administrator can call this API.

Level 2

Agile Edition

UpdateUserGroup

Updates a user group.

Level 3

Basic Edition

UpdateUserGroupSwitch

Enables or disables a user group.

Level 3

Basic Edition

GetMyTenants

Retrieves the current user's tenants.

Level 1

Agile Edition

GetMyRoles

Retrieves the current user's roles.

Level 1

Agile Edition

Row-level security

DeleteRowPermission

Deletes a row-level security policy.

Level 3

Agile Edition

GetAccountByRowPermissionId

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

Level 3

Agile Edition

ListRowPermission

Lists row-level security policies.

Level 3

Agile Edition

ListRowPermissionByUserId

Lists row-level security policies for a specified user.

Level 3

Agile Edition

UpdateRowPermission

Updates a row-level security policy.

Level 3

Agile Edition

CreateRowPermission

Creates a row-level security policy.

Level 3

Agile Edition

GetRowPermissionByTableGuids

Retrieves row-level security policies by table GUIDs.

Level 3

Agile Edition

Compute source

CheckComputeSourceConnectivity

Checks the connectivity of a compute source.

Level 3

Agile Edition

CheckComputeSourceConnectivityById

Checks the connectivity of an existing compute source by its ID.

Level 3

Agile Edition

ListComputeSources

Lists compute sources.

Level 2

Agile Edition

UpdateComputeSource

Updates a compute source. Business segment administrators and project administrators can perform this operation.

Level 3

Agile Edition

GetComputeSource

Retrieves the details of a compute source by its ID.

Level 2

Agile Edition

DeleteComputeSource

Deletes a compute source.

Level 3

Agile Edition

CreateComputeSource

Creates a compute source.

Note

Business segment administrators and project administrators can perform this operation.

Level 3

Agile Edition

GetSparkLocalClientInfo

Retrieves the Spark client information for the cluster associated with a compute source.

Level 2

Agile Edition

Data source

GetDataSourceDependencies

Queries the integration tasks and database SQL tasks affected by a data source change.

Level 3

Agile Edition

CheckDataSourceConnectivity

Checks the connectivity of a data source.

Level 3

Agile Edition

CheckDataSourceConnectivityById

Checks the connectivity of a data source by its ID.

Level 3

Agile Edition

CreateDataSource

Creates a data source.

Note

Tenant administrators, data administrators, business segment administrators, project administrators, and operations administrators can perform this operation.

Level 3

Agile Edition

DeleteDataSource

Deletes a data source.

Note

Tenant administrators, data administrators, business segment administrators, project administrators, and operations administrators can perform this operation.

Level 3

Agile Edition

UpdateDataSourceBasicInfo

Updates the basic information of a data source.

Note

Tenant administrators, data administrators, business segment administrators, project administrators, and operations administrators can perform this operation.

Level 3

Agile Edition

UpdateDataSourceConfig

Updates the connection configuration of a data source.

Note

Tenant administrators, data administrators, business segment administrators, project administrators, and operations administrators can perform this operation.

Level 3

Agile Edition

ListDataSourceWithConfig

Lists data sources and their configurations.

Level 2

Agile Edition

GetCheckConnectivityJobs

Retrieves the history of data source connectivity tests.

Level 3

Agile Edition

Project

CheckProjectHasDependency

Checks whether a project has data dependencies, such as tasks.

Level 3

Agile Edition

GetProject

Retrieves the details of a project by its ID.

Level 1

Agile Edition

GetProjectByName

Retrieves the details of a project by its name.

Level 1

Agile Edition

AddProjectMember

Adds a member to a project.

Note

Project administrators can call this API.

Level 2

Agile Edition

GetProjectWhiteLists

Retrieves the project whitelist.

Level 1

Agile Edition

ListProjectMembers

Lists project members.

Level 1

Agile Edition

ListProjects

Lists projects.

Level 1

Agile Edition

RemoveProjectMember

Removes a member from a project.

Note

Project administrators can call this API.

Level 2

Agile Edition

ReplaceProjectWhiteLists

Replaces the project whitelist.

Level 3

Agile Edition

UpdateProjectMember

Updates a project member.

Level 2

Agile Edition

UpdateTenantComputeEngine

Updates the tenant's compute engine.

Level 3

Agile Edition