API 概览

最近更新时间: 2026-06-30 00:02:52

API版本

V3

Ems相关接口

接口名称 接口功能
DescribeAlarmHistoryList 查询告警历史列表
DescribeAnalysisDataExist 查询解析数据是否存在

信息查询相关接口

接口名称 接口功能
DescribeAnalysisRule 查询洞察配置
DescribeAppAnalysisResults 获取应用的分析结果
DescribeApplicationInfo 查询作业详情
DescribeApplicationStatics 查询Appilication统计
DescribeAvailableDisks 查询可用磁盘
DescribeCertainEventList 获取某个事件的发生列表
DescribeClusterClients 客户端安装信息查看
DescribeClusterOverview 查询集群概览基本信息
DescribeCompareMetricsList 获取集群概览中节点指标对比列表数据
DescribeDashboardAddress 查询集群监控下dashboard的地址
DescribeDiskInfo 获取磁盘基本信息
DescribeDynamicTableData 查询资源分析统计表格列数据
DescribeDynamicTableMeta 查询资源分析统计列表中的每列的表头字段信息
DescribeEMRHostOverview 查询节点状态下部署状态基本信息和进程列表数据
DescribeEMRNodeOverview 查询集群概览下部署状态节点相关数据
DescribeEmrApplicationMetricData 获取TBDS-YARN-APP监控数据
DescribeEmrMetricData 获取某组件某角色下所有可视化展示的监控数据
DescribeEmrMetricMeta 获取某组件某角色下所有可视化曲线的元数据
DescribeEmrMetricMetaNew 获取某组件某角色下所有可视化曲线的元数据
DescribeEmrOverviewData 查询集群概览页和节点状态下概览指标数据
DescribeEvents 获取事件列表
DescribeFileIps 配置页面拉取文件所在IP列表
DescribeFlowStatus 查询TBDS任务运行状态
DescribeGcList 查询JAVA分析中的GC列表数据
DescribeGcServiceRole 查询JAVA分析GC视图中的服务和角色列表
DescribeGcServiceRoleHosts 查询JAVA分析GC视图中服务和角色对应的节点列表
DescribeHBaseRegionList 获取HBase数据表分析中HBase-Region列表数据
DescribeHBaseRegionServerList 获取HBase数据表分析中HBase-RegionServers列表数据
DescribeHBaseTableOverview 获取Hbase数据表分析中数据表列表的表头和表相关数据
DescribeHeatMapDistribution 返回集群热力图数据
DescribeHeatMapMetricList 返回集群主机聚合维度指标列表
DescribeImpalaProfileTree 查询impala-profile树形目录
DescribeImpalaProfileTreeNode 查询impala-profile树形节点内容
DescribeImpalaQueryDistribution 查询impala-query指标分布
DescribeImpalaQueryInfo 查询impala作业详情
DescribeImpalaQueryMetricsMeta 查询impala-query概览指标元数据
DescribeImpalaQueryNodeMetrics 查询impala-query节点指标
DescribeImpalaQueryOverview 查询impala-query概览
DescribeInstanceMessage 获取集群信息
DescribeInstanceNodes 获取集群主机信息
DescribeInstanceOpType 获取集群操作日志类型
DescribeInstanceServiceAbstract 获取服务概览摘要数据
DescribeInstanceServiceBasicInfo 获取角色基本信息
DescribeInstanceServiceRoleNames 获取服务角色表名称列表
DescribeInstanceServiceRoleTable 获取服务角色表数据
DescribeIsSupportLog 查询角色是否支持日志搜索
DescribeLogContent 查询集群日志列表
DescribeLogDetail 查询集群日志详情
DescribeLogMeta 查询集群日志服务元数据
DescribeMeasurementData 获取表信息数据
DescribeMeasurementMeta 获取表信息元数据
DescribeMetricMeta 查询集群监控元数据
DescribeMetricsDimension 获取不同级别监控的监控维度值
DescribeNodeComponent 查看节点服务
DescribeNodeList 查看节点信息
DescribeServiceGroups 查询集群服务信息
DescribeServiceNodeInfos 查询服务进程节点信息
DescribeStoreStrategy 查询存储策略列表
DescribeTSDBData 获取时序数据
DescribeTSDBMeta 获取时序数据meta信息
DescribeTopNByHost 概览页主机维度的TopN
DescribeTopNByProcess 获取topn进程
DescribeTopNMeta 获取topn元数据信息
ExDescribeInstanceOplog 获取集群的操作日志
ExportInstanceAuditLog 导出审计中心日志
ListConfLogs 获取配置下发日志

其他接口

