文档

API概览

更新时间:
本产品(云数据库 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查询集群标签值查询集群的标签值。
DescribeAvailableSpec查询集群变配可选配置查询 OceanBase 集群变配页可选配置。
DescribeAvailableZone查询创建集群可选配置查询 OceanBase 集群售卖页可选配置。
ModifyInstanceName修改集群名称修改 OceanBase 的集群名称。
ModifyInstanceTags修改集群标签值修改集群的标签值。
ModifyInstanceSpec修改集群规格和存储空间修改集群规格和存储空间。
ModifyInstanceNodeNum修改集群节点个数修改集群节点个数。
ModifyInstanceTemporaryCapacity修改集群临时容量修改 OceanBase 集群临时容量。
SwitchoverInstance切换主备实例切换 OceanBase 主备实例。
DeleteInstances释放 OceanBase 实例调用接口释放 OceanBase 实例。

租户管理

API标题API概述
CreateTenant创建租户创建一个租户。
CreateTenantReadOnlyConnection创建只读地址为指定租户创建一个只读地址。
CreateTenantSecurityIpGroup创建租户安全白名单信息创建租户安全白名单信息。
DescribeTenants查询集群下的租户列表信息查询指定 OceanBase 集群列表下的租户列表信息。
DescribeInstanceTenantModes查询租户模式列表信息该接口用于查询租户模式列表信息。
DescribeTenant查询指定集群下的指定租户信息查看指定集群下的指定租户信息。
DescribeAvailableCpuResource查询可查询的 CPU 资源信息查询创建租户允许的 CPU 资源信息。
DescribeAvailableMemResource查询内存资源信息查询 OceanBase 租户的内存资源信息。
DescribeCharset获取字符集查询 OceanBase 租户的字符集信息。
DescribeInstanceCreatableZone查询可用区信息查询集群可创建主可用区的可用区信息。
DescribeTenantZonesRead查询租户只读可用区信息查询租户的只读可用区信息。
DescribeTimeZones获取时区列表查询 OceanBase 租户的时区信息。
DescribeTenantSecurityIpGroups查看租户白名单分组列表查看租户白名单分组列表。
DescribeZones获取可用区信息获取一个阿里云地域下可创建集群的可用区信息。
DescribeTenantTags查询租户标签值查询租户的标签值。
ModifyTenantPrimaryZone切换租户主可用区切换租户的主可用区。
ModifyTenantResource修改租户资源修改指定 OceanBase 集群的一个租户的规格。
ModifyTenantTags修改租户标签值修改租户的标签值。
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概述
KillProcessList关闭指定的会话关闭指定的会话。

诊断管理

API标题API概述
DescribeSampleSqlRawTexts查询采样SQL的原始文本该接口用于查询采样 SQL 的原始文本。
DescribeOasSQLDetails查询 SQL 详细信息查询 SQL 详细信息,包括 SQL 文本、涉及的表名等信息。
DescribeOasSQLPlans查询 SQL 执行计划根据 SQLID 查询诊断系统存储的 SQL 执行计划信息。
DescribeSQLSamples查询慢 SQL 执行明细的采样数据查询慢 SQL 执行明细的采样数据。
DescribeOasSQLHistoryList查询 SQL 执行历史查询 SQL 执行历史信息。
DescribeOasTopSQLList查询 TopSQL 列表查询诊断系统采集到的 SQL 执行性能数据列表。
DescribeOasSlowSQLList查询慢 SQL 列表该接口用于查询慢 SQL 列表。
DescribeOasAnomalySQLList查询可疑 SQL 列表该接口用于查询诊断系统判定可能存在性能问题的 SQL 列表。
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概述
CreateSecurityIpGroup创建白名单组创建一个 IP 白名单组。
DescribeSecurityIpGroups查询 IP 安全白名单分组列表查看 IP 安全白名单分组列表。
DescribeTenantSecurityConfigs租户安全配置检测租户安全配置检测。
DescribeTenantEncryption查询租户加密信息该接口用于查询租户加密信息。
DescribeInstanceSecurityConfigs集群安全配置检测集群安全配置检测。
ModifySecurityIps修改 IP 列表修改分组内的 IP 列表。
ModifyTenantEncryption租户开启透明加密租户开启透明加密。
DeleteSecurityIpGroup删除白名单分组删除 Oceanbase 集群的某个 IP 白名单分组。

监控管理

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

数据传输

API标题API概述
CreateProject创建项目本接口用于创建数据迁移或数据同步项目。
StartProject启动项目本接口用于启动数据迁移或数据同步项目。
StopProject暂停项目本接口用于暂停数据迁移或数据同步项目。
ResumeProject恢复项目本接口用于恢复数据迁移或数据同步项目。
ReleaseProject释放项目本接口用于释放数据迁移或数据同步项目。
DeleteProject删除项目本接口用于删除数据迁移或数据同步项目。
ListProjects分页查询项目列表本接口用于数据迁移或数据同步项目列表页面的分页查询。
DescribeProject查询项目的详情本接口用于查询数据迁移或数据同步项目的项目详情。
DescribeProjectSteps查询项目步骤的详情本接口用于查询数据迁移或数据同步项目运行步骤的详情。
DescribeProjectStepMetric查询项目步骤的指标本接口用于查询数据迁移或数据同步项目的运行步骤的指标。
DescribeProjectProgress查询项目的进度本接口用于查询数据迁移或数据同步项目的进度信息。
DescribeProjectComponents查询项目的组件信息本接口用于查询数据迁移或数据同步项目的组件信息。
ListProjectFullVerifyResult查询项目的全量校验结果本接口用于查询数据迁移项目的全量校验结果。
StartProjectsByLabel启动指定标签下所有未启动的项目本接口用于启动指定标签下,所有处于未启动状态的数据迁移或数据同步项目。
StopProjectsByLabel暂停指定标签下所有运行中的项目本接口用于暂停指定标签下,所有处于运行中状态的数据迁移或数据同步项目。
GetUploadOssUrl获取上传 OSS URL本接口用于公有云上传 OSS,获取一个临时上传 URL。
ListWorkerInstances查询传输实例列表本接口用于查询传输实例列表。
CreateMySqlDataSource创建 MySQL 数据源本接口用于创建 MySQL 数据源。
CreateOceanBaseDataSource创建 OceanBase 数据源本接口用于创建 OceanBase 数据源。
ListDataSource查询数据源列表本接口用于查询已创建数据源的列表。
CreateLabel创建标签本接口用于创建标签。
ListAllLabels查询标签列表本接口用于查询已创建标签的列表。
CreateOmsMysqlDataSource创建 OMS MySQL 数据源创建 OMS MySQL 数据源。
ReleaseWorkerInstance释放传输实例本接口用于释放传输实例。
CancelProjectModifyRecord取消修改操作该接口用于根据修改记录的 ID 取消修改操作。
RetryProjectModifyRecords重试修改操作该接口用于根据修改记录的 ID 重试修改操作。
StopProjectModifyRecords终止修改操作该接口用于根据修改记录的 ID 终止修改操作。
ListProjectModifyRecords查询项目的修改记录该接口用于根据数据迁移或数据同步项目的 ID 查询项目的修改记录。
CreateProjectModifyRecords修改传输对象该接口用于增加或减少表对象。
UpdateProjectConfig更新项目配置本接口用于更新数据迁移或数据同步项目配置。
DeleteDataSource删除数据源该接口用于删除数据源。
CreateRdsPostgreSQLDataSource创建 RDS PostgreSQL 数据源该接口用于创建 RDS PostgreSQL 数据源。

备份恢复

API标题API概述
DescribeBackupSetDownloadLink获取备份设置的下载链接该接口用于查询 OceanBase 备份设置下载链接。
DescribeDataBackupSet查询备份集信息查询 OceanBase 备份集信息。
CreateBackupSetDownloadLink创建备份任务下载链接创建 OceanBase 备份任务下载链接。
  • 本页导读 (0)
文档反馈