API 概览

最近更新时间:2024-08-23 01:14:52

我的收藏

集群操作相关接口

接口名称 接口功能 频率限制(次/秒)
ModifyClusterConfigs 修改集群配置文件 20
ModifyInstanceKeyValConfigs 修改BE或FE配置 20
ModifyNodeStatus 修改节点状态 20
RestartClusterForConfigs 重启集群让配置文件生效 20
RestartClusterForNode 集群滚动重启 20
CreateInstanceNew 集群创建 20
DestroyInstance 集群销毁 20
ModifySecurityGroups 更改安全组 20
ReduceInstance 集群缩容 20
ResizeDisk 云盘扩容 20
ScaleOutInstance 水平扩容 20
ScaleUpInstance 计算资源垂直变配 20
DescribeClusterConfigsHistory 获取集群配置文件修改历史 20
ModifyInstance 修改集群名称 20

库表相关接口

接口名称 接口功能 频率限制(次/秒)
DescribeTableList 获取表列表 20

集群信息查看相关接口

接口名称 接口功能 频率限制(次/秒)
DescribeClusterConfigs 获取集群配置文件 20
DescribeAreaRegion 获取各地域列表 20
DescribeInstancesHealthState 集群健康检查 20
DescribeSpec 获取集群规格 20
DescribeInstance 获取集群描述信息 20
DescribeInstanceState 获取集群状态 20
DescribeInstances 获取集群列表 20
DescribeInstanceNodesInfo 获取BE、FE节点角色 20
DescribeInstanceUsedSubnets 获取集群已使用子网信息 20
DescribeSqlApis 通过sql查询集群信息 20
DescribeInstanceNodes 获取集群节点信息列表 20
DescribeInstanceNodesRole 获取集群节点角色 20

备份恢复及跨集群迁移相关接口

接口名称 接口功能 频率限制(次/秒)
CancelBackupJob 取消备份实例 20
CreateBackUpSchedule 创建或者修改备份策略 20
DeleteBackUpData 删除备份实例 20
DescribeBackUpJob 查询备份实例列表 20
DescribeBackUpJobDetail 查询备份任务详情 20
DescribeBackUpTables 获取可备份表信息 20
DescribeBackUpTaskDetail 查询备份任务进度详情 20
DescribeRestoreTaskDetail 查询恢复任务进度详情 20
DescribeBackUpSchedules 获取备份、迁移任务 20
RecoverBackUpJob 恢复备份的数据 20

冷热数据分层相关接口

接口名称 接口功能 频率限制(次/秒)
CreateCoolDownPolicy 创建冷热分层策略 20
ModifyCoolDownPolicy 修改冷热分层策略 20
OpenCoolDown 开始启用冷热分层 20
OpenCoolDownPolicy 冷热策略开启相关功能 20
UpdateCoolDown 更新集群冷热分层信息 20
CheckCoolDownWorkingVariableConfigCorrect 检查冷热分层生效变量和配置是否正确 20
DescribeCoolDownBackends 查询冷热分层backend节点信息列表 20
DescribeCoolDownPolicies 查询冷热分层策略列表 20
DescribeCoolDownTableData 查询冷热分层Table数据 20

数据库及操作审计相关接口

接口名称 接口功能 频率限制(次/秒)
DescribeInstanceOperations 获取集群操作审计记录 20
DescribeDatabaseAuditDownload 下载数据库审计日志 20
DescribeDatabaseAuditRecords 获取数据库审计记录 20
DescribeSlowQueryRecords 获取慢查询列表 20
DescribeSlowQueryRecordsDownload 下载慢查询文件 20

用户及权限相关接口

接口名称 接口功能 频率限制(次/秒)
ActionAlterUser 新增、修改用户接口 20
ModifyUserPrivilegesV3 修改权限接口 20

资源组管理相关接口

接口名称 接口功能 频率限制(次/秒)
DescribeUserBindWorkloadGroup 获取用户绑定的资源组信息 20
CreateWorkloadGroup 创建资源组 20
DeleteWorkloadGroup 删除资源组 20
DescribeWorkloadGroup 获取资源组信息 20
ModifyWorkloadGroup 修改资源组信息 20
ModifyUserBindWorkloadGroup 修改用户绑定的资源组 20
ModifyWorkloadGroupStatus 开启、关闭资源组 20
注意:

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