tencent cloud

All product documents
Cloud Access Management
DocumentationCloud Access ManagementCAM-Enabled APIBig DataData Lake Compute
Data Lake Compute
Download PDF
Last updated: 2025-03-26 09:58:34
Data Lake Compute
Last updated: 2025-03-26 09:58:34
Download PDF

Fundamental information

Product Abbreviation in CAM Console Authorization by Tag Authorization Granularity IP Restriction
Data Lake Compute dlc Supported Supported Resource level Partially supported

Note：

The authorization granularity of cloud products is divided into three levels: service level, operation level, and resource level, based on the degree of granularity.

  • Service level: It defines whether a user has the permission to access the service as a whole. A user can have either full access or no access to the service. For the authorization granularity of cloud products at service level, the authorization of specific APIs are not supported.
  • Operation level: It defines whether a user has the permission to call a specific API of the service. For example, granting an account read-only access to the CVM service is an authorization at the operation level.
  • Resource level: It is the finest authorization granularity which defines whether a user has the permission to access specific resources. For example, granting an account read/write access to a specific CVM instance is an authorization at the resource level.

API authorization granularity

Two authorization granularity levels of API are supported: resource level, and operation level.

  • Resource level: It supports the authorization of a specific resource.
  • Operation level: It does not support the authorization of a specific resource. If the policy syntax restricts a specific resource during authorization, CAM will determine that this API is not within the scope of authorization, and deem it as unauthorized.

Write operations

