API概览

API标准及多语言预置SDK

本产品（OceanBasePro/2019-09-01）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

标签管理

API	标题	API概述
ModifyTagValueName	修改标签名	该接口用于修改标签名称。
ModifyTagName	修改标签组名	该接口用于修改标签组的名称。
DescribeTagValues	查询标签	该接口用于查询标签。
DeleteTagValue	删除标签	该接口用于删除标签。
DeleteTag	删除标签组	该接口用于删除标签组。
CreateTagValue	创建标签	该接口用于新建标签。
CreateTag	创建标签组	该接口用于新建标签组。
ModifyInstanceTags	修改集群标签值	该接口用于修改集群的标签值。
DescribeTenantTags	查询租户标签值	该接口用于查询租户的标签值。
ModifyTenantTags	修改租户标签值	该接口用于修改租户的标签值。
DescribeInstanceTags	查询集群标签值	查询集群的标签值。

集群管理

API	标题	API概述
CreateInstance	创建集群	创建一个 OceanBase 数据库集群。
DescribeInstance	查询集群信息	查询一个 OceanBase 集群的详细信息。
DescribeInstances	查询集群列表	查询 OceanBase 集群列表信息。
DescribeInstanceTopology	查询集群拓扑信息	查询某个 OceanBase 集群的拓扑信息。
DescribeAvailableSpec	查询集群变配可选配置	查询 OceanBase 集群变配页可选配置。
DescribeAvailableZone	查询创建集群可选配置	查询 OceanBase 集群售卖页可选配置。
DescribeInstanceCreatableZone	查询可用区信息	查询集群可创建主可用区的可用区信息。
ModifyInstanceName	修改集群名称	修改 OceanBase 的集群名称。
ModifyInstanceSpec	修改集群规格和存储空间	修改集群规格和存储空间。
ModifyInstanceNodeNum	修改集群节点个数	修改集群节点个数。
ModifyInstanceTemporaryCapacity	修改集群临时容量	修改 OceanBase 集群临时容量。
SwitchoverInstance	切换主备实例	切换 OceanBase 主备实例。
RemoveStandbyInstance	解耦备实例	备实例解耦
DeleteInstances	释放 OceanBase 实例	调用接口释放 OceanBase 实例。
DescribeInstanceSummary	获取实例概览信息	获取 OceanBase 实例概览信息。
DescribeStandbyCreateMode	获取创建备集群模式	获取 OceanBase 创建备集群模式

租户管理

API	标题	API概述
DescribeTenantReadableScn	查询租户的最大可读位点	该接口用于查询租户的最大可读位点。
CreateTenant	创建租户	创建一个租户。
CreateTenantReadOnlyConnection	创建只读地址	为指定租户创建一个只读地址。
CreateTenantSecurityIpGroup	创建租户安全白名单信息	创建租户安全白名单信息。
DescribeTenants	查询集群下的租户列表信息	查询指定 OceanBase 集群列表下的租户列表信息。
DescribeInstanceTenantModes	查询租户模式列表信息	该接口用于查询租户模式列表信息。
DescribeTenant	查询指定集群下的指定租户信息	查看指定集群下的指定租户信息。
DescribeAvailableCpuResource	查询可用的 CPU 资源信息	查询创建租户允许的 CPU 资源信息。
DescribeAvailableMemResource	查询内存资源信息	查询 OceanBase 租户的内存资源信息。
DescribeCharset	获取字符集	查询 OceanBase 租户的字符集信息。
DescribeInstanceAvailableZones	查询可用区信息	查询集群可创建主可用区的可用区信息。
DescribeTenantZonesRead	查询租户只读可用区信息	查询租户的只读可用区信息。
DescribeTimeZones	获取时区列表	查询 OceanBase 租户的时区信息。
DescribeTenantSecurityIpGroups	查看租户白名单分组列表	查看租户白名单分组列表。
DescribeZones	获取可用区信息	获取一个阿里云地域下可创建集群的可用区信息。
ModifyTenantPrimaryZone	切换租户主可用区	切换租户的主可用区。
ModifyTenantResource	修改租户资源	修改指定 OceanBase 集群的一个租户的规格。
ModifyTenantSecurityIpGroup	修改租户白名单分组信息	修改租户白名单分组信息。
DeleteTenants	删除租户	删除指定 OceanBase 集群下的一个或多个租户。
DeleteTenantSecurityIpGroup	删除租户白名单分组信息	删除租户白名单分组信息。

租户账号管理

API	标题	API概述
CreateTenantUser	创建租户用户	在指定租户下创建一个访问数据库的账号。
DescribeTenantUsers	查询租户账号列表	查询一个租户下所有数据库访问的账号列表。
DescribeTenantUserRoles	获取普通用户的权限配置信息	获取普通用户的权限配置信息。
ModifyTenantUserDescription	修改租户账号备注信息	修改租户下指定的数据库账号的备注信息。
ModifyTenantUserPassword	修改租户用户密码	修改租户下指定的数据库账号的登录密码。
ModifyTenantUserRoles	修改租户用户角色	修改租户下指定账号可访问的数据库权限信息。
DeleteTenantUsers	删除租户用户	删除一个或多个数据库账号列表。

数据库管理

