目录
更新时间：2025-12-12
欢迎使用百度智能云的核心产品——云原生数据库 GaiaDB。云原生数据库 GaiaDB Open API 现已全量开放，您可直接使用。
您可以使用本文档介绍的API 对云原生数据库 GaiaDB 服务进行灵活的操作。
如果您是初次调用百度智能云产品的API，可以观看API入门视频指南，快速掌握调用API的方法。
云原生数据库 GaiaDB API 现提供下列接口类型：
| 接口类型 | 接口描述 |
|---|---|
| 集群管理 | 集群 Cluster 是一个云原生数据库实例，通过集群管理API 提供的接口可以支持的操作有：创建集群（包括：克隆集群）、删除集群、更新集群名称、更新集群配置（包括：增/删节点、更新节点规格配置、增/删入口、更新入口代理节点个数）、查询集群列表、查询集群详情、查询集群存储容量、暂停集群、启动集群。 |
| 入口管理 | 入口 Interface 是一个云原生数据库 GaiaDB 集群的访问入口，API 提供更新入口域名、更新入口配置、更新入口新节点自动加入配置、查询入口列表、暂停代理实例、启动代理实例、重启代理实例。 |
| 安全管理 | 云原生数据库 GaiaDB 集群的 IP 白名单列表，API 提供查询IP白名单、更新IP白名单。 |
| 账号管理 | 账号 Account 是一个云原生数据库 GaiaDB 集群访问账号，API 提供创建账号、删除账号、修改账号权限、查询账号列表。 |
| 数据库管理 | 数据库 Database 是一个云原生数据库 GaiaDB 集群数据库，API 提供创建数据库、删除数据库、查询数据库列表。 |
| 备份管理 | 备份 Backup 是一个云原生数据库 GaiaDB 集群的数据镜像备份，API 提供创建备份、查询备份列表、更新备份策略、查询备份策略。 |
| 热活集群组管理 | 热活集群组 MultiActiveGroup 是由多个 GaiaDB 集群组成的高可用集群，API 提供创建热活集群组、删除热活集群组、更新热活集群组名称、查询热活集群组列表、查询热活集群组详情。 |
| 参数管理 | 参数 Parameter对 GaiaDB 集群的运行参数进行精细化管理，支持的操作包括：查询参数列表、更新参数、查询参数的更新历史。 |
| 参数模版管理 | 参数模板 Parameter Template 是用于批量管理数据库参数配置的抽象化实体。API 提供查询参数、创建、更新、删除、应用参数模版等操作。 |
| 维护时间窗口管理 | 维护时间窗口 Mainten Time 用于指定系统自动运维操作的可执行时间段。API 提供设置维护时间窗口、查询维护时间窗口。 |
| 慢日志管理 | 慢日志 SlowSQL 是用于诊断性能瓶颈的重要信息来源。API 提供查询慢日志详情以及优化建议。 |
| binlog 管理 | Binlog 是记录数据库变更事件的关键日志，用于数据同步、审计及恢复场景。API 提供查询 Binlog 备份列表、查询备份详情。 |
| 任务列表管理 | 任务 Task 是指用户发起的各类异步操作，如创建集群、扩容节点、创建备份等。任务列表 API 提供查询任务列表、立即执行任务、取消任务。 |
| 安全组 | 安全组 Security Group 用于控制集群的网络访问策略，是重要的安全防护配置。API 提供通过 VPC ID 或 LB ID查询 GaiaDB 集群能力。 |