接口名称 接口功能
DeleteProjectResource 删除项目资源
DescribeConfigGroup 查询配置组
DescribeConfigGroupList 查询节点类型的配置组列表
DescribeHiveQueryInfo 查询hive作业详情
DescribeKeyTabFile 导出Keytab文件(用户管理)
DescribeProjectResourceList 获取资源列表
DescribeServiceComponentInfos 描述容器集群角色信息
DescribeYarnLastestLabels 获取最新的标签信息
DescribeYarnScheduleHistory yarn资源调度-调度历史
ModifyInstanceBasic 修改集群名称
ModifyOldLabelConfig 取消保存yarn标签管理的编辑内容
ModifyResourceScheduleConfigForRollback 取消保存yarn资源调度的资源配置
ModifyYarnDeploy yarn资源调度配置部署生效
ModifyYarnLabelState 资源调度-标签管理-指令生效
ModifyYarnLabels 同步yarn节点标签
ModifyYarnQueue 修改资源调度中资源池
RestartService 重启组件服务
StartService 启动组件服务
StopService 停止组件服务

平台管理相关接口

接口名称 接口功能
CreateBaseTag 创建标签
CreateBaseTagResourceRelation 资源绑定标签
CreateResourceAuthorization 创建资源授权
CreateResourceGroup 创建资源组
CreateUser 创建TBDS用户
CreateUserGroup 创建TBDS用户组
CreateUserToResourceGroups 绑定单个TBDS用户到多个资源组
CreateUserToUserGroups 绑定单个TBDS用户到多个TBDS用户组
CreateUsersToUserGroup 绑定多个TBDS用户到单个TBDS用户组
CreateUsersToUserGroups 绑定多个TBDS用户到多个TBDS用户组
DeleteBaseTag 删除标签
DeleteBaseTagResourceRelation 资源解绑标签
DeleteResourceAuthorization 删除资源授权
DeleteResourceGroup 删除资源组
DeleteUser 删除TBDS用户
DeleteUserFromResourceGroups 解绑单个TBDS用户到多个资源组
DeleteUserFromUserGroups 解绑单个TBDS用户到多个TBDS用户组
DeleteUserGroup 删除TBDS用户组
DeleteUsersFromUserGroup 解绑多个TBDS用户到单个TBDS用户组
DescribeBaseResourceTagPage 获取底座资源关联的标签分页列表
DescribeBaseTagKeyPage 获取标签键分页列表
DescribeBaseTagPage 获取标签分页列表
DescribeBaseTagResourcePage 获取底座标签关联的资源分页列表
DescribeBaseTagValuePage 获取标签值分页列表
DescribeDeployType 查询部署类型
DescribeHdfsResourceList 查询HDFS路径列表
DescribeLoginUser 查询当前登录用户的TBDS用户信息
DescribePolicyUserGroupPage 查询CAM策略绑定的TBDS用户组列表
DescribePolicyUserPage 查询CAM策略绑定的TBDS用户列表
DescribeResourceAuthorizationPage 查询资源授权分页列表
DescribeResourceGroup 查询资源组详情
DescribeResourceGroupPage 查询资源组分页列表
DescribeResourceGroupQuotaRemain 查询指定k8s集群可划分的资源配额
DescribeResourceGroupRelationPage 查询资源组用户绑定关系分页列表
DescribeRoleUserGroupPage 查询CAM角色下绑定的TBDS用户组
DescribeRoleUserPage 查询CAM角色下绑定的TBDS用户
DescribeUser 查询指定TBDS用户详情
DescribeUserGroup 查询指定TBDS用户组详情
DescribeUserGroupPage 查询TBDS用户组分页列表
DescribeUserGroupRelationPage 查询TBDS用户组和TBDS用户绑定关系分页列表
DescribeUserKeyTabExpireTip 获取用户keytab过期提示总览tip信息
DescribeUserPage 查询TBDS用户分页列表
DescribeYarnResourceList 查询指定集群下的yarn队列
ModifyBaseTagResourceRelation 修改资源绑定标签
ModifyResourceAuthorization 修改资源授权
ModifyResourceGroup 修改资源组
ModifyResourceGroupName 修改资源组名称
ModifyUser 修改TBDS用户信息
ModifyUserGroup 修改TBDS用户组信息
RecreateResourceGroup 重试创建资源组

数据管理接口

接口名称 接口功能
CopyHDFSFile 对HDFS的文件进行复制
CreateHDFSFolder 创建HDFS目录
CreateHDFSFolders 批量创建HDFS文件夹
DeleteHDFSFile 永久删除HDFS文件
DescribeCatalog 获取catalog详情
DescribeCatalogList 获取catalog列表
DescribeFields 获取表字段
DescribeHDFSClusters 查询HDFS集群
DescribeHDFSFolderFiles 获取HDFS文件列表
DescribeHDFSSpaces 批量查询HDFS空间信息
DescribeMaskRulesSTD 查询脱敏规则
DescribePartitions 获取table分区列表
DescribeSchema 获取数据库详情
DescribeSchemas 获取数据库列表
DescribeTable 获取表详情
DescribeTables 获取table列表
IssueMaskRulesSTD 创建/修改脱敏规则
MoveToTrash 移动HDFS文件到回收站
RenameHDFSFile 重命名或移动HDFS文件

