API 概览

最近更新时间:2024-09-13 01:29:05

我的收藏

数据表相关接口

接口名称 接口功能 频率限制(次/秒)
CreateInternalTable 创建托管存储内表 20
DescribeLakeFsTaskResult 获取LakeFs上task执行结果访问信息 100
DescribeLakeFsDirSummary 查询托管存储指定目录的Summary 20
DescribeNotebookSessionStatementSqlResult 获取statement运行结果(作用于:Spark交互式SQL任务、Notebook任务)。 20
AssignMangedTableProperties 分配原生表表属性 20
DescribeLakeFsInfo 查询用户的托管存储信息 20
QueryResult 获取任务结果查询 200
GenerateCreateMangedTableSql 生成创建托管表语句 20
DeleteTable 删除表 20

任务相关接口

接口名称 接口功能 频率限制(次/秒)
CancelNotebookSessionStatementBatch 批量取消Session 中执行的任务 20
CancelNotebookSessionStatement 取消session中执行的任务 20
CreateExportTask 创建导出任务 20
CreateSparkSessionBatchSQL 创建并执行Spark SQL批任务 30
CancelSparkSessionBatchSQL 取消Spark SQL批任务 20
CreateImportTask 创建导入任务 20
CancelTask 取消任务 20
CreateScript 创建sql脚本 20
CreateResultDownload 创建查询结果下载任务 20
CreateTasksInOrder 按顺序创建任务 20
CreateSparkAppTask 启动Spark作业 20
DeleteNotebookSession 删除交互式session(notebook) 20
CreateTask 创建并执行SQL任务 50
DeleteScript 删除sql脚本 20
CreateTasks 批量创建并执行SQL任务 20
DescribeNotebookSessionLog 查询交互式 session日志 20
DeleteSparkApp 删除spark作业 20
DescribeNotebookSessions 查询交互式 session列表 20
DescribeEngineUsageInfo 查询数据引擎资源使用情况 20
DescribeScripts 查询SQL脚本列表 20
DescribeResultDownload 查询结果下载任务 20
DescribeTasksCostInfo 查询任务消耗 20
DescribeSparkAppTasks 查询spark应用的运行任务实例列表 40
DescribeTasksOverview 查看任务概览页 20
CreateNotebookSessionStatement 在session中执行代码片段 20
DescribeTaskResult 查询任务结果(用于: SparkSQL、PrestoSQL) 40
CreateNotebookSessionStatementSupportBatchSQL 创建交互式session并执行SQL任务 20
DescribeTasks 查询任务列表 1000
DescribeNotebookSession 查询交互式 session详情信息 20
QueryTaskCostDetail 查询任务消耗明细 20
CreateSparkApp 创建spark作业 20
DescribeNotebookSessionStatements 查询Session中执行的任务列表 20
CreateNotebookSession 创建交互式session(notebook) 20
DescribeSparkAppJob 查询spark作业信息 20
DescribeNotebookSessionStatement 查询session 中执行任务的详情 20
DescribeSparkSessionBatchSqlLog 查询Spark SQL批任务日志 50
DescribeSparkSessionBatchSQL 获取Spark SQL批任务运行状态 20
ModifySparkApp 更新spark作业 20
DescribeSparkAppJobs 查询spark作业列表 20
DescribeSparkSessionBatchSQLCost 获取Spark SQL批任务消耗 20
DescribeTaskLog 查询任务日志 20
ModifySparkAppBatch 批量修改Spark作业参数配置 20
ListTaskJobLogDetail 查询日志详情 20
ListTaskJobLogName 日志名称列表 20

元数据相关接口

接口名称 接口功能 频率限制(次/秒)
AlterDMSDatabase DMS元数据更新库 20
CreateDMSDatabase DMS元数据创建库 20
AddDMSPartitions DMS元数据新增分区 150
DescribeDMSDatabase DMS元数据获取库 20
AlterDMSPartition DMS元数据更新分区 20
DescribeTablesName 查询数据表名称列表 20
AlterDMSTable DMS元数据更新表 20
DropDMSDatabase DMS元数据删除库 20
CheckLockMetaData 元数据锁检查 20
DescribeForbiddenTablePro 查询被禁用的表属性列表(新) 20
CreateDMSTable DMS元数据创建表 20
DescribeDLCCatalogAccess 查询DLCCatalog访问权限 20
CreateDatabase 生成建库SQL语句 20
GrantDLCCatalogAccess 授权DLCCatalog访问权限 20
CreateTable 生成建表SQL 20
RevokeDLCCatalogAccess 撤销DLCCatalog访问权限 20
DescribeDMSPartitions DMS元数据获取分区 20
DescribeDMSTable DMS元数据获取表 200
DescribeDMSTables DMS元数据获取表列表 200
DescribeDatabases 查询数据库列表 20
DescribeTable 查询表详情 20
DescribeTables 查询数据表列表 20
DescribeViews 查询视图列表 20
DropDMSPartitions DMS元数据删除分区 20
LockMetaData 元数据锁 20
ReportHeartbeatMetaData 上报元数据心跳 20
UnlockMetaData 元数据解锁 20
DropDMSTable DMS元数据删除表 20
QueryInternalTableWarehouse 获取原生表warehouse路径 20

