GaussDB-API接口概览

GaussDB-API接口概览

通过使用GaussDB接口，您可以使用GaussDB的创建实例、实例升级等功能。

表1 接口类型及说明

类型	子类型	说明
GaussDB接口	登录	包括生成Token接口。
	备份管理	包括设置自动备份策略、停止备份、切换备份介质、备份扩展配置、查询自动备份策略、查询备份扩展配置、创建手动备份、删除手动备份、根据时间点或者备份文件查询原实例信息、查询可用于备份恢复的实例列表、查询可恢复时间段、查询差量备份列表、备份恢复到当前实例、备份恢复到目标实例数据后执行数据确认、查询备份列表、查询实例归档日志路径、从存储介质同步元数据、删除备份数据、安装证书接口。
	参数配置	包括获取指定实例的参数模板、修改指定实例的参数接口。
	数据库与用户管理	包括创建数据库、创建数据库SCHEMA、查询数据库SCHEMA列表、创建数据库用户、删除数据库用户、数据库用户授权/回收权限、修改用户属性、初始化数据库内置用户密码、重置数据库用户密码、锁定数据库用户、数据库用户解锁、查询数据库列表、查询数据库用户列表、查询数据库上的连接用户/应用/表统计信息以及锁信息、表闪回、创建数据库角色、删除数据库角色、数据库用户/角色自定义授权/回收权限接口。
	数据库诊断优化	提供获取关键视图执行节点、获取指定“节点-组件”维度下的实时会话信息、终止指定会话、终止空闲会话、获取表分析信息、获取索引分析信息、查询WDR快照开关状态、打开或者关闭WDR快照开关，查询WDR快照采集结果、下发WDR快照命令、采集WDR快照、下载WDR快照接口。
	智能运维	包括纳管/解除纳管实例、查询智能运维未纳管/已纳管实例列表、查询智能运维实例列表、新建SQL Patch、查询SQL Patch、开启/关闭/删除SQL Patch接口。
	SQL限流	包括创建限流任务、删除限流任务、根据指定条件查询限流任务列表、查询节点下的sql模板列表接口。
	主机秘钥管理	提供生成主机连接秘钥对、查询秘钥对信息、修改秘钥信息、删除秘钥对、下载公钥接口。
	数据库中心管理	包括查询主机列表、添加主机、修改主机静态信息、删除主机、查询主机标准化检查结果、下载主机导入模板、批量添加主机文件检查、查询可支持主机规格、查询机房列表、添加机房、修改机房信息、删除机房接口。
	日常巡检	包括查询巡检任务、创建巡检任务、删除选中的巡检任务、启动选中的巡检任务、查询巡检任务明细、修改巡检任务、巡检结果统计、巡检项执行详情、巡检项列表、查询巡检记录、批量删除巡检记录、查询巡检场景列表、新增巡检场景、删除巡检场景、修改巡检场景接口。
	实例管理	包括设置实例扩展信息、查询实例扩展信息、获取实例组件列表、主备切换、删除实例、创建实例、备份恢复新实例、查询数据库实例列表/查询实例详情、停止数据库和节点、重启数据库、启动数据库和节点、检查主机是否可被纳管为实例、纳管实例、AZ故障操作、节点扩容、节点替换、实例升级版本获取、实例升级、节点修复、形态变更、开启M兼容端口、修改/关闭M兼容端口接口。
	引擎版本和规格	包括查询数据库引擎的版本接口。
	微服务升级	包括查询实例Agent列表、查询指定实例的Agent信息、升级Agent、批量升级Agent接口。
	告警管理	包括告警结果、告警数量查询、实例告警批量配置接口。
	监控大盘	包括查询监控指标、查询监控指标分组接口。
	日志管理	包括查询慢SQL执行节点、查询慢SQL集合、查询慢SQL详情、获取TopSQL接口。
	任务中心	包括通过JobID查询任务状态接口。
	容灾管理	包括修改容灾任务名、查询容灾关系列表、查询实例容灾监控实时状态、搭建容灾关系、备实例容灾升主、解除容灾关系、灾备实例主从切换、重建容灾关系、开始容灾演练、结束容灾演练、开始日志保持、主实例结束容灾日志保持、获取可搭建灾备实例列表、删除容灾记录接口。

更多详情请参考GaussDB 文档中心：https://doc.hcs.huawei.com/db/zh-cn/gaussdbqlh/24.1.30/productdesc/qlh_03_0001.html