API API Description Authorization Granularity Six-segment Resource Description IP Restriction
AddColumns Add Columns Operation level * Supported
AddCvmToPool Add cvm to the resource pool Operation level * Supported
AddDMSPartitions Add partitions Operation level * Supported
AddExistedInstancesToHouse add cvm to house Operation level * Supported
AddPartitionField this interface(AddPartitionField) use to add partition on field Operation level * Supported
AddRoleArn Add Role Arn Operation level * Supported
AddSparkImage set spark image info Operation level * Supported
AddSparkImageUserRecords add user record for spark image. Operation level * Supported
AddTasks add task into scheduler Operation level * Supported
AddUsersToWorkGroup AddUsersToWorkGroup Operation level * Supported
AddWhiteStrategy AddWhiteStrategy Operation level * not supported
AlterDLCTable Alter DLC Table Operation level * Supported
AlterDMSDatabase Alter DMS Database. Operation level * Supported
AlterDMSPartition Alter partition Operation level * Supported
AlterDMSPartitionColumnStatistic Alter Partition Column Statistic. Operation level * Supported
AlterDMSTable Alter table Operation level * Supported
AlterDMSTableColumnStatistic Alter Table Column Statistic. Operation level * Supported
AlterMetaKeyConstraint AlterMetaKeyConstraint Operation level * not supported
AlterTableComment Alter Table Comment Operation level * Supported
AlterTableProperties AlterTableProperties Operation level * Supported
ApplyCvm Apply for cvm to join tke Operation level * Supported
AssociateDatasourceHouse AssociateDatasourceHouse Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
AssociateEGDatasource Associate EG Datasource Operation level * Supported
AttachDataMaskPolicy Attach Data Mask Policy Operation level * Supported
AttachDatasourcePolicy AttachDatasourcePolicy Operation level * not supported
AttachUserDatasourcePolicy Attach user datasource policy Operation level * Supported
AttachUserPolicy AttachUserPolicy Operation level * Supported
AttachUsersPolicy AttachUsersPolicy Operation level * not supported
AttachWorkGroupDatasourcePolicy Attach workg group datasource policy Operation level * Supported
AttachWorkGroupPolicy AttachWorkGroupPolicy Operation level * Supported
BindDataEngineTcr Bind DataEngine and Tcr Operation level * Supported
BindDefaultSharedEngine BindDefaultSharedEngine Operation level * Supported
BindRoleUser Bind Role User Operation level * Supported
BindTagsToDataEngines BindTagsToDataEngines Operation level * Supported
BindWorkGroupsToUser BindWorkGroupsToUser Operation level * Supported
CancelNotebookSessionStatement CancelNotebookSessionStatement Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CancelNotebookSessionStatementBatch Cancel Notebook Session Statement Batch Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CancelSparkSessionBatchSQL Cancel Spark Session Batch SQL Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CancelTableProperties Cancel Table Properties. Operation level * Supported
CancelTask CancelTask Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CancelTasks CancelTasks Operation level * Supported
ChangeLocationAllocator ChangeLocationAllocator Operation level * Supported
CloseOrOpenSQLSessionSnapshot This interface (CloseOrOpenSQLSessionSnapshot) use to close or open sql session snapshot Operation level * Supported
CloseSQLSessionsSnapshot Close SQL Sessions Snapshot Operation level * Supported
CopyDLCTable DLC Copy Table Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateCHDFSBindingProduct CreateCHDFSBindingProduct Operation level * Supported
CreateCHDFSProduct Create chdfs bucket binding product Operation level * Supported
CreateCloudProductBinding Create a new cloud product CHDFS permission binding Operation level * Supported
CreateDLCTable Create DLC Table Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateDMSDatabase Create Database Operation level * Supported
CreateDMSTable Create DMS Table Operation level * Supported
CreateDataEngine Create a data engine Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateDataMaskStrategy Create data mask strategy Operation level * Supported
CreateDatabase CreateDatabase Operation level * Supported
CreateDatasourceConnection CreateDatasourceConnection Operation level * Supported
CreateDefaultDatasourceConnection CreateDefaultDatasourceConnection Operation level * not supported
CreateEngineNetwork CreateEngineNetwork Operation level * Supported
CreateExportResultTask This interface (CreateExportResultTask) is used to export SQL query results Operation level * Supported
CreateExportTask This interface (CreateExportTask) is used to create export tasks Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateImportTask This interface (CreateImportTask) is used to create import tasks Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateInternalTable Create managed storage internal table Operation level * Supported
CreateKernelArgs create kernel config Operation level * Supported
CreateKyuubiTask Create Kyuubi Task Operation level * Supported
CreateLakeFs CreateLakeFs Operation level * Supported
CreateLakeFsChdfsBinding CreateLakeFsChdfsBinding Operation level * Supported
CreateLink create link between two tasks Operation level * Supported
CreateMetaDatabase Create metabase Operation level * Supported
CreateNativeEngineTask CreateNativeEngineTask Operation level * not supported
CreateNotebookSession CreateNotebookSession Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateNotebookSessionStatement CreateNotebookSessionStatement Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateNotebookSessionStatementSupportBatchSQL Create Notebook Session Statement Support Batch SQL Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateResultDownload Create Result Download Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateSQLSessionCatalog CreateSQLSessionCatalog Operation level * Supported
CreateSQLSessionSnapshot Create SQL session snapshot Operation level * Supported
CreateSQLSessionSubmitRecord Create SQL session submit record Operation level * Supported
CreateScheduleTask CreateScheduleTask Operation level * Supported
CreateScript CreateScript Operation level * Supported
CreateSparkApp create spark application Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateSparkAppTask create spark application Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateSparkSessionBatchSQL Create Spark Session Batch SQL Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateSparkSubmitTask Create Spark Submit Task. Operation level * Supported
CreateStandardEngineResourceGroup Create a standard engine resource group Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateStoreLocation CreateStoreLocation Operation level * Supported
CreateTable CreateTable Operation level * Supported
CreateTableLifecycleTask CreateTableLifecycleTask Operation level * Supported
CreateTask create task Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateTaskToGetMetaInfoByMq Create Task To Get Meta Info By Mq Operation level * Supported
CreateTasks Create tasks Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateTasksCompressJob Create Tasks Compress Job Operation level * Supported
CreateTcIcebergTable create TC-Iceberg table Operation level * Supported
CreateUser CreateUser Operation level * Supported
CreateUserRole create user role Operation level * Supported
CreateUserVpcConnection CreateUserVpcConnection Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CreateUsers CreateUsers Operation level * Supported
CreateWorkGroup CreateWorkGroup Operation level * Supported
CreateWorkflow create a workflow Operation level * Supported
DeleteCHDFSBindingProduct DeleteCHDFSBindingProduct Operation level * Supported
DeleteCHDFSProduct Delete chdfs bucket bounding product Operation level * Supported
DeleteCloudProductCHDFSBinding Unbinding CHDFS permissions for cloud products Operation level * Supported
DeleteColumns This interface (DeleteColumns) is used to delete columns Operation level * Supported
DeleteDataEngine Delete data engine Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DeleteDataMaskStrategy Delete data mask strategy Operation level * Supported
DeleteDatabaseUDF delete udf in database Operation level * not supported
DeleteDatasourceConnection DeleteDatasourceConnection Operation level * Supported
DeleteEngineNetwork DeleteEngineNetwork Operation level * Supported
DeleteKernelArgs delete kernel config Operation level * Supported
DeleteLakeFs DeleteLakeFs Operation level * Supported
DeleteLakeFsChdfsBinding DeleteLakeFsChdfsBinding Operation level * Supported
DeleteLink delete link between two tasks Operation level * Supported
DeleteMetaDatabase Delete metabase Operation level * Supported
DeleteNotebookSession DeleteNotebookSession Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DeletePartitionField this interface(DeletePartitionField) use to delete partition on field Operation level * Supported
DeleteReserve Delete reservation Operation level * Supported
DeleteSQLSessionCatalog DeleteSQLSessionCatalog Operation level * Supported
DeleteSQLSessionSnapshot Delete SQL session snapshot Operation level * Supported
DeleteScheduleTask DeleteScheduleTask Operation level * Supported
DeleteScript delete script Operation level * Supported
DeleteSparkApp delete spark application Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DeleteSparkImage delete spark image. Operation level * Supported
DeleteSparkImageUserRecords delete spark image user records. Operation level * Supported
DeleteStandardEngineResourceGroup Delete the standard engine resource group Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DeleteTable Delete Table Operation level * Supported
DeleteTableBatch Delete Table Batch. Operation level * Supported
DeleteThirdPartyAccessUser DeleteThirdPartyAccessUser Operation level * Supported
DeleteUDF delete udf Operation level * Supported
DeleteUser DeleteUser Operation level * Supported
DeleteUserRole delete user role Operation level * Supported
DeleteUserVpcConnection DeleteUserVpcConnection Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DeleteUsersFromWorkGroup DeleteUsersFromWorkGroup Operation level * Supported
DeleteView Delete View Operation level * Supported
DeleteWorkGroup DeleteWorkGroup Operation level * Supported
DeleteWorkflow delete scheduler Operation level * Supported
DescribeReserve Query reservation order Operation level * Supported
DestroyCvm Destroy CVM Operation level * Supported
DetachDataMaskPolicy Detach Data Mask Policy Operation level * not supported
DetachUserPolicy DetachUserPolicy Operation level * Supported
DetachWorkGroupPolicy DetachWorkGroupPolicy Operation level * Supported
DisassociateCHDFSAccessGroups DisassociateCHDFSAccessGroups Operation level * Supported
DropDLCTable Drop DLC Table Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DropDMSDatabase Drop database Operation level * Supported
DropDMSPartitionColumnStatistic Drop Partition Column Statistic. Operation level * Supported
DropDMSPartitions Drop DMS Partitions. Operation level * Supported
DropDMSTable Drop DMS Table. Operation level * Supported
DropDMSTableColumnStatistic Drop Table Column Statistic. Operation level * Supported
ForceSuccessScheduleTaskInstances ForceSuccessScheduleTaskInstances Operation level * Supported
FreezeScheduleTasks FreezeScheduleTasks Operation level * Supported
GrantDLCCatalogAccess Grant DLC Catalog Access Operation level * Supported
InferInternalTableSchema Infer the internal table data format Operation level * Supported
InitializeDLC InitializeDLC Operation level * Supported
KillScheduleTaskInstances KillScheduleTaskInstances Operation level * Supported
LaunchStandardEngineResourceGroups Start standard engine resource groups in batches Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
LockMetaData LockMetaData Operation level * Supported
MigrateDatasourceConnection MigrateDatasourceConnection Operation level * Supported
ModifyAdvancedStoreLocation modify advanced config for sql query Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} not supported
ModifyCHDFSMountPointAssociateInfo ModifyCHDFSMountPointAssociateInfo Operation level * Supported
ModifyCHDFSMountPointSuperuser Modify bucket Superuser Operation level * Supported
ModifyCHDFSProduct Modify chdfs bucket binding product Operation level * Supported
ModifyCloudProductBinding Modify the CHDFS permission binding of cloud products Operation level * Supported
ModifyDLCTable modify dlc table Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
ModifyDataEngineDescription Modify DataEngine Description Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
ModifyDatabaseUDF modify udf info Operation level * not supported
ModifyDatasourceConnection ModifyDatasourceConnection Operation level * Supported
ModifyGovernEventRule ModifyGovernEventRule Operation level * Supported
ModifyMetaDatabase Modify metabase Operation level * Supported
ModifySQLSessionCatalog ModifySQLSessionCatalog Operation level * Supported
ModifySQLSessionSnapshot ModifySQLSessionSnapshot Operation level * Supported
ModifyScheduleTask ModifyScheduleTask Operation level * Supported
ModifyScheduleTaskExecuteInfo Modify Schedule Task Execute Info Operation level * Supported
ModifySparkApp update spark application Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
ModifySparkAppBatch Modify SparkApp Batch Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
ModifySparkImage modify spark image info. Operation level * Supported
ModifyUser ModifyUser Operation level * Supported
ModifyUserAlias Modify User Alias Operation level * Supported
ModifyUserType Modify user type Operation level * Supported
ModifyUserUseScene ModifyUserUseScene Operation level * Supported
ModifyWorkGroup ModifyWorkGroup Operation level * Supported
PauseStandardEngineResourceGroups Pause standard engine resource groups in batches Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
RegisterThirdPartyAccessUser RegisterThirdPartyAccessUser Operation level * Supported
RemoveTask remove task from workflow canvas Operation level * Supported
RenewDataEngine Renew data engine Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
RenewHouse RenewHouse Operation level * not supported
ReportHeartbeatMetaData ReportHeartbeatMetaData Operation level * Supported
RerunScheduleTaskInstances RerunScheduleTaskInstances Operation level * Supported
ReserveResources Early resources Operation level * Supported
RestartDataEngine Restart DataEngine Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
RestartStandardEngineResourceGroups Batch restart the resource group of standard engines Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
RestartStandardEngineSessions Batch restart the resource group of the standard engine Operation level * not supported
ReturnCvm Return cvm Operation level * Supported
RevokeDLCCatalogAccess Revoke DLC Catalog Access Operation level * Supported
RollbackDataEngineImage Rollback DataEngine Image Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
RunScheduleTask RunScheduleTask Operation level * Supported
SavePosition save task position in canvas Operation level * Supported
SetTableProperties Set Table Properties. Operation level * Supported
StopScheduleTasks StopScheduleTasks Operation level * Supported
SupplementData SupplementData Operation level * Supported
SuspendResumeDataEngine This interface is used to control the pause or resume of the data engine Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
SwitchDataEngine Switch DataEngine Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
SwitchDataEngineImage Switch DataEngine Image Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
UnbindWorkGroupsFromUser UnbindWorkGroupsFromUser Operation level * Supported
UnboundDatasourceHouse UnboundDatasourceHouse Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
UnlockMetaData UnlockMetaData Operation level * Supported
UpdateDataEngine This interface is used to update the data engine configuration Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
UpdateDataEngineBasicConfiguration Update DataEngine Basic Configuration Operation level * Supported
UpdateDataEngineConfig Update Data Engine Config Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
UpdateDataMaskStrategy Update data mask strategy Operation level * Supported
UpdateDatasourceConnection UpdateDatasourceConnection Operation level * not supported
UpdateEngineNetworkName UpdateEngineNetworkName Operation level * Supported
UpdateEngineResourceGroupNetworkConfigInfo Update the standard engine resource group network configuration information Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
UpdateNativeEngineTask UpdateNativeEngineTask Operation level * not supported
UpdateNetworkConnection UpdateNetworkConnection Operation level * Supported
UpdateRoleSwitch Update Role Switch Operation level * Supported
UpdateRowFilter UpdateRowFilter Operation level * Supported
UpdateStandardEngineResourceGroupBaseInfo Update the basic information of the standard engine resource group Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
UpdateStandardEngineResourceGroupConfigInfo Update standard engine resource group parameter configuration information Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
UpdateStandardEngineResourceGroupResourceInfo Update standard engine resource group resource information Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
UpdateTaskStatus Update Task Status Operation level * Supported
UpdateTaskStatusToGetMetaInfoByMq Update Task Status To Get Meta Info By Mq Operation level * Supported
UpdateUserDataEngineConfig Update User DataEngine Config Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
UpdateUserRole update user role Operation level * Supported
UpdateWorkflow update workflow info Operation level * Supported
UpgradeDataEngineImage Upgrade DataEngine Image Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported

Read operations

API API Description Authorization Granularity Six-segment Resource Description IP Restriction
AddLakeFsChdfsBinding Add chdfs permission group Operation level * Supported
AssignMangedTableProperties AssignMangedTableProperties Operation level * Supported
CheckDLCResourceRole CheckDLCResourceRole Operation level * not supported
CheckDataEngineImageCanBeRollback Check DataEngine Image Can Be Rollback Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CheckDataEngineImageCanBeUpgrade Check DataEngine Image Can Be Upgrade Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CheckDataMaskStrategyNameExist CheckDataMaskStrategyNameExist Operation level * Supported
CheckDatabaseExists This interface (CheckDatabaseExists) use to check database exists Operation level * Supported
CheckDatabaseUDFExists This interface (CheckDatabaseUDFExists) use to check udf exits Operation level * Supported
CheckDatasourceConnectivity CheckDatasourceConnectivity Operation level * Supported
CheckGrantedPermission Checking Grant Permission Operation level * Supported
CheckLakeFsChdfsEnable CheckLakeFsChdfsEnable Operation level * Supported
CheckLakeFsExist CheckLakeFsExist Operation level * Supported
CheckLockMetaData CheckLockMetaData Operation level * Supported
CheckPermission Check Permission Operation level * Supported
CheckRegionCHDFSEnable CheckRegionCHDFSEnable Operation level * Supported
CheckSQLSessionCatalogNameExists CheckSQLSessionCatalogNameExists Operation level * Supported
CheckSQLSessionChanged Check SQL Session Is Changed Operation level * Supported
CheckScheduleScriptExist CheckScheduleScriptExist Operation level * Supported
CheckScheduleTaskNameExists CheckScheduleTaskNameExists Operation level * Supported
CheckSparkImageExists check spark image is exists. Operation level * Supported
CheckSparkImageUserRecordExists check exists spark image user record. Operation level * Supported
CheckTableExists This interface (CheckTableExists) use to check table exists Operation level * Supported
CheckViewExists This interface (CheckViewExists) use to check view exists Operation level * Supported
CheckVpcCidrBlock CheckVpcCidrBlock Operation level * Supported
DescribeAccountInfo DescribeAccountInfo Operation level * not supported
DescribeAdvancedStoreLocation query advance config for sql query Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} not supported
DescribeAuditEvents DescribeAuditEvents Operation level * Supported
DescribeAvailableVpc DescribeAvailableVpc Operation level * Supported
DescribeBucketType Query the current bucket type Operation level * Supported
DescribeCHDFSAccessInfos Query chdfs bucket access permission configuration Operation level * Supported
DescribeCHDFSMountPointAssociateInfos Describe CHDFS Mount Point AssociateInfos Operation level * Supported
DescribeCHDFSMountPointSuperuser Query Bucket Superuser Operation level * Supported
DescribeCHDFSProducts Query chdfs bucke products of bounding Operation level * Supported
DescribeCloudProductBindings Query the CHDFS permission binding list of cloud products Operation level * Supported
DescribeColumns Describe Columns Operation level * Supported
DescribeDLCGrammar Query DLC grammar Operation level * not supported
DescribeDLCTable Describe DLC Table Operation level * Supported
DescribeDMSDatabase Describe DMS Database Operation level * Supported
DescribeDMSDatabaseList Describe DMS DatabaseList Operation level * Supported
DescribeDMSPartitionColumnStatisticList Describe Partition Column Statistic. Operation level * Supported
DescribeDMSPartitions Get partitions Operation level * Supported
DescribeDMSTable Describe DMS Table Operation level * Supported
DescribeDMSTableColumnStatisticList Describe Table Column Statistic. Operation level * Supported
DescribeDataEngine This interface is used to obtain detailed information about the data engine based on the name Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeDataEngineEvents Query data engine events Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeDataEngineImageOperateRecords Describe DataEngine Image Operate Records Operation level * Supported
DescribeDataEngineOperationLogs Describe DataEngine Operation Logs Operation level * Supported
DescribeDataEngineParameters describe data engine parameters. Operation level * Supported
DescribeDataEngineSessionParameters Describe DataEngine Session Parameters Operation level * Supported
DescribeDataEngineTcrBindInfo Describe DataEngine Tcr Bind Info Operation level * Supported
DescribeDataEngines This interface (DescribeDataEngines) is used to obtain a list of DataEngines information Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeDataMaskStrategyResoucesCount Describe Data Mask Strategy Resources Count Operation level * not supported
DescribeDataMaskStrategyResourcesCount Describe DataMask Strategy Resources Count Operation level * Supported
DescribeDataMaskStrategyTypes Describe Data Mask Strategy Types Operation level * Supported
DescribeDataQueries List Data Queries Operation level * Supported
DescribeDataQuery Describe Data Query Operation level * Supported
DescribeDataTaskAlarmFiled Query data task alarm fields Operation level * Supported
DescribeDatabase DescribeDatabase Operation level * Supported
DescribeDatabaseUDFList query udf list for database Operation level * Supported
DescribeEGNetworkConnectionInfo Describe EG Network ConnectionInfo Operation level * Supported
DescribeEngineNetworks DescribeEngineNetworks Operation level * Supported
DescribeEngineNodeSpec DescribeEngineNodeSpec Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeEngineUsageInfo Query data engine resource usage Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeExportResultTasks Describe the export result task list Operation level * Supported
DescribeFatherAndSonTaskInstances DescribeFatherAndSonTaskInstances Operation level * Supported
DescribeFatherAndSonTasks DescribeFatherAndSonTasks Operation level * Supported
DescribeForbiddenTablePro Describe forbidden table list Operation level * Supported
DescribeForbiddenTableProperties Describe Forbidden Table Properties. Operation level * Supported
DescribeFunctions This interface (DescribeFunctions) is used to describe udf list Operation level * Supported
DescribeGeneratedGrammar Query generated grammar Operation level * Supported
DescribeGovernDefaultPolicy DescribeGovernDefaultPolicy Operation level * Supported
DescribeGovernEventRule DescribeGovernEventRule Operation level * Supported
DescribeGovernMetaInfo DescribeGovernMetaInfo Operation level * Supported
DescribeGrayUsers DescribeGrayUsers Operation level * Supported
DescribeHouseEventsMetrics Query cluster events based on time series Operation level * Supported
DescribeInstanceLogList DescribeInstanceLogList Operation level * Supported
DescribeJob Describe Job Information Operation level * Supported
DescribeKernelArgs Query Enterprise Gateway kernel parameters Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeLakeFsAccess DescribeLakeFsAccess Operation level * Supported
DescribeLakeFsChdfsBindings DescribeLakeFsChdfsBindings Operation level * Supported
DescribeLakeFsChdfsNames DescribeLakeFsChdfsNames Operation level * Supported
DescribeLakeFsDirSummary DescribeLakeFsDirSummary Operation level * Supported
DescribeLakeFsInfo DescribeLakeFsInfo Operation level * Supported
DescribeLakeFsPath Describe LakeFs Path Operation level * Supported
DescribeLakeFsTaskResult Describe LakeFs Task Result Operation level * Supported
DescribeLakeFsTaskResultAccessInfo Describe LakeFs Task Result Access Infomation Operation level * Supported
DescribeLakeFsWarehouseAccess DescribeLakeFsWarehouseAccess Operation level * Supported
DescribeLocationAllocator DescribeLocationAllocator Operation level * Supported
DescribeLocationAllocators DescribeLocationAllocators Operation level * Supported
DescribeMainDataDataEngine DescribeMainDataDataEngine Operation level * Supported
DescribeMainDataOverview This interface (DescribeMainDataOverview) is used to describe main data overview Operation level * Supported
DescribeMainDataOverviewLine This interface (DescribeMainDataOverviewLine) is used to describe main data overview line Operation level * Supported
DescribeMainDataPrivateEngineLine This interface (DescribeMainDataPrivateEngineLine) is used to describe main data private engine line Operation level * Supported
DescribeMainDataShareEngineLine This interface (DescribeMainDataShareEngineLine) is used to describe main data share engine Line Operation level * Supported
DescribeMainDataTaskLine This interface (DescribeMainDataTaskLine) is used todescribe main data task line Operation level * Supported
DescribeMangedTableExists DescribeMangedTableExists Operation level * Supported
DescribeMetaDatabase Query metabase details Operation level * Supported
DescribeMetaDatabases Query metabase list Operation level * Supported
DescribeMetaKeyConstraint DescribeMetaKeyConstraint Operation level * not supported
DescribeMetaTable Query metadata table details Operation level * Supported
DescribeMetaTableInternal This interface (DescribeMetaTableInternal) use to describe meta table internal info Operation level * Supported
DescribeMetaTables Query metadata table list Operation level * Supported
DescribeMetadataOverview DescribeMetadataOverview Operation level * Supported
DescribeNativeEngineInfo DescribeNativeEngineInfo Operation level * not supported
DescribeNativeSparkSessions Query the standard engine spark session list Operation level * Supported
DescribeNetworkConnections DescribeNetworkConnections Operation level * Supported
DescribeNotebookSession DescribeNotebookSession Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeNotebookSessionLog DescribeNotebookSessionLog Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeNotebookSessionStatement DescribeNotebookSessionStatement Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeNotebookSessionStatementSqlResult Describe Notebook Session Statement Sql Result Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeNotebookSessionStatements Describe Notebook Session Statements Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeNotebookSessions DescribeNotebookSessions Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeOptimizerExecution DescribeOptimizerExecution Operation level * Supported
DescribeOptimizerInstanceOverview DescribeOptimizerInstanceOverview Operation level * Supported
DescribeOptimizerResourceOverview DescribeOptimizerResourceOverview Operation level * Supported
DescribeOrCreateCHDFSAccessGroups DescribeOrCreateCHDFSAccessGroups Operation level * Supported
DescribeOtherCHDFSBindingList DescribeOtherCHDFSBindingList Operation level * Supported
DescribeQuery Describe query Operation level * Supported
DescribeQueue DescribeQueue Operation level * Supported
DescribeResultDownload Get download task Operation level * Supported
DescribeResultDownloadInfo This interface (DescribeResultDownloadInfo) is used to obtain SQL query result download information Operation level * Supported
DescribeResultSize This interface (DescribeResultSize) is used to query the SQL result data size Operation level * Supported
DescribeRoleStrategy Describe Role Strategy Operation level * Supported
DescribeRoleSwitch Describe Role Switch Operation level * Supported
DescribeSQLSessionCatalog DescribeSQLSessionCatalog Operation level * Supported
DescribeSQLSessionSnapshot Query SQL session details Operation level * Supported
DescribeSQLSessionSnapshots Query SQL session snapshot list Operation level * Supported
DescribeSQLSessionSubmitRecords Query SQL session submit record list Operation level * Supported
DescribeScheduleExecutionInfo DescribeScheduleExecutionInfo Operation level * Supported
DescribeScheduleTaskInstances DescribeScheduleTaskInstances Operation level * Supported
DescribeScheduleTasks DescribeScheduleTasks Operation level * Supported
DescribeSmartDiagnosisDetails DescribeSmartDiagnosisDetails Operation level * Supported
DescribeSmartDiagnosisOverview DescribeSmartDiagnosisOverview Operation level * Supported
DescribeSmartDiagnosisSummary DescribeSmartDiagnosisSummary Operation level * Supported
DescribeSparkAppJob query spark application job Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeSparkAppJobImages describe spark app job images. Operation level * Supported
DescribeSparkAppJobs query spark application job list Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeSparkAppTasks query spark application tasks Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeSparkSessionBatchSQL Describe Spark Session BatchSQL Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeSparkSessionBatchSQLCost describe spark sql batch sql cost Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeSparkSessionBatchSqlLog Describe Spark Session Batch Sql Log Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeSparkTaskLogDownloadInfo DescribeSparkTaskLogDownloadInfo Operation level * Supported
DescribeStandardEngineResourceGroupConfigInfo Query the configuration information of the standard engine resource group Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeStandardEngineResourceGroups Query standard engine resource group information Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeStandbyDataEngine Describe StandbyDataEngine Info Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeStartTime Query engine startup time statistics Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeStorageOverview DescribeStorageOverview Operation level * Supported
DescribeStorageTrends DescribeStorageTrends Operation level * Supported
DescribeStorageUsage DescribeStorageUsage Operation level * Supported
DescribeStorageUsageEnable DescribeStorageUsageEnable Operation level * Supported
DescribeStoreLocation DescribeStoreLocation Operation level * Supported
DescribeSubUserAccessPolicy DescribeSubUserAccessPolicy Operation level * Supported
DescribeSubUsers Describe SubUsers Operation level * Supported
DescribeSubuins obtain subuins Operation level * Supported
DescribeSystemStorage Query the specified managed storage system catalog Operation level * Supported
DescribeTable DescribeTable Operation level * Supported
DescribeTablePartitions DescribeTablePartitions Operation level * Supported
DescribeTableStorageUsage DescribeTableStorageUsage Operation level * Supported
DescribeTablesExtend Describle Tables Extend Operation level * Supported
DescribeTaskDetail describeTaskDetail Operation level * Supported
DescribeTaskLog DescribeTaskLog Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeTaskMetrics DescribeTaskMetrics Operation level * Supported
DescribeTaskMonitorInfos QueryTaskMonitorInfo Operation level * Supported
DescribeTaskResult get task result Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeTaskRunningResult describeTaskRunningResult Operation level * Supported
DescribeTaskStatistics Describe task statistics Operation level * Supported
DescribeTasksAnalysisWriteInfo task output file details Operation level * Supported
DescribeTasksOverview DescribeTasksOverview Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeTcIcebergOptimizingTasks query amoro optimizing task Operation level * Supported
DescribeThirdPartyAccessUser DescribeThirdPartyAccessUser Operation level * Supported
DescribeUpdatableDataEngines Describe Updatable DataEngines Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeUpdateEffect Get the scope of influence of configuration change Operation level * Supported
DescribeUserDataEngineConfig Describe User DataEngine Config Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeUserInfo Describe user info Operation level * Supported
DescribeUserLocationAllocatorEnable DescribeUserLocationAllocatorEnable Operation level * Supported
DescribeUserRoles list user roles Operation level * Supported
DescribeUserType DescribeUserType Operation level * Supported
DescribeUserUseScene DescribeUserUseScene Operation level * Supported
DescribeUserVpcConnection DescribeUserVpcConnection Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeUsersInfo Describe user info list Operation level * Supported
DescribeView describe view Operation level * Supported
DescribeViews DescribeViews Operation level * Supported
DescribeWhitelist DescribeWhitelist Operation level * not supported
DescribeWorkGroupInfo Describe work group info Operation level * Supported
DescribeYuntiUser DescribeYuntiUser Operation level * Supported
DownLoadTasks Download tasks Operation level * Supported
DownloadResult Download Result Operation level * Supported
DownloadSparkTaskLog DownloadSparkTaskLog Operation level * Supported
ExportResult Export Result Operation level * Supported
GenerateCreateMangedMixedTableSql generate sql string Operation level * not supported
GenerateCreateMangedTableSql GenerateCreateMangedTableSql Operation level * Supported
GetWorkflowCanvas get canvas data Operation level * Supported
GetWorkflowInfo get workflow info by id Operation level * Supported
InferSchema InferSchema Operation level * not supported
InquireCreateDataEnginePrice Inquire create data engine price Operation level * Supported
InquirePriceCreateDataEngine Inquire price create data engine Operation level * not supported
InquirePriceModifyDataEngine Inquire price modify data engine Operation level * not supported
InquirePriceTerminateDataEngine Inquire price terminate data engine Operation level * Supported
ListDataEngines ListDataEngines Operation level * Supported
ListDatasourceConnection Query default data source information Operation level * Supported
ListLakeFsInfo describe LakeFs info Operation level * Supported
ListTaskJobLogDetail this interface (ListTaskJobLogDetail) use to get spark-jar log list Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
ListTaskJobLogName ListTaskJobLogName Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
ListWorkflow get workflow list Operation level * Supported
QueryInternalTableWarehouse Query Internal Table Warehouse Operation level * Supported
QueryResult Query task result Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
QuerySparkImageUserRecords query spark image user records. Operation level * Supported
QuerySparkImages get spark image list. Operation level * Supported
QueryTaskCostDetail query task cost detail Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
QueryTaskResult QueryTaskResult Operation level * Supported
ValidateWorkflowName check if workflow name is valid Operation level * Supported