服务配置相关接口

接口名称 接口功能 频率限制(次/秒)
CreateCHDFSBindingProduct 创建元数据加速桶和产品绑定关系 20
DeleteCHDFSBindingProduct 删除元数据加速桶和产品绑定关系 20
DescribeOtherCHDFSBindingList 查询其他产品元数据加速桶绑定列表 20
CreateStoreLocation 修改结果存储位置 20
DescribeStoreLocation 查询结果存储位置 20
ModifyDataEngineDescription 修改引擎描述信息 20
RollbackDataEngineImage 回滚引擎镜像版本 20
SwitchDataEngine 切换主备集群 20
SwitchDataEngineImage 切换引擎镜像版本 20
UpgradeDataEngineImage 升级引擎镜像 20
DeleteThirdPartyAccessUser 移除第三方平台访问用户 20
DescribeDataEngineImageVersions 获取独享集群大版本镜像列表 20
DescribeSubUserAccessPolicy 查询子用户访问策略 20
DescribeThirdPartyAccessUser 查询开通的第三方平台访问用户信息 20
RegisterThirdPartyAccessUser 注册第三方平台访问用户 20
RestartDataEngine 重启引擎 20
UpdateUserDataEngineConfig 修改用户引擎自定义配置 20
UpdateDataEngineConfig 修改引擎配置 20

数据源连接相关接口

接口名称 接口功能 频率限制(次/秒)
DescribeDatasourceConnection 查询数据源信息 20
CheckDataEngineImageCanBeRollback 查看集群是否能回滚 20
CheckDataEngineImageCanBeUpgrade 查看集群镜像是否能够升级 20
DescribeDataEnginePythonSparkImages 获取PYSPARK镜像列表 20

数据引擎相关接口

接口名称 接口功能 频率限制(次/秒)
DescribeDataEngineEvents 查询扩缩容日志 20
DescribeDataEngines 查询DataEngines列表 20
CreateDataEngine 创建数据引擎. 20
DescribeDataEnginesScaleDetail 查看引擎的规格明细 20
DeleteDataEngine 删除数据引擎 20
RenewDataEngine 续费包年包月数据引擎 20
SuspendResumeDataEngine 挂起或启动数据引擎 20
UpdateDataEngine 更新数据引擎配置 20
DescribeUpdatableDataEngines 查询可更新配置的引擎列表 20
DescribeDataEngine 获取数据引擎详细信息 20
DescribeUserDataEngineConfig 查询用户自定义引擎参数 20
CheckDataEngineConfigPairsValidity 检查引擎用户自定义参数的有效性 20

权限管理相关接口

接口名称 接口功能 频率限制(次/秒)
AddUsersToWorkGroup 添加用户到工作组 20
AttachUserPolicy 绑定鉴权策略到用户 20
AttachWorkGroupPolicy 绑定鉴权策略到工作组 20
BindWorkGroupsToUser 绑定工作组到用户 20
CreateUser 创建用户 20
CreateWorkGroup 创建工作组 20
DeleteUser 删除用户 20
DeleteUsersFromWorkGroup 从工作组中删除用户 20
DeleteWorkGroup 删除工作组 20
DescribeUserInfo 获取用户详细信息 20
DescribeUserRoles 列举用户角色信息 20
DescribeUserType 获取用户类型 20
DescribeUsers 获取用户列表信息 20
DescribeWorkGroupInfo 获取工作组详细信息 20
DescribeWorkGroups 获取工作组列表 20
DetachUserPolicy 解绑用户鉴权策略 20
DetachWorkGroupPolicy 解绑工作组鉴权策略 20
ModifyUser 修改用户信息 20
ModifyUserType 修改用户类型 20
ModifyWorkGroup 修改工作组信息 20
UnbindWorkGroupsFromUser 解绑用户上的用户组 20
UpdateRowFilter 更新行过滤规则 20

数据优化相关接口

接口名称 接口功能 频率限制(次/秒)
AddOptimizerEngines 添加数据优化资源 20
GetOptimizerPolicy 获取策略 20

数据库相关接口

接口名称 接口功能 频率限制(次/秒)
ModifyAdvancedStoreLocation 修改高级设置 20
ModifyGovernEventRule 修改数据治理事件阈值 20
DescribeAdvancedStoreLocation 查询高级设置 20
注意:

以上给出的接口频率限制维度为API + 接入地域 + 子账号,有关限频更多说明参考:API 频率限制说明