本产品（
云数据库 OceanBase 版/2019-09-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
集群管理
| API | 标题 | API概述 |
|---|---|---|
| CreateInstance | 创建集群 | 创建一个 OceanBase 数据库集群。 |
| DescribeInstance | 查询集群信息 | 查询一个 OceanBase 集群的详细信息。 |
| DescribeInstances | 查询集群列表 | 查询 OceanBase 集群列表信息。 |
| DescribeInstanceTopology | 查询集群拓扑信息 | 查询某个 OceanBase 集群的拓扑信息。 |
| DescribeInstanceTags | 查询集群标签值 | 查询集群的标签值。 |
| ModifyInstanceName | 修改集群名称 | 修改 OceanBase 的集群名称。 |
| ModifyInstanceTags | 修改集群标签值 | 修改集群的标签值。 |
| ModifyInstanceSpec | 修改集群规格和存储空间 | 修改集群规格和存储空间 |
| ModifyInstanceNodeNum | 修改集群节点个数 | 修改集群节点个数 |
租户管理
| API | 标题 | API概述 |
|---|---|---|
| CreateTenant | 创建租户 | 创建一个租户。 |
| CreateTenantReadOnlyConnection | 创建只读地址 | 为指定租户创建一个只读地址。 |
| DescribeTenants | 查询集群下的租户列表信息 | 查询指定 OceanBase 集群列表下的租户列表信息。 |
| DescribeInstanceTenantModes | 查询租户模式列表信息 | 该接口用于查询租户模式列表信息。 |
| DescribeTenant | 查询指定集群下的指定租户信息 | 查看指定集群下的指定租户信息。 |
| DescribeAvailableCpuResource | 查询可查询的 CPU 资源信息 | 查询创建租户允许的 CPU 资源信息。 |
| DescribeAvailableMemResource | 查询内存资源信息 | 查询 OceanBase 租户的内存资源信息。 |
| DescribeCharset | 获取字符集 | 查询 OceanBase 租户的字符集信息。 |
| DescribeInstanceCreatableZone | 查询可用区信息 | 查询集群可创建主可用区的可用区信息。 |
| DescribeTenantZonesRead | 查询租户只读可用区信息 | 查询租户的只读可用区信息。 |
| DescribeTimeZones | 获取时区列表 | 查询 OceanBase 租户的时区信息。 |
| DescribeZones | 获取可用区信息 | 获取一个阿里云地域下可创建集群的可用区信息。 |
| DescribeTenantTags | 查询租户标签值 | 查询租户的标签值。 |
| ModifyTenantPrimaryZone | 切换租户主可用区 | 切换租户的主可用区。 |
| ModifyTenantResource | 修改租户资源 | 修改指定 OceanBase 集群的一个租户的规格。 |
| ModifyTenantTags | 修改租户标签值 | 修改租户的标签值。 |
| DeleteTenants | 删除租户 | 删除指定 OceanBase 集群下的一个或多个租户。 |
租户账号管理
| API | 标题 | API概述 |
|---|---|---|
| CreateTenantUser | 创建租户用户 | 在指定租户下创建一个新的数据库。 |
| DescribeTenantUsers | 查询租户账号列表 | 查询一个租户下所有数据库访问的账号列表。 |
| DescribeTenantUserRoles | 查询租户账号授权信息 | 获取该租户所支持的账号授权信息。 |
| ModifyTenantUserDescription | 修改租户账号备注信息 | 修改租户下指定的数据库账号的备注信息。 |
| ModifyTenantUserPassword | 修改租户用户密码 | 修改租户下指定的数据库账号的登录密码。 |
| ModifyTenantUserRoles | 获取租户用户角色 | 修改租户下指定账号可访问的数据库权限信息。 |
| DeleteTenantUsers | 删除租户用户 | 删除一个或多个数据库账号列表。 |
数据库管理
| API | 标题 | API概述 |
|---|---|---|
| CreateDatabase | 创建数据库 | 在指定租户下创建一个新的数据库。 |
| DescribeDatabases | 查询数据库列表 | 查询租户下的数据库列表。 |
| ModifyDatabaseDescription | 修改数据库描述 | 修改数据库的描述信息。 |
| ModifyTenantUserStatus | 锁定或解锁指定的数据库账号 | 该接口用于锁定或解锁指定的数据库账号。 |
| ModifyDatabaseUserRoles | 修改数据库用户角色 | 修改某一数据库的账号权限信息。 |
| DeleteDatabases | 删除数据库 | 删除指定 OceanBase 集群下的一个或多个租户。 |
| DeleteInstances | 释放 OceanBase 实例 | 调用接口释放 OceanBase 实例。 |
参数管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeParameters | 查看参数信息列表 | 查看参数信息列表。 |
| DescribeParametersHistory | 查看参数修改历史 | 查看集群或租户的参数修改历史。 |
| ModifyParameters | 修改参数 | 修改集群或租户的参数。 |
安全设置
| API | 标题 | API概述 |
|---|---|---|
| CreateSecurityIpGroup | 创建白名单组 | 创建一个 IP 白名单组。 |
| DescribeSecurityIpGroups | 查询 IP 安全白名单分组列表 | 查看 IP 安全白名单分组列表。 |
| DescribeTenantSecurityConfigs | 租户安全配置检测 | 租户安全配置检测。 |
| DescribeInstanceSecurityConfigs | 集群安全配置检测 | 集群安全配置检测。 |
| ModifySecurityIps | 修改 IP 列表 | 修改分组内的 IP 列表。 |
| DeleteSecurityIpGroup | 删除白名单分组 | 删除 Oceanbase 集群的某个 IP 白名单分组。 |
监控管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeNodeMetrics | 查询节点指标信息 | 查询一个 OceanBase 节点指标信息。 |
| DescribeTenantMetrics | 查询租户指标信息 | 查询指定 OceanBase 租户指标信息。 |
诊断管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeAnomalySQLList | 查询可疑 SQL 列表 | 查询诊断系统判定认为可能存在性能问题的 SQL 列表。 |
| DescribeOutlineBinding | 查询 Outline 绑定信息 | 根据 SQLID 查询一条 SQL 在数据库中被绑定的 Outline 信息或限流信息。 |
| DescribeRecommendIndex | 查询 SQL 索引推荐信息 | 根据 SQLID 查询诊断系统对 SQL 的索引推荐信息。 |
| DescribeSlowSQLHistoryList | 查询慢 SQL 历史列表 | 根据 SQLID 查询一条 SQL 在时间段内的被判定为 Slow SQL 时的执行历史。 |
| DescribeSQLDetails | 查询 SQL 文本信息 | 根据 SQLID 查询一条 SQL 的 SQL 文本信息。 |
| DescribeSlowSQLList | 查询慢 SQL 列表 | 查询慢 SQL 列表。 |
| DescribeSQLHistoryList | 查询 SQL 执行历史 | 根据 SQLID 查询一条 SQL 在时间段内的执行历史。 |
| DescribeSQLPlans | 查询 SQL 执行计划 | 根据 SQLID 查询诊断系统存储的 SQL 执行计划信息。 |
| DescribeTopSQLList | 查询 TopSQL 列表 | 查询诊断系统采集到的 SQL 执行性能数据列表。 |
数据传输
| API | 标题 | API概述 |
|---|---|---|
| CreateOmsMysqlDataSource | 创建 OMS MySQL 数据源 | 创建 OMS MySQL 数据源。 |
| CreateOmsOpenAPIProject | 创建数据同步项目 | 创建数据同步项目。 |
| DescribeOmsOpenAPIProject | 查询指定项目的详情 | 查询指定项目的项目详情。 |
| DescribeOmsOpenAPIProjectSteps | 查询指定项目的步骤详情 | 查询指定项目的步骤详情。 |
| SearchOmsOpenAPIMonitorMetric | 查询指定项目的监控指标 | 查询指定项目的监控指标。 |
| SearchOmsOpenAPIProjects | 模糊搜索项目 | 模糊搜索项目。 |
| StartOmsOpenAPIProject | 启动数据同步项目 | 启动项目。 |
| StopOmsOpenAPIProject | 暂停数据同步项目 | 暂停任务。 |
| ResumeOmsOpenAPIProject | 恢复数据同步项目 | 恢复数据同步项目。 |
| ResetOmsOpenAPIProject | 重置数据同步项目 | 重置数据同步项目。 |
| ReleaseOmsOpenAPIProject | 释放数据同步项目 | 释放数据同步项目。 |
| DeleteOmsOpenAPIProject | 删除数据同步项目 | 删除数据同步项目。 |
| DeleteOmsOpenAPIProject | 删除数据同步项目 | 删除数据同步项目。 |