Other Operations

API API Description Authorization Granularity Six-segment Resource Description IP Restriction
AddOptimizerEngines AddOptimizerEngines Operation level * Supported
CancelTasksBatch Cancel tasks by batch Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
CheckTableAccess Check Table Access Operation level * Supported
DescribeOptimizedTables DescribeOptimizedTables Operation level * Supported
DescribeRunningOptimizerTasks DescribeRunningOptimizerTasks Operation level * Supported
DescribeTasksAnalysisTotal DescribeTasksAnalysisTotal Operation level * Supported
DescribeTodayOptimizerTasks DescribeTodayOptimizerTasks Operation level * Supported
GetOptimizeFilesView GetOptimizeFilesView Operation level * Supported
GetOptimizeOverview GetOptimizeOverview Operation level * Supported
GetOptimizerPolicy GetOptimizerPolicy Operation level * Supported
GetTableSnapshots GetTableSnapshots Operation level * Supported
SetOptimizerPolicy SetOptimizerPolicy Operation level * Supported

List Operations

API API Description Authorization Granularity Six-segment Resource Description IP Restriction
DescribaDLCTableList Describe DLC TableList Operation level * not supported
DescribeCvm View cvm Operation level * Supported
DescribeDLCCHDFSBindingList Query the DLC chdfs bucket binding list Operation level * Supported
DescribeDLCCatalogAccess Describe DLC Catalog access Operation level * Supported
DescribeDLCTableList Describe DLC Table List Operation level * Supported
DescribeDMSTables Describe tables Operation level * Supported
DescribeDataEngineScale Descrbie Data engine scale Operation level * not supported
DescribeDataEnginesScaleDetail Descrbie Data engine scale detail Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeDataMaskStrategies Describe data mask strategies Operation level * Supported
DescribeDatabases DescribeDatabases Operation level * Supported
DescribeDatasourceConnection DescribeDatasourceConnection Operation level * Supported
DescribeJobs Describe Job List Operation level * Supported
DescribeScripts DescribeScripts Operation level * Supported
DescribeSessionImageVersion DescribeSessionImageVersion Operation level * Supported
DescribeSparkSessionBatchSqlTasks Describe Spark Session Batch Sql Tasks Operation level * Supported
DescribeTables DescribeTables Operation level * Supported
DescribeTablesName Describe Tables Name Operation level * Supported
DescribeTaskList describeTaskList Operation level * Supported
DescribeTasks DescribeTasks Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeTasksAnalysis tasks analysis list Operation level * Supported
DescribeTasksAnalysisOverView Insights overview Operation level * Supported
DescribeTasksCompressJobs Describe Tasks Compress Jobs Operation level * Supported
DescribeTasksCostInfo DescribeTasksCostInfo Resource level qcs::dlc::uin/${uin}:dataengine/${dataengineId} Supported
DescribeTasksInsights tasks Insights list Operation level * Supported
DescribeUsers DescribeUsers Operation level * Supported
DescribeUsersGroups Describe users groups Operation level * Supported
DescribeWorkGroups DescribeWorkGroups Operation level * Supported
GetWaterLevel Query resource pool water level Operation level * Supported
ListRoleByUser List Role By User Operation level * Supported
ListUserByRole List User By Role Operation level * Supported
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support