用户管理相关接口

接口名称 接口功能
ModifyUserKeytabExpireManager 修改用户keytab凭证的过期时间

租户管理

接口名称 接口功能
DescribeTenantList 获取租户列表

配置相关接口

接口名称 接口功能
AddConfigGroup 新增一个配置组
AddServiceConfFile 新增用户自定义配置文件
DeleteConfigGroup 删除配置组
DeleteServiceConfFile 删除用户自定义配置文件
DescribeComponentConfigFileInfo 获取组件配置信息
DescribeConfFileList 获取配置文件列表-配置管理页
DescribeDefaultFileConfig 获取组件默认配置项
DescribeExportConfs 查询导出配置
DescribeServiceConfsNew 获取组件配置信息-配置管理页
ModifyAnalysisRule 修改洞察配置
RollBackConf 回滚配置

集群服务相关接口

接口名称 接口功能
ClearCreateClient 清除客户端
CreateClusterClient 创建客户端
DeleteCreateClient 卸载安装客户端
DescribeCloudInstanceService 容器版TBDS集群服务部署信息
DescribeCloudServiceMeta 描述容器TBDS-TKE集群服务的Pod规格范围
DescribeClustersForFederation 查询可以联邦的集群
DescribeInstallClient 查询创建客户端
DescribeIpStack 获取网络协议
DescribeOperatingClients 查询正在下载客户端
DescribeRangerServices 获取集群的ranger中services名称
DescribeResourceSchedule 查询YARN资源调度数据信息
DescribeServiceDependency 查询服务的依赖关系
DescribeYarnScheduleBaseInfos 查询yarn调度基本信息
EsDownload es插件信息下载
GetComponentProperties 获取ldap与ranger配置
ModifyResourceScheduleConfig 修改YARN资源调度的资源配置
StartStopServiceOrMonitor 用于启动或停止监控或服务
StopYarnApplication 查杀Yarn任务

集群生命周期相关接口

接口名称 接口功能
CheckClusterForUpgrade 检查集群的升级状态
ClusterPatchedList 某一个集群的打补丁记录
ClustersUpgradeList 集群升级记录列表
DeleteInstance 删除创建失败的云原生集群
DescribeCloudInstance 查询云原生集群详情
DescribeCloudInstancesList 获取云原生集群列表
DescribePatchedInfo 升级信息预览
InstalledClusters 已打补丁集群
ListPatch 补丁列表
PatchableClusters 可以打补丁的集群
PatchedReport 补丁升级报告
RollbackPatched 回滚补丁
TerminateNodes 销毁节点

集群资源管理相关接口

接口名称 接口功能
AddHostNodes 添加主机
CheckHost 检查主机
CreateServiceResourceConfig 创建资源隔离配置组
CreateStoreStrategy 新增存储策略
DeleteESDicts 删除ES词典
DeleteESPlugins 删除ES插件
DeleteHostNodes 删除主机
DeleteServiceResourceConfig 删除资源隔离配置组
DeployImpalaResourcePool 部署impala资源池
DescribeClusterNodes 查询集群节点信息
DescribeESDicts 获取ES词典
DescribeESPlugins 获取ES插件列表
DescribeFileTmpToken 获取文件临时凭据
DescribeHostNodes 查询主机信息
DescribeImpalaResourcePool 查询当前集群impala资源池队列信息
DescribeInstances 查询集群实例信息
DescribeInstancesList 查询集群列表
DescribeInstancesTypes 查询集群类型
DescribeServicePodNodeInfos 查询服务pod节点信息
DescribeServiceResourceConfig 查询资源隔离配置组
DescribeSrJdbcInfo 查询SR的JDBC链接信息
DescribeTceInstanceConfigInfos DescribeTceInstanceConfigInfos
EnableImpalaResourcePool 开启关闭Impala动态资源池
InitHostNodes 主机管理-重置主机
InstallESPlugins 安装ES插件
ModifyComponentResource 容器集群Pod变更配置
ModifyHostNodes 修改主机信息
ModifyPodNum 调整云原生集群Pod数量
ModifyRackInfo 编辑机架信息
ModifyServiceResourceConfig 修改资源隔离配置组
ReinstallESPlugins 重装ES插件
SaveESDicts 保存ES词典
ScaleInNodeCheck ES集群缩容时进行节点校验,校验服务
ScaleOutInstance 实例扩容
TerminateInstance 销毁TBDS集群
UninstallESPlugins 卸载ES插件
UpdateImpalaResourcePool 更新Impala资源池信息