API	标题	API概述
CreateDatabase	创建数据库	在指定租户下创建一个新的数据库。
DescribeDatabases	查询数据库列表	查询租户下的数据库列表。
ModifyDatabaseDescription	修改数据库描述	修改数据库的描述信息。
ModifyTenantUserStatus	锁定或解锁指定的数据库账号	该接口用于锁定或解锁指定的数据库账号。
ModifyDatabaseUserRoles	修改数据库用户角色	修改某一数据库的账号权限信息。
DeleteDatabases	删除数据库	删除一个或多个已创建的数据库。

参数管理

API	标题	API概述
DescribeParameters	查看参数信息列表	查看参数信息列表。
DescribeParametersHistory	查看参数修改历史	查看集群或租户的参数修改历史。
ModifyParameters	修改参数	修改集群或租户的参数。

会话连接

API	标题	API概述
DescribeSessionList	查询会话列表	该接口用于展示 OceanBase 云服务和业务之间的会话信息。
BatchKillSessionList	批量关闭会话列表	该接口用于批量关闭 OceanBase 云服务和业务之间的会话信息。该接口为异步执行，需要用户通过 DescribeSessionList 验证会话是否关闭成功。
BatchKillProcessList	批量关闭会话	该接口为异步执行，用于批量关闭会话，需要用户通过接口 DescribeProcessStatsComposition 二次确认。
DescribeProcessStatsComposition	查询会话信息	该接口用于查询会话信息。
KillProcessList	关闭指定的会话	关闭指定的会话。

诊断管理

API	标题	API概述
DescribeOasAnomalySQLList	查询可疑 SQL 列表	该接口用于查询诊断系统判定可能存在性能问题的 SQL 列表。
DescribeSampleSqlRawTexts	查询采样SQL的原始文本	该接口用于查询采样 SQL 的原始文本。
DescribeOasSQLDetails	查询 SQL 详细信息	查询 SQL 详细信息，包括 SQL 文本、涉及的表名等信息。
DescribeOasSQLPlans	查询 SQL 执行计划	根据 SQLID 查询诊断系统存储的 SQL 执行计划信息。
DescribeSQLSamples	查询慢 SQL 执行明细的采样数据	查询慢 SQL 执行明细的采样数据。
DescribeOasSQLHistoryList	查询 SQL 执行历史	查询 SQL 执行历史信息。
DescribeOasTopSQLList	查询 TopSQL 列表	查询诊断系统采集到的 SQL 执行性能数据列表。
DescribeOasSlowSQLList	查询慢 SQL 列表	该接口用于查询慢 SQL 列表。
DescribeOutlineBinding	查询 Outline 绑定信息	根据 SQLID 查询一条 SQL 在数据库中被绑定的 Outline 信息或限流信息。
DescribeRecommendIndex	查询 SQL 索引推荐信息	根据 SQLID 查询诊断系统对 SQL 的索引推荐信息。
DescribeSQLTuningAdvices	查询 SQL 的优化建议	查询 SQL 的优化建议包括两种：索引创建的建议、执行计划绑定的建议。
DescribeSqlAuditStat	统计 SQL 执行情况	按照客户端IP、用户、SQLID的维度统计SQL数据执行情况
CreateOasOutlineTask	发起 Outline 绑定任务	发起 Outline 绑定任务。

安全设置

API	标题	API概述
ModifyInstanceSSL	修改 SSL 配置	该接口用于修改实例的 SSL 配置。
DescribeInstanceSSL	查询集群 SSL	该接口用于查询 OceanBase 集群的 SSL 详情。
CreateSecurityIpGroup	创建白名单组	创建一个 IP 白名单组。
DescribeSecurityIpGroups	查询 IP 安全白名单分组列表	查看 IP 安全白名单分组列表。
DescribeTenantSecurityConfigs	租户安全配置检测	租户安全配置检测。
DescribeTenantEncryption	查询租户加密信息	该接口用于查询租户加密信息。
DescribeInstanceSecurityConfigs	集群安全配置检测	集群安全配置检测。
ModifySecurityIps	修改 IP 列表	修改分组内的 IP 列表。
ModifyTenantEncryption	租户开启透明加密	租户开启透明加密。
DeleteSecurityIpGroup	删除白名单分组	删除 Oceanbase 集群的某个 IP 白名单分组。
DescribeBackupEncryptedString	获取整体加密的备份信息	获取 OceanBase 整体加密的备份信息。

监控管理

API	标题	API概述
DescribeMetricsDataV2	查询监控指标数据	返回用户监控数据
DescribeMetricsData	查询监控指标数据	该接口用于查询 OceanBase 集群的单维度或者多维度监控指标数据。
DescribeNodeMetrics	查询节点指标信息	查询一个 OceanBase 节点指标信息。
DescribeTenantMetrics	查询租户指标信息	查询指定 OceanBase 租户指标信息。

备份恢复

API	标题	API概述
DescribeBackupSetDownloadLink	获取备份设置的下载链接	该接口用于查询 OceanBase 备份设置下载链接。
DescribeDataBackupSet	查询备份集信息	查询 OceanBase 备份集信息。
CreateBackupSetDownloadLink	创建备份任务下载链接	创建 OceanBase 备份任务下载链接。
DescribeRestorableTenants	查询可恢复租户	查询可恢复 OceanBase 租户。

其他

API	标题	API概述
DescribeProxyService	查询代理服务信息	查询 OceanBase 代理服务信息。
DescribeTenantAddressProxyInfo	查询租户地址代理服务信息	本接口用户调用获取租户地址代理服务信息。