---
title: "概述 - 云平台 OCP V4.3.0 | OceanBase 文档中心"
description: 概述 为方便调用 API 管理您的 OceanBase 集群资源和开发自己的应用程序，OCP 公开符合 REST 规范的 HTTP API。本文档提供 OCP 开放 API 的描述、语法及示例。文档面向开发人员。在调用接口前，请确保已充分了解 OCP 平台的的相关概念。 集群信息 API 列表 模块 API 名称 说…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.3.0

# 概述

更新时间：2026-04-14 11:55:54

[编辑](https://github.com/oceanbase/ocp-doc/edit/V4.3.0/zh-CN/1900.reference-guide/200.api-reference/100.api-overview.md)  

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

## 集群信息 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 集群信息 | [查询集群列表](https://www.oceanbase.com/docs/common-ocp-1000000000827012) | 用于查询 OCP 所管理的 OceanBase 集群信息的接口。 |
| 集群信息 | [创建 OceanBase 集群](https://www.oceanbase.com/docs/common-ocp-1000000000827019) | 用于创建 OceanBase 集群的接口。 |
| 集群信息 | [删除 OceanBase 集群](https://www.oceanbase.com/docs/common-ocp-1000000000827017) | 用于删除 OceanBase 集群的接口。 |
| 集群信息 | [停止 OceanBase 集群](https://www.oceanbase.com/docs/common-ocp-1000000000827033) | 用于停止 OceanBase 集群的接口。 |
| 集群信息 | [启动 OceanBase 集群](https://www.oceanbase.com/docs/common-ocp-1000000000827013) | 用于启动 OceanBase 集群的接口。 |
| 集群信息 | [重启 OceanBase 集群](https://www.oceanbase.com/docs/common-ocp-1000000000827032) | 用于重启 OceanBase 集群的接口。 |
| 集群信息 | [升级 OceanBase 集群](https://www.oceanbase.com/docs/common-ocp-1000000000827031) | 用于升级 OceanBase 集群的接口。 |
| 集群信息 | [查看 OceanBase 集群的 Zone 列表](https://www.oceanbase.com/docs/common-ocp-1000000000827038) | 用于查询 OceanBase 集群的 Zone 列表。 |
| 集群信息 | [OceanBase 集群新建 Zone](https://www.oceanbase.com/docs/common-ocp-1000000000827011) | 用于为 OceanBase 集群新增 Zone。 |
| 集群信息 | [OceanBase 集群删除 Zone](https://www.oceanbase.com/docs/common-ocp-1000000000827014) | 用于删除指定 OceanBase 集群的 Zone。 |
| 集群信息 | [OceanBase 集群停止 Zone](https://www.oceanbase.com/docs/common-ocp-1000000000827026) | 用于停止指定 OceanBase 集群的 Zone。 |
| 集群信息 | [OceanBase 集群启动 Zone](https://www.oceanbase.com/docs/common-ocp-1000000000827018) | 用于启动目标 OceanBase 集群的 Zone。 |
| 集群信息 | [OceanBase 集群重启 Zone](https://www.oceanbase.com/docs/common-ocp-1000000000827008) | 用于重启指定 OceanBase 集群的 Zone。 |
| 集群信息 | [增加 OBServer 节点](https://www.oceanbase.com/docs/common-ocp-1000000000827035) | 用于为目标 OceanBase 集群增加 OBServer 节点。 |
| 集群信息 | [批量删除 OBServer 节点](https://www.oceanbase.com/docs/common-ocp-1000000000827024) | 用于批量删除目标 OceanBase 集群中的 OBServer 节点。 |
| 集群信息 | [停止 OBServer 节点](https://www.oceanbase.com/docs/common-ocp-1000000000827024) | 用于停止目标 OceanBase 集群的 OBServer 节点。 |
| 集群信息 | [启动 OBServer 节点](https://www.oceanbase.com/docs/common-ocp-1000000000826832) | 用于启动目标 OceanBase 集群的 OBServer 节点。 |
| 集群信息 | [重启 OBServer 节点](https://www.oceanbase.com/docs/common-ocp-1000000000827034) | 用于重启目标 OceanBase 集群的 OBServer 节点。 |
| 集群信息 | [替换 OBServer 节点](https://www.oceanbase.com/docs/common-ocp-1000000000827037) | 用于替换目标 OceanBase 集群中的 OBServer 节点。 |
| 集群信息 | [修改 OceanBase 集群密码](https://www.oceanbase.com/docs/common-ocp-1000000000827021) | 用于修改目标 OceanBase 集群的密码。 |
| 集群信息 | [获取 OceanBase 集群参数元数据](https://www.oceanbase.com/docs/common-ocp-1000000000827029) | 用于获取 OceanBase 集群参数元数据。 |
| 集群信息 | [获取 OceanBase 集群参数列表](https://www.oceanbase.com/docs/common-ocp-1000000000827010) | 用于获取目标 OceanBase 集群的参数列表。 |
| 集群信息 | [修改 OceanBase 集群参数](https://www.oceanbase.com/docs/common-ocp-1000000000827020) | 用于修改目标 OceanBase 集群的参数。 |
| 集群信息 | [查询服务器列表](https://www.oceanbase.com/docs/common-ocp-1000000000827015) | 查询集群下的所有服务器的信息。 |
| 集群信息 | [查询 Zone 的服务器列表](https://www.oceanbase.com/docs/common-ocp-1000000000827028) | 查询集群的指定 Zone 下的服务器的信息。 |

## 租户信息 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 租户信息 | [查询集群的租户列表](https://www.oceanbase.com/docs/common-ocp-1000000000827105) | 查询集群的租户列表。 |
| 租户信息 | [查询全部租户列表](https://www.oceanbase.com/docs/common-ocp-1000000000827119) | 查询 OCP 所管理集群的所有租户的信息。 |
| 租户信息 | [查询租户详情](https://www.oceanbase.com/docs/common-ocp-1000000000827114) | 查询指定租户详情。 |
| 租户信息 | [创建租户](https://www.oceanbase.com/docs/common-ocp-1000000000827106) | 在指定的集群下创建单个租户时使用的接口。 |
| 租户信息 | [删除租户](https://www.oceanbase.com/docs/common-ocp-1000000000827115) | 在指定的集群下删除指定租户时使用的接口。 |
| 租户信息 | [锁定租户](https://www.oceanbase.com/docs/common-ocp-1000000000827100) | 在指定的集群下锁定指定租户时使用的接口。 |
| 租户信息 | [解锁租户](https://www.oceanbase.com/docs/common-ocp-1000000000827111) | 在指定的集群下解锁指定租户时使用的接口。 |
| 租户信息 | [查询租户 Unit 列表](https://www.oceanbase.com/docs/common-ocp-1000000000827117) | 查询租户的 Unit 列表。 |
| 租户信息 | [删除租户 Unit](https://www.oceanbase.com/docs/common-ocp-1000000000827103) | 删除租户 Unit 时使用的接口。 |
| 租户信息 | [增加租户副本](https://www.oceanbase.com/docs/common-ocp-1000000000827099) | 为指定租户新增副本。 |
| 租户信息 | [删除租户副本](https://www.oceanbase.com/docs/common-ocp-1000000000827101) | 为指定租户删除副本时使用的接口。 |
| 租户信息 | [修改租户副本](https://www.oceanbase.com/docs/common-ocp-1000000000827109) | 修改指定租户的副本时使用的接口。 |
| 租户信息 | [修改租户 Zone 优先级](https://www.oceanbase.com/docs/common-ocp-1000000000827116) | 修改指定租户的 Zone 优先级时使用的接口。 |
| 租户信息 | [修改租户管理密码](https://www.oceanbase.com/docs/common-ocp-1000000000827102) | 修改指定租户的管理密码时使用的接口。 |
| 租户信息 | [修改租户白名单](https://www.oceanbase.com/docs/common-ocp-1000000000827104) | 修改指定租户的白名单时使用的接口。 |
| 租户信息 | [获取租户参数列表](https://www.oceanbase.com/docs/common-ocp-1000000000827118) | 获取租户参数列表时使用的接口。 |
| 租户信息 | [修改租户参数](https://www.oceanbase.com/docs/common-ocp-1000000000827113) | 该接口用于修改租户的参数。 |
| 租户信息 | [获取数据库列表](https://www.oceanbase.com/docs/common-ocp-1000000000827435) | 获取数据库列表时使用的接口。 |
| 租户信息 | [创建数据库](https://www.oceanbase.com/docs/common-ocp-1000000000827434) | 创建数据库时使用的接口。 |
| 租户信息 | [修改数据库](https://www.oceanbase.com/docs/common-ocp-1000000000827436) | 修改数据库时使用的接口。 |
| 租户信息 | [删除数据库](https://www.oceanbase.com/docs/common-ocp-1000000000827433) | 删除数据库时使用的接口。 |

## 主机 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 主机模块 | [查询区域列表](https://www.oceanbase.com/docs/common-ocp-1000000000827052) | 查询区域信息列表。 |
| 主机模块 | [查询区域详细信息](https://www.oceanbase.com/docs/common-ocp-1000000000827047) | 根据区域 ID 查询主机区域信息。 |
| 主机模块 | [新增区域](https://www.oceanbase.com/docs/common-ocp-1000000000827053) | 添加主机区域信息。 |
| 主机模块 | [删除区域信息](https://www.oceanbase.com/docs/common-ocp-1000000000827051) | 删除区域信息。 |
| 主机模块 | [查询机房列表](https://www.oceanbase.com/docs/common-ocp-1000000000827041) | 查询机房信息列表。 |
| 主机模块 | [查询机房详细信息](https://www.oceanbase.com/docs/common-ocp-1000000000827055) | 根据机房 ID 查询主机机房信息。 |
| 主机模块 | [新增机房](https://www.oceanbase.com/docs/common-ocp-1000000000827039) | 添加主机机房信息。 |
| 主机模块 | [删除机房信息](https://www.oceanbase.com/docs/common-ocp-1000000000827040) | 删除机房信息。 |
| 主机模块 | [查询机型列表](https://www.oceanbase.com/docs/common-ocp-1000000000827044) | 查询机型信息列表。 |
| 主机模块 | [查询机型详细信息](https://www.oceanbase.com/docs/common-ocp-1000000000827049) | 根据机型 ID 查询主机机房信息。 |
| 主机模块 | [新增机型](https://www.oceanbase.com/docs/common-ocp-1000000000827046) | 添加主机机型信息。 |
| 主机模块 | [删除机型信息](https://www.oceanbase.com/docs/common-ocp-1000000000827048) | 删除机型信息。 |
| 主机模块 | [查询主机列表](https://www.oceanbase.com/docs/common-ocp-1000000000827050) | 查询主机信息列表。 |
| 主机模块 | [查询主机详细信息](https://www.oceanbase.com/docs/common-ocp-1000000000827043) | 根据主机 ID 查询主机详细信息。 |
| 主机模块 | [批量新增主机](https://www.oceanbase.com/docs/common-ocp-1000000000827045) | 批量添加主机信息。 |
| 主机模块 | [删除主机](https://www.oceanbase.com/docs/common-ocp-1000000000827042) | 删除主机信息。 |
| 主机模块 | [批量删除主机](https://www.oceanbase.com/docs/common-ocp-1000000000827054) | 批量删除主机信息。 |

## 软件包 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 软件包接口 | [查询软件包列表](https://www.oceanbase.com/docs/common-ocp-1000000000827057) | 查询 OCP 所管理的软件包信息。可以通过软件包名称关键字、类型、版本、操作系统、架构信息过滤软件包列表，也可以通过上传时间针对列表进行排序。 |
| 软件包接口 | [上传软件包](https://www.oceanbase.com/docs/common-ocp-1000000000827056) | 将本地的软件包上传到 OCP 服务器，可以通过软件包名称关键字、类型、版本、操作系统、架构信息过滤软件包列表，也可以通过上传时间针对列表进行排序。 |
| 软件包接口 | [删除软件包](https://www.oceanbase.com/docs/common-ocp-1000000000827058) | 删除指定的软件包信息。 |

## OBProxy API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| OBProxy 管理 | [创建 OBProxy 集群](https://www.oceanbase.com/docs/common-ocp-1000000000827083) | 创建 OBProxy 集群时使用的接口。 |
| OBProxy 管理 | [删除 OBProxy 集群](https://www.oceanbase.com/docs/common-ocp-1000000000827081) | 删除 OBProxy 集群时使用的接口。 |
| OBProxy 管理 | [查询 OBProxy 集群列表](https://www.oceanbase.com/docs/common-ocp-1000000000827085) | 查询 OBProxy 集群列表信息时使用的接口。 |
| OBProxy 管理 | [查询 OBProxy 集群详情](https://www.oceanbase.com/docs/common-ocp-1000000000827074) | 查询 OBProxy 集群详情信息时使用的接口。 |
| OBProxy 管理 | [更新 OBProxy 集群配置](https://www.oceanbase.com/docs/common-ocp-1000000000827086) | 查询 OBProxy 集群详情信息时使用的接口。 |
| OBProxy 管理 | [添加 OBProxy](https://www.oceanbase.com/docs/common-ocp-1000000000827079) | 为 OBProxy 集群添加 OBProxy 时使用的接口。 |
| OBProxy 管理 | [接管 OBProxy](https://www.oceanbase.com/docs/common-ocp-1000000000827077) | 将 OBProxy 接管进 OBProxy 集群时使用的接口。 |
| OBProxy 管理 | [删除 OBProxy](https://www.oceanbase.com/docs/common-ocp-1000000000827087) | 删除 OBProxy 时使用的接口。 |
| OBProxy 管理 | [重启 OBProxy](https://www.oceanbase.com/docs/common-ocp-1000000000827084) | 重启 OBProxy 时使用的接口。 |
| OBProxy 管理 | [升级 OBProxy](https://www.oceanbase.com/docs/common-ocp-1000000000827078) | 升级 OBProxy 使用的接口。 |
| OBProxy 管理 | [OBProxy 集群添加可连接 OceanBase 集群](https://www.oceanbase.com/docs/common-ocp-1000000000826436) | 为 OBProxy 集群添加可连接 OceanBase 集群。 |
| OBProxy 管理 | [OBProxy 集群删除可连接 OceanBase 集群](https://www.oceanbase.com/docs/common-ocp-1000000000827080) | 删除 OBProxy 集群和可连接 OceanBase 集群的关联。 |
| OBProxy 管理 | [查询 OBProxy 参数元数据](https://www.oceanbase.com/docs/common-ocp-1000000000827076) | 查询 OBProxy 参数元数据。 |
| OBProxy 管理 | [查询 OBProxy 集群参数](https://www.oceanbase.com/docs/common-ocp-1000000000827075) | 查询 OBProxy 集群参数设置。 |

## 监控 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 监控 | [查询监控指标的元数据](https://www.oceanbase.com/docs/common-ocp-1000000000827088) | 查询 OCP 监控指标的元数据信息，可基于此信息查询指定指标的监控数据。 |
| 监控 | [查询监控数据](https://www.oceanbase.com/docs/common-ocp-1000000000827089) | 查询指定指标的监控数据，需要指定查询的时间区间。 |
| 监控 | [查询监控数据并附带标签](https://www.oceanbase.com/docs/common-ocp-1000000000827090) | 查询指定指标的监控数据，需要指定查询的时间区间，返回结果附带分组标签的值。 |

## 告警 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 告警 | [获取当前告警](https://www.oceanbase.com/docs/common-ocp-1000000003563831) | 获取当前告警。 |
| 告警 | [获取告警历史](https://www.oceanbase.com/docs/common-ocp-1000000003563832) | 获取告警历史。 |
| 告警 | [查询告警事件](https://www.oceanbase.com/docs/common-ocp-1000000000826896) | 查询告警事件。 |

## 任务管理 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 任务管理 | [查询任务列表](https://www.oceanbase.com/docs/common-ocp-1000000000827093) | 查询任务列表，支持根据不同参数进行过滤。 |
| 任务管理 | [查询任务详情](https://www.oceanbase.com/docs/common-ocp-1000000000827098) | 该接口用于查询任务执行的详细信息。 |
| 任务管理 | [重试任务](https://www.oceanbase.com/docs/common-ocp-1000000000827095) | 触发任务所有失败子任务的重新执行。 |
| 任务管理 | [回滚任务](https://www.oceanbase.com/docs/common-ocp-1000000000827097) | 从所有失败的子任务节点开始回滚。 |
| 任务管理 | [查询子任务实例日志](https://www.oceanbase.com/docs/common-ocp-1000000000827092) | 根据子任务实例 ID 查询子任务执行的日志信息，执行中的子任务多次查询会自动刷新日志信息。 |
| 任务管理 | [重试子任务](https://www.oceanbase.com/docs/common-ocp-1000000000827094) | 重新执行失败的子任务。 |
| 任务管理 | [跳过子任务](https://www.oceanbase.com/docs/common-ocp-1000000000827091) | 跳过失败子任务执行，并且将子任务标记成成功。 |
| 任务管理 | [取消子任务](https://www.oceanbase.com/docs/common-ocp-1000000000827096) | 取消执行中子任务的执行，并且将子任务标记成失败。 |

## OCP 历史事件 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| OCP 历史事件 | [查询历史事件](https://www.oceanbase.com/docs/common-ocp-1000000000827073) | 查询 OCP 的历史事件。可以通过事件类型、操作事件名、资源名、操作者 ID、事件信息、事件状态、事件发生的时间段等条件查找历史事件。 |

## OceanBase 用户与权限 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| OceanBase 用户与权限管理 | [获取数据库用户详情列表](https://www.oceanbase.com/docs/common-ocp-1000000000827159) | 获取数据库用户详情列表。 |
| OceanBase 用户与权限管理 | [获取数据库用户详情](https://www.oceanbase.com/docs/common-ocp-1000000000827164) | 获取数据库用户详情。 |
| OceanBase 用户与权限管理 | [创建数据库用户](https://www.oceanbase.com/docs/common-ocp-1000000000827168) | 创建数据库用户。 |
| OceanBase 用户与权限管理 | [删除数据库用户](https://www.oceanbase.com/docs/common-ocp-1000000000827150) | 删除数据库用户。 |
| OceanBase 用户与权限管理 | [修改数据库用户密码](https://www.oceanbase.com/docs/common-ocp-1000000000827155) | 修改数据库用户密码。 |
| OceanBase 用户与权限管理 | [锁定数据库用户](https://www.oceanbase.com/docs/common-ocp-1000000000827167) | 锁定数据库用户。 |
| OceanBase 用户与权限管理 | [解锁数据库用户](https://www.oceanbase.com/docs/common-ocp-1000000000827165) | 解锁数据库用户。 |
| OceanBase 用户与权限管理 | [获取数据库角色详情列表](https://www.oceanbase.com/docs/common-ocp-1000000000827157) | 获取数据库角色详情列表。 |
| OceanBase 用户与权限管理 | [获取数据库角色详情](https://www.oceanbase.com/docs/common-ocp-1000000000827171) | 获取数据库角色详情。 |
| OceanBase 用户与权限管理 | [创建数据库角色](https://www.oceanbase.com/docs/common-ocp-1000000000827166) | 创建数据库角色。 |
| OceanBase 用户与权限管理 | [删除数据库角色](https://www.oceanbase.com/docs/common-ocp-1000000000827156) | 删除数据库角色。 |
| OceanBase 用户与权限管理 | [获取数据库对象列表](https://www.oceanbase.com/docs/common-ocp-1000000000827142) | 获取数据库对象列表。 |
| OceanBase 用户与权限管理 | [授予用户全局权限](https://www.oceanbase.com/docs/common-ocp-1000000000827169) | 授予用户全局权限。 |
| OceanBase 用户与权限管理 | [撤销用户全局权限](https://www.oceanbase.com/docs/common-ocp-1000000000827174) | 撤销用户全局权限。 |
| OceanBase 用户与权限管理 | [修改用户全局权限](https://www.oceanbase.com/docs/common-ocp-1000000000827172) | 修改用户全局权限。 |
| OceanBase 用户与权限管理 | [授予角色全局权限](https://www.oceanbase.com/docs/common-ocp-1000000000827173) | 授予角色全局权限。 |
| OceanBase 用户与权限管理 | [撤销角色全局权限](https://www.oceanbase.com/docs/common-ocp-1000000000827154) | 撤销角色全局权限。 |
| OceanBase 用户与权限管理 | [修改角色全局权限](https://www.oceanbase.com/docs/common-ocp-1000000000827158) | 修改角色全局权限。 |
| OceanBase 用户与权限管理 | [授予用户的角色](https://www.oceanbase.com/docs/common-ocp-1000000000827160) | 授予用户的角色。 |
| OceanBase 用户与权限管理 | [撤销用户的角色](https://www.oceanbase.com/docs/common-ocp-1000000000827170) | 撤销用户的角色。 |
| OceanBase 用户与权限管理 | [修改用户的角色](https://www.oceanbase.com/docs/common-ocp-1000000000827162) | 修改用户的角色。 |
| OceanBase 用户与权限管理 | [授予角色的角色](https://www.oceanbase.com/docs/common-ocp-1000000000827144) | 修改角色的角色。 |
| OceanBase 用户与权限管理 | [撤销角色的角色](https://www.oceanbase.com/docs/common-ocp-1000000000827152) | 撤销角色的角色。 |
| OceanBase 用户与权限管理 | [修改角色的角色](https://www.oceanbase.com/docs/common-ocp-1000000000827145) | 修改角色的角色。 |
| OceanBase 用户与权限管理 | [授予用户数据库权限](https://www.oceanbase.com/docs/common-ocp-1000000000827146) | 该接口用于授予用户数据库的权限。 |
| OceanBase 用户与权限管理 | [撤销用户数据库权限](https://www.oceanbase.com/docs/common-ocp-1000000000827147) | 该接口用于撤销用户对数据库的某些权限。 |
| OceanBase 用户与权限管理 | [修改用户数据库权限](https://www.oceanbase.com/docs/common-ocp-1000000000827163) | 该接口用于修改用户对数据库的权限。 |
| OceanBase 用户与权限管理 | [授予用户对象权限](https://www.oceanbase.com/docs/common-ocp-1000000000827149) | 授予用户对象权限。 |
| OceanBase 用户与权限管理 | [撤销用户对象权限](https://www.oceanbase.com/docs/common-ocp-1000000000827143) | 撤销用户对象权限。 |
| OceanBase 用户与权限管理 | [修改用户对象权限](https://www.oceanbase.com/docs/common-ocp-1000000000827153) | 修改用户对象权限。 |
| OceanBase 用户与权限管理 | [授予角色对象权限](https://www.oceanbase.com/docs/common-ocp-1000000000827148) | 授予角色对象权限。 |
| OceanBase 用户与权限管理 | [撤销角色对象权限](https://www.oceanbase.com/docs/common-ocp-1000000000827151) | 撤销角色对象权限。 |
| OceanBase 用户与权限管理 | [修改角色对象权限](https://www.oceanbase.com/docs/common-ocp-1000000000827161) | 修改角色对象权限。 |

## Agent 管理 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| OCP Agent 管理 | [查询主机的 OCP Agent 详情](https://www.oceanbase.com/docs/common-ocp-1000000000827068) | 获取指定主机上 OCP Agent 详细信息。 |
| OCP Agent 管理 | [停止主机的 OCP Agent 的基础进程](https://www.oceanbase.com/docs/common-ocp-1000000000827072) | 停止指定主机上的 OCP Agent 基础进程。 |
| OCP Agent 管理 | [批量停止主机的 OCP Agent 的基础进程](https://www.oceanbase.com/docs/common-ocp-1000000000827069) | 批量停止主机的 OCP Agent 的基础进程。 |
| OCP Agent 管理 | [重启主机的 OCP Agent 的基础进程](https://www.oceanbase.com/docs/common-ocp-1000000000827071) | 重启指定主机上 OCP Agent 的基础进程。 |
| OCP Agent 管理 | [批量重启主机的 OCP Agent 的基础进程](https://www.oceanbase.com/docs/common-ocp-1000000000827066) | 批量重启主机的 OCP Agent 的基础进程。 |
| OCP Agent 管理 | [查询主机的 OCP Agent 的工作进程列表](https://www.oceanbase.com/docs/common-ocp-1000000000827067) | 查询主机的 OCP Agent 的工作进程列表。 |
| OCP Agent 管理 | [重启主机的 OCP Agent 的工作进程](https://www.oceanbase.com/docs/common-ocp-1000000000827070) | 重启时，指定主机上 OCP Agent 的工作进程。 |
| OCP Agent 管理 | [停止主机的 OCP Agent 的工作进程](https://www.oceanbase.com/docs/common-ocp-1000000000827065) | 停止指定主机上 OCP Agent 工作进程。 |

## SQL 性能 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| SQL 性能 | [查询 SQL 的性能统计](https://www.oceanbase.com/docs/common-ocp-1000000000827060) | 查询租户的 SQL 性能，按指定的时间区间统计 SQL 的性能。性能数据包括：集群、租户、服务器、数据库、用户、SQL_ID 。 |
| SQL 性能 | [查询 SQL 的性能统计趋势](https://www.oceanbase.com/docs/common-ocp-1000000000827063) | 查询某一 SQL 在指定时间区间内的性能趋势。 |
| SQL 性能 | [查询 SQL 的文本](https://www.oceanbase.com/docs/common-ocp-1000000000827062) | 查询指定 ID 的 SQL 的全文本。 |
| SQL 性能 | [查询执行计划的性能统计](https://www.oceanbase.com/1500.sql-performance/400.query-performance-indicators-of-an-execution-plan.md) | 查询指定 SQL 的关联的执行计划的性能。 |
| SQL 性能 | [查询执行计划的性能统计趋势](https://www.oceanbase.com/docs/common-ocp-1000000000827061) | 查询指定 SQL 的关联的执行计划的性能趋势。 |
| SQL 性能 | [查询执行计划的算子结构](https://www.oceanbase.com/docs/common-ocp-1000000000827059) | 查询执行计划的操作结构。 |

## 性能报告 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 性能报告 | [查询快照点信息](https://www.oceanbase.com/docs/common-ocp-1000000000978946) | 查询指定集群的快照点信息。 |
| 性能报告 | [生成性能报告](https://www.oceanbase.com/docs/common-ocp-1000000000978947) | 生成集群的性能报告。 |
| 性能报告 | [查询性能报告](https://www.oceanbase.com/docs/common-ocp-1000000000978948) | 查询集群的性能报告。 |

## 备份恢复 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 备份恢复 | [查询集群的备份能力](https://www.oceanbase.com/docs/common-ocp-1000000000827134) | 该接口用于查询 OceanBase 集群的备份能力，即是否可备份、支持的备份方式等。 |
| 备份恢复 | [创建集群的备份策略](https://www.oceanbase.com/docs/common-ocp-1000000000827130) | 该接口用于创建集群的备份策略，通过该接口可以设置集群的备份调度的周期、时间和存储地址，以及过期数据清理、告警阈值等。 |
| 备份恢复 | [修改集群的备份策略](https://www.oceanbase.com/docs/common-ocp-1000000000827136) | 该接口用于修改集群的备份策略，通过该接口可以修改集群的备份调度的周期、时间和存储地址，以及过期数据清理、告警阈值，二次备份配置等信息。 |
| 备份恢复 | [删除集群的备份策略](https://www.oceanbase.com/docs/common-ocp-1000000000827138) | 该接口用于删除集群的备份策略。备份策略删除后，集群不再自动备份调度，以及检测相关的告警。 |
| 备份恢复 | [查询指定集群的备份策略](https://www.oceanbase.com/docs/common-ocp-1000000000827135) | 该接口用于查询 OceanBase 集群的备份策略详情。 |
| 备份恢复 | [查询集群的备份概览](https://www.oceanbase.com/docs/common-ocp-1000000000827137) | 该接口用于查询集群的备份概览，包括集群的基本信息，最近一次数据备份时间，日志备份位点，日志延迟时间，以及备份大小等信息。 |
| 备份恢复 | [查询某一集群的数据备份任务](https://www.oceanbase.com/docs/common-ocp-1000000000827132) | 该接口用于查询指定集群的数据备份任务。 |
| 备份恢复 | [查询某一集群的日志备份任务](https://www.oceanbase.com/docs/common-ocp-1000000000827124) | 该接口用于查询某一 OceanBase 集群的日志备份任务。 |
| 备份恢复 | [查询某一集群的恢复任务](https://www.oceanbase.com/docs/common-ocp-1000000000827128) | 该接口用于查询某一集群的恢复任务。 |
| 备份恢复 | [针对某个集群进行立即备份](https://www.oceanbase.com/docs/common-ocp-1000000000827126) | 该接口用于对某个集群发起一次立即备份。 |
| 备份恢复 | [解析集群备份信息](https://www.oceanbase.com/docs/common-ocp-1000000000827129) | 该接口用于解析集群的备份信息。 |
| 备份恢复 | [发起租户恢复](https://www.oceanbase.com/docs/common-ocp-1000000000827131) | 该接口用于将已备份的租户恢复到目标集群。 |

## 健康检查 API 列表

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 健康检查 | [查询 OCP 应用的基本信息](https://www.oceanbase.com/docs/common-ocp-1000000000827121) | 查询 OCP 应用的基本信息，包括：版本号、构建日期、Java 版本等信息。 |
| 健康检查 | [查询 OCP 服务端的时间](https://www.oceanbase.com/docs/common-ocp-1000000000827123) | 查询 OCP 服务端的时间，该接口一般用于确认本地时间与服务端时间是否同步。 |
| 健康检查 | [查询 OCP 应用状态](https://www.oceanbase.com/docs/common-ocp-1000000000827122) | 查询 OCP 应用状态。该接口检查 OCP 应用各模块的状态，返回是否全部状态都处于健康状态。 |

## 附录

| 模块 | API 名称 | 说明 |
| --- | --- | --- |
| 附录 | [任务返回结构](https://www.oceanbase.com/docs/common-ocp-1000000000826896) | TaskInstance 的数据结构说明。 |
| 附录 | [告警 API 接入示例](https://www.oceanbase.com/docs/common-ocp-1000000000827139) | 为您介绍将 OCP 的告警接入到用户告警平台的操作。 |

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线