概述 | OceanBase 文档中心

为方便调用 API 管理您的 OceanBase 集群资源和开发自己的应用程序，OCP 公开符合 REST 规范的 HTTP API。本文档提供 OCP 开放 API 的描述、语法及示例。文档面向开发人员。在调用接口前，请确保已充分了解 OCP 平台的的相关概念。

API 列表

模块	API 名称	说明
集群信息	查询集群列表	用于查询 OCP 所管理的 OceanBase 集群信息的接口。
集群信息	创建 OceanBase 集群	用于创建 OceanBase 集群的接口。
集群信息	删除 OceanBase 集群	用于删除 OceanBase 集群的接口。
集群信息	停止 OceanBase 集群	用于停止 OceanBase 集群的接口。
集群信息	启动 OceanBase 集群	用于启动 OceanBase 集群的接口。
集群信息	重启 OceanBase 集群	用于重启 OceanBase 集群的接口。
集群信息	升级 OceanBase 集群	用于升级 OceanBase 集群的接口。
集群信息	查 OceanBase 集群的 Zone 列表	用于查询 OceanBase 集群的 Zone 列表。
集群信息	OceanBase 集群新建 Zone	用于为 OceanBase 集群新增 Zone。
集群信息	OceanBase 集群删除 Zone	用于删除指定 OceanBase 集群的 Zone。
集群信息	OceanBase 集群停止 Zone	用于停止指定 OceanBase 集群的 Zone。
集群信息	OceanBase 集群启动 Zone	用于启动目标 OceanBase 集群的 Zone。
集群信息	OceanBase 集群重启 Zone	用于重启指定 OceanBase 集群的 Zone。
集群信息	增加 OBServer 节点	用于为目标 OceanBase 集群增加 OBServer 节点。
集群信息	批量删除 OBServer 节点	用于批量删除目标 OceanBase 集群中的 OBServer 节点。
集群信息	停止 OBServer 节点	用于停止目标 OceanBase 集群的 OBServer 节点。
集群信息	启动 OBServer 节点	用于启动目标 OceanBase 集群的 OBServer 节点。
集群信息	重启 OBServer 节点	用于重启目标 OceanBase 集群的 OBServer 节点。
集群信息	替换 OBServer 节点	用于替换目标 OceanBase 集群中的 OBServer 节点。
集群信息	修改 OceanBase 集群密码	用于修改目标 OceanBase 集群的密码。
集群信息	获取 OceanBase 集群参数元数据	用于获取 OceanBase 集群参数元数据。
集群信息	获取 OceanBase 集群参数列表	用于获取目标 OceanBase 集群的参数列表。
集群信息	修改 OceanBase 集群参数	用于修改目标 OceanBase 集群的参数。
集群信息	查询服务器列表	查询集群下的所有服务器的信息。
集群信息	查询 Zone 的服务器列表	查询集群的指定 Zone 下的服务器的信息。
租户信息	查询集群的租户列表	查询集群的租户列表。
租户信息	查询全部租户列表	查询 OCP 所管理集群的所有租户的信息。
租户信息	查询租户详情	查询指定租户详情。
租户信息	创建租户	在指定的集群下创建单个租户时使用的接口。
租户信息	删除租户	在指定的集群下删除指定租户时使用的接口。
租户信息	锁定租户	在指定的集群下锁定指定租户时使用的接口。
租户信息	解锁租户	在指定的集群下解锁指定租户时使用的接口。
租户信息	查询租户 Unit 列表	查询租户的 Unit 列表。
租户信息	删除租户 Unit	删除租户 Unit 时使用的接口。
租户信息	增加租户副本	为指定租户新增副本。
租户信息	删除租户副本	为指定租户删除副本时使用的接口。
租户信息	修改租户副本	修改指定租户的副本时使用的接口。
租户信息	修改租户 Zone 优先级	修改指定租户的 Zone 优先级时使用的接口。
租户信息	修改租户管理密码	修改指定租户的管理密码时使用的接口。
租户信息	修改租户白名单	修改指定租户的白名单时使用的接口。
租户信息	获取租户参数列表	获取租户参数列表时使用的接口。
租户信息	修改租户参数	该接口用于修改租户的参数。
租户信息	获取数据库列表	获取数据库列表时使用的接口。
租户信息	创建数据库	创建数据库时使用的接口。
租户信息	修改数据库	修改数据库时使用的接口。
租户信息	删除数据库	删除数据库时使用的接口。
主机模块	查询区域列表	查询区域信息列表。
主机模块	查询区域详细信息	根据区域 ID 查询主机区域信息。
主机模块	新增区域	添加主机区域信息。
主机模块	删除区域信息	删除区域信息。
主机模块	查询机房列表	查询机房信息列表。
主机模块	查询机房详细信息	根据机房 ID 查询主机机房信息。
主机模块	新增机房	添加主机机房信息。
主机模块	删除机房信息	删除机房信息。
主机模块	查询机型列表	查询机型信息列表。
主机模块	查询机型详细信息	根据机型 ID 查询主机机房信息。
主机模块	新增机型	添加主机机型信息。
主机模块	删除机型信息	删除机型信息。
主机模块	查询主机列表	查询主机信息列表。
主机模块	查询主机详细信息	根据主机 ID 查询主机详细信息。
主机模块	批量新增主机	批量添加主机信息。
主机模块	删除主机	删除主机信息。
主机模块	批量删除主机	批量删除主机信息。
软件包接口	查询软件包列表	查询 OCP 所管理的软件包信息。可以通过软件包名称关键字、类型、版本、操作系统、架构信息过滤软件包列表，也可以通过上传时间针对列表进行排序。
软件包接口	上传软件包	将本地的软件包上传到 OCP 服务器，可以通过软件包名称关键字、类型、版本、操作系统、架构信息过滤软件包列表，也可以通过上传时间针对列表进行排序。
软件包接口	删除软件包	删除指定的软件包信息。
OBProxy 管理	创建 OBProxy 集群	创建 OBProxy 集群时使用的接口。
OBProxy 管理	删除 OBProxy 集群	删除 OBProxy 集群时使用的接口。
OBProxy 管理	查询 OBProxy 集群列表	查询 OBProxy 集群列表信息时使用的接口。
OBProxy 管理	查询 OBProxy 集群详情	查询 OBProxy 集群详情信息时使用的接口。
OBProxy 管理	更新 OBProxy 集群配置	查询 OBProxy 集群详情信息时使用的接口。
OBProxy 管理	添加 OBProxy	为 OBProxy 集群添加 OBProxy 时使用的接口。
OBProxy 管理	接管 OBProxy	将 OBProxy 接管进 OBProxy 集群时使用的接口。
OBProxy 管理	删除 OBProxy	删除 OBProxy 时使用的接口。
OBProxy 管理	重启 OBProxy	重启 OBProxy 时使用的接口。
OBProxy 管理	升级 OBProxy	升级 OBProxy 使用的接口。
OBProxy 管理	OBProxy 集群添加可连接 OceanBase 集群	为 OBProxy 集群添加可连接 OceanBase 集群。
OBProxy 管理	OBProxy 集群删除可连接 OceanBase 集群	删除 OBProxy 集群和可连接 OceanBase 集群的关联。
OBProxy 管理	查询 OBProxy 参数元数据	查询 OBProxy 参数元数据。
OBProxy 管理	查询 OBProxy 集群参数	查询 OBProxy 集群参数设置。
监控	查询监控指标的元数据	查询 OCP 监控指标的元数据信息，可基于此信息查询指定指标的监控数据。
监控	查询监控数据	查询指定指标的监控数据，需要指定查询的时间区间。
监控	查询监控数据并附带标签	查询指定指标的监控数据，需要指定查询的时间区间，返回结果附带分组标签的值。
告警	查询告警事件列表	查询告警事件列表。
告警	查询告警事件	查询单条告警事件信息。
告警	查询告警通知历史	获取通知历史, 支持搜索条件、接收人、发送时间。
任务管理	查询任务列表	查询任务列表，支持根据不同参数进行过滤。
任务管理	查询任务详情	该接口用于查询任务执行的详细信息。
任务管理	重试任务	触发任务所有失败子任务的重新执行。
任务管理	回滚任务	从所有失败的子任务节点开始回滚。
任务管理	查询子任务实例日志	根据子任务实例 ID 查询子任务执行的日志信息，执行中的子任务多次查询会自动刷新日志信息。
任务管理	重试子任务	重新执行失败的子任务。
任务管理	跳过子任务	跳过失败子任务执行，并且将子任务标记成成功。
任务管理	取消子任务	取消执行中子任务的执行，并且将子任务标记成失败。
OCP 历史事件	查询历史事件	查询 OCP 的历史事件。可以通过事件类型、操作事件名、资源名、操作者 ID、事件信息、事件状态、事件发生的时间段等条件查找历史事件。
OB 用户与权限管理	获取数据库用户详情列表	获取数据库用户详情列表。
OB 用户与权限管理	获取数据库用户详情	获取数据库用户详情。
OB 用户与权限管理	创建数据库用户	创建数据库用户。
OB 用户与权限管理	删除数据库用户	删除数据库用户。
OB 用户与权限管理	修改数据库用户密码	修改数据库用户密码。
OB 用户与权限管理	锁定数据库用户	锁定数据库用户。
OB 用户与权限管理	解锁数据库用户	解锁数据库用户。
OB 用户与权限管理	获取数据库角色详情列表	获取数据库角色详情列表。
OB 用户与权限管理	获取数据库角色详情	获取数据库角色详情。
OB 用户与权限管理	创建数据库角色	创建数据库角色。
OB 用户与权限管理	删除数据库角色	删除数据库角色。
OB 用户与权限管理	获取数据库对象列表	获取数据库对象列表。
OB 用户与权限管理	授予用户全局权限	授予用户全局权限。
OB 用户与权限管理	撤销用户全局权限	撤销用户全局权限。
OB 用户与权限管理	修改用户全局权限	修改用户全局权限。
OB 用户与权限管理	授予角色全局权限	授予角色全局权限。
OB 用户与权限管理	撤销角色全局权限	撤销角色全局权限。
OB 用户与权限管理	修改角色全局权限	修改角色全局权限。
OB 用户与权限管理	授予用户的角色	授予用户的角色。
OB 用户与权限管理	撤销用户的角色	撤销用户的角色。
OB 用户与权限管理	修改用户的角色	修改用户的角色。
OB 用户与权限管理	授予角色的角色	修改角色的角色。
OB 用户与权限管理	撤销角色的角色	撤销角色的角色。
OB 用户与权限管理	修改角色的角色	修改角色的角色。
OB 用户与权限管理	授予用户数据库权限	该接口用于授予用户数据库的权限。
OB 用户与权限管理	撤销用户数据库权限	该接口用于撤销用户对数据库的某些权限。
OB 用户与权限管理	修改用户数据库权限	该接口用于修改用户对数据库的权限。
OB 用户与权限管理	授予用户对象权限	授予用户对象权限。
OB 用户与权限管理	撤销用户对象权限	撤销用户对象权限。
OB 用户与权限管理	修改用户对象权限	修改用户对象权限。
OB 用户与权限管理	授予角色对象权限	授予角色对象权限。
OB 用户与权限管理	撤销角色对象权限	撤销角色对象权限。
OB 用户与权限管理	修改角色对象权限	修改角色对象权限。
OCP Agent 管理	查询主机的 OCP Agent 详情	获取指定主机上 OCP Agent 详细信息。
OCP Agent 管理	停止主机的 OCP Agent 的基础进程	停止指定主机上的 OCP Agent 基础进程。
OCP Agent 管理	批量停止主机的 OCP Agent 的基础进程	批量停止主机的 OCP Agent 的基础进程。
OCP Agent 管理	重启主机的 OCP Agent 的基础进程	重启指定主机上 OCP Agent 的基础进程。
OCP Agent 管理	批量重启主机的 OCP Agent 的基础进程	批量重启主机的 OCP Agent 的基础进程。
OCP Agent 管理	查询主机的 OCP Agent 的工作进程列表	查询主机的 OCP Agent 的工作进程列表。
OCP Agent 管理	重启主机的 OCP Agent 的工作进程	重启时，指定主机上 OCP Agent 的工作进程。
OCP Agent 管理	停止主机的 OCP Agent 的工作进程	停止指定主机上 OCP Agent 工作进程。
SQL 性能	查询 SQL 的性能统计	查询租户的 SQL 性能，按指定的时间区间统计 SQL 的性能。性能数据包括：集群、租户、服务器、数据库、用户、SQL_ID 。
SQL 性能	查询 SQL 的性能统计趋势	查询某一 SQL 在指定时间区间内的性能趋势。
SQL 性能	查询 SQL 的文本	查询指定 ID 的 SQL 的全文本。
SQL 性能	查询执行计划的性能统计	查询指定 SQL 的关联的执行计划的性能。
SQL 性能	查询执行计划的性能统计趋势	查询指定 SQL 的关联的执行计划的性能趋势。
SQL 性能	查询执行计划的算子结构	查询执行计划的操作结构。
备份恢复	查询集群的备份能力	该接口用于查询 OceanBase 集群的备份能力，即是否可备份、支持的备份方式等。
备份恢复	创建集群的备份策略	该接口用于创建集群的备份策略，通过该接口可以设置集群的备份调度的周期、时间和存储地址，以及过期数据清理、告警阈值等。
备份恢复	修改集群的备份策略	该接口用于修改集群的备份策略，通过该接口可以修改集群的备份调度的周期、时间和存储地址，以及过期数据清理、告警阈值，二次备份配置等信息。
备份恢复	删除集群的备份策略	该接口用于删除集群的备份策略。备份策略删除后，集群不再自动备份调度，以及检测相关的告警。
备份恢复	查询指定集群的备份策略	该接口用于查询 OceanBase 集群的备份策略详情。
备份恢复	查询集群的备份概览	该接口用于查询集群的备份概览，包括集群的基本信息，最近一次数据备份时间，日志备份位点，日志延迟时间，以及备份大小等信息。
备份恢复	查询某一集群的数据备份任务	该接口用于查询指定集群的数据备份任务。
备份恢复	查询某一集群的日志备份任务	该接口用于查询某一 OceanBase 集群的日志备份任务。
备份恢复	查询某一集群的恢复任务	该接口用于查询某一集群的恢复任务。
备份恢复	针对某个集群进行立即备份	该接口用于对某个集群发起一次立即备份。
备份恢复	解析集群备份信息	该接口用于解析集群的备份信息。
备份恢复	发起租户恢复	该接口用于将已备份的租户恢复到目标集群。
其他	查询 OCP 应用的基本信息	查询 OCP 应用的基本信息，包括：版本号、构建日期、Java 版本等信息。
其他	查询 OCP 服务端的时间	查询 OCP 服务端的时间，该接口一般用于确认本地时间与服务端时间是否同步。
其他	查询 OCP 应用状态	查询 OCP 应用状态。该接口检查 OCP 应用各模块的状态，返回是否全部状态都处于健康状态。
附录	任务信息	TaskInstance 的数据结构说明。
附录	告警 API 接入示例	为您介绍将 OCP 的告警接入到用户告警平台的操作。