标签管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateTagValue | 该接口用于新建标签 | 查看文档去调试 |
| CreateTag | 该接口用于新建标签组 | 查看文档去调试 |
| DescribeTenantTags | 该接口用于查询租户的标签值 | 查看文档去调试 |
| DescribeTagValues | 该接口用于查询标签 | 查看文档去调试 |
| DescribeInstanceTags | 查询集群的标签值 | 查看文档去调试 |
ModifyTagValueName | 该接口用于修改标签名称 | 查看文档去调试 |
| ModifyTagName | 该接口用于修改标签组的名称 | 查看文档去调试 |
| ModifyInstanceTags | 该接口用于修改集群的标签值 | 查看文档去调试 |
| ModifyTenantTags | 该接口用于修改租户的标签值 | 查看文档去调试 |
| DeleteTagValue | 该接口用于删除标签 | 查看文档去调试 |
| DeleteTag | 该接口用于删除标签组 | 查看文档去调试 |
集群管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateInstance | 创建一个 OceanBase 数据库集群 | 查看文档去调试 |
| DescribeInstance | 查询一个 OceanBase 集群的详细信息 | 查看文档去调试 |
| DescribeInstances | 查询 OceanBase 集群列表信息 | 查看文档去调试 |
| DescribeInstanceTopology | 查询某个 OceanBase 集群的拓扑信息 | 查看文档去调试 |
| DescribeAvailableSpec | 查询 OceanBase 集群变配页可选配置 | 查看文档去调试 |
| DescribeAvailableZone | 查询 OceanBase 集群售卖页可选配置 | 查看文档去调试 |
| ModifyInstanceName | 修改 OceanBase 的集群名称 | 查看文档去调试 |
| ModifyInstanceSpec | 修改集群规格和存储空间 | 查看文档去调试 |
| ModifyInstanceNodeNum | 修改集群节点个数 | 查看文档去调试 |
| ModifyInstanceTemporaryCapacity | 修改 OceanBase 集群临时容量 | 查看文档去调试 |
| SwitchoverInstance | 切换 OceanBase 主备实例 | 查看文档去调试 |
| RemoveStandbyInstance | 备实例解耦 | 查看文档去调试 |
| DeleteInstances | 调用接口释放 OceanBase 实例 | 查看文档去调试 |
| DescribeInstanceSummary | 获取 OceanBase 实例概览信息 | 查看文档去调试 |
租户管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateTenant | 创建一个租户 | 查看文档去调试 |
| CreateTenantReadOnlyConnection | 为指定租户创建一个只读地址 | 查看文档去调试 |
| CreateTenantSecurityIpGroup | 创建租户安全白名单信息 | 查看文档去调试 |
| DescribeTenantReadableScn | 该接口用于查询租户的最大可读位点 | 查看文档去调试 |
| DescribeTenants | 查询指定 OceanBase 集群列表下的租户列表信息 | 查看文档去调试 |
| DescribeInstanceTenantModes | 该接口用于查询租户模式列表信息 | 查看文档去调试 |
| DescribeTenant | 查看指定集群下的指定租户信息 | 查看文档去调试 |
| DescribeAvailableCpuResource | 查询创建租户允许的 CPU 资源信息 | 查看文档去调试 |
| DescribeAvailableMemResource | 查询 OceanBase 租户的内存资源信息 | 查看文档去调试 |
| DescribeCharset | 查询 OceanBase 租户的字符集信息 | 查看文档去调试 |
| DescribeInstanceCreatableZone | 查询集群可创建主可用区的可用区信息 | 查看文档去调试 |
| DescribeTenantZonesRead | 查询租户的只读可用区信息 | 查看文档去调试 |
| DescribeTimeZones | 查询 OceanBase 租户的时区信息 | 查看文档去调试 |
| DescribeTenantSecurityIpGroups | 查看租户白名单分组列表 | 查看文档去调试 |
| DescribeZones | 获取一个阿里云地域下可创建集群的可用区信息 | 查看文档去调试 |
| ModifyTenantPrimaryZone | 切换租户的主可用区 | 查看文档去调试 |
| ModifyTenantResource | 修改指定 OceanBase 集群的一个租户的规格 | 查看文档去调试 |
| ModifyTenantSecurityIpGroup | 修改租户白名单分组信息 | 查看文档去调试 |
| DeleteTenants | 删除指定 OceanBase 集群下的一个或多个租户 | 查看文档去调试 |
| DeleteTenantSecurityIpGroup | 删除租户白名单分组信息 | 查看文档去调试 |
租户账号管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateTenantUser | 在指定租户下创建一个访问数据库的账号 | 查看文档去调试 |
| DescribeTenantUsers | 查询一个租户下所有数据库访问的账号列表 | 查看文档去调试 |
| DescribeTenantUserRoles | 获取普通用户的权限配置信息 | 查看文档去调试 |
| ModifyTenantUserDescription | 修改租户下指定的数据库账号的备注信息 | 查看文档去调试 |
| ModifyTenantUserPassword | 修改租户下指定的数据库账号的登录密码 | 查看文档去调试 |
| ModifyTenantUserRoles | 修改租户下指定账号可访问的数据库权限信息 | 查看文档去调试 |
| DeleteTenantUsers | 删除一个或多个数据库账号列表 | 查看文档去调试 |
会话连接
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeSessionList | 该接口用于展示 OceanBase 云服务和业务之间的会话信息 | 查看文档去调试 |
| DescribeProcessStatsComposition | 该接口用于查询会话信息 | 查看文档去调试 |
| BatchKillSessionList | 该接口用于批量关闭 OceanBase 云服务和业务之间的会话信息。该接口为异步执行，需要用户通过 DescribeSessionList 验证会话是否关闭成功 | 查看文档去调试 |
| BatchKillProcessList | 该接口为异步执行，用于批量关闭会话，需要用户通过接口 DescribeProcessStatsComposition 二次确认 | 查看文档去调试 |
| KillProcessList | 关闭指定的会话 | 查看文档去调试 |
诊断管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeOasAnomalySQLList | 该接口用于查询诊断系统判定可能存在性能问题的 SQL 列表 | 查看文档去调试 |
| DescribeSampleSqlRawTexts | 该接口用于查询采样 SQL 的原始文本 | 查看文档去调试 |
| DescribeOasSQLDetails | 查询 SQL 详细信息，包括 SQL 文本、涉及的表名等信息 | 查看文档去调试 |
| DescribeOasSQLPlans | 根据 SQLID 查询诊断系统存储的 SQL 执行计划信息 | 查看文档去调试 |
| DescribeSQLSamples | 查询慢 SQL 执行明细的采样数据 | 查看文档去调试 |
| DescribeOasSQLHistoryList | 查询 SQL 执行历史信息 | 查看文档去调试 |
| DescribeOasTopSQLList | 查询诊断系统采集到的 SQL 执行性能数据列表 | 查看文档去调试 |
| DescribeOasSlowSQLList | 该接口用于查询慢 SQL 列表 | 查看文档去调试 |
| DescribeOutlineBinding | 根据 SQLID 查询一条 SQL 在数据库中被绑定的 Outline 信息或限流信息 | 查看文档去调试 |
| DescribeRecommendIndex | 根据 SQLID 查询诊断系统对 SQL 的索引推荐信息 | 查看文档去调试 |
| DescribeSQLTuningAdvices | 查询 SQL 的优化建议包括两种：索引创建的建议、执行计划绑定的建议 | 查看文档去调试 |
| DescribeSqlAuditStat | 按照客户端IP、用户、SQLID的维度统计SQL数据执行情况 | 查看文档去调试 |
安全设置
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateSecurityIpGroup | 创建一个 IP 白名单组 | 查看文档去调试 |
| DescribeInstanceSSL | 该接口用于查询 OceanBase 集群的 SSL 详情 | 查看文档去调试 |
| DescribeSecurityIpGroups | 查看 IP 安全白名单分组列表 | 查看文档去调试 |
| DescribeTenantSecurityConfigs | 租户安全配置检测 | 查看文档去调试 |
| DescribeTenantEncryption | 该接口用于查询租户加密信息 | 查看文档去调试 |
| DescribeInstanceSecurityConfigs | 集群安全配置检测 | 查看文档去调试 |
| ModifyInstanceSSL | 该接口用于修改实例的 SSL 配置 | 查看文档去调试 |
| ModifySecurityIps | 修改分组内的 IP 列表 | 查看文档去调试 |
| ModifyTenantEncryption | 租户开启透明加密 | 查看文档去调试 |
| DeleteSecurityIpGroup | 删除 Oceanbase 集群的某个 IP 白名单分组 | 查看文档去调试 |
数据传输
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateProject | 本接口用于创建数据迁移或数据同步任务 | 查看文档去调试 |
| CreateMySqlDataSource | 本接口用于创建 MySQL 数据源 | 查看文档去调试 |
| CreateOceanBaseDataSource | 本接口用于创建 OceanBase 数据源 | 查看文档去调试 |
| CreateLabel | 本接口用于创建标签 | 查看文档去调试 |
| CreateOmsMysqlDataSource | 新建 MySQL 数据源 | 查看文档去调试 |
| CreateRdsPostgreSQLDataSource | 该接口用于创建 RDS PostgreSQL 数据源 | 查看文档去调试 |
| ListProjects | 本接口用于数据迁移或数据同步任务列表页面的分页查询 | 查看文档去调试 |
| DescribeProject | 本接口用于查询数据迁移或数据同步任务的任务详情 | 查看文档去调试 |
| DescribeProjectSteps | 本接口用于查询数据迁移或数据同步任务运行步骤的详情 | 查看文档去调试 |
| DescribeProjectStepMetric | 本接口用于查询数据迁移或数据同步任务的运行步骤的指标 | 查看文档去调试 |
| DescribeProjectProgress | 本接口用于查询数据迁移或数据同步任务的进度信息 | 查看文档去调试 |
| DescribeProjectComponents | 本接口用于查询数据迁移或数据同步任务的组件信息 | 查看文档去调试 |
| ListProjectFullVerifyResult | 本接口用于查询数据迁移任务的全量校验结果 | 查看文档去调试 |
| GetUploadOssUrl | 本接口用于公有云上传 OSS，获取一个临时上传 URL | 查看文档去调试 |
| ListWorkerInstances | 本接口用于查询传输实例列表 | 查看文档去调试 |
| ListDataSource | 本接口用于查询已创建数据源的列表 | 查看文档去调试 |
| ListAllLabels | 本接口用于查询已创建标签的列表 | 查看文档去调试 |
| ListProjectModifyRecords | 该接口用于根据数据迁移或数据同步任务的 ID 查询任务的修改记录 | 查看文档去调试 |
| StartProject | 本接口用于启动数据迁移或数据同步任务 | 查看文档去调试 |
| StopProject | 本接口用于暂停数据迁移或数据同步任务 | 查看文档去调试 |
| ResumeProject | 本接口用于恢复数据迁移或数据同步任务 | 查看文档去调试 |
| ReleaseProject | 本接口用于释放数据迁移或数据同步任务 | 查看文档去调试 |
| StartProjectsByLabel | 本接口用于启动指定标签下，所有处于未启动状态的数据迁移或数据同步任务 | 查看文档去调试 |
| StopProjectsByLabel | 本接口用于暂停指定标签下，所有处于运行中状态的数据迁移或数据同步任务 | 查看文档去调试 |
| ReleaseWorkerInstance | 本接口用于释放传输实例 | 查看文档去调试 |
| CancelProjectModifyRecord | 该接口用于根据修改记录的 ID 取消修改操作 | 查看文档去调试 |
| RetryProjectModifyRecords | 该接口用于根据修改记录的 ID 重试修改操作 | 查看文档去调试 |
| StopProjectModifyRecords | 该接口用于根据修改记录的 ID 终止修改操作 | 查看文档去调试 |
| CreateProjectModifyRecords | 本接口用于修改处于运行中、失败或已暂停状态的数据迁移或数据同步任务的迁移/同步对象 | 查看文档去调试 |
| UpdateProjectConfig | 本接口用于更新数据迁移或数据同步任务的配置 | 查看文档去调试 |
| DeleteProject | 本接口用于删除数据迁移或数据同步任务 | 查看文档去调试 |
| DeleteDataSource | 该接口用于删除数据源 | 查看文档去调试 |
未翻译(其他)
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeAnomalySQLList | 查询诊断系统判定认为可能存在性能问题的 SQL 列表 | 查看文档去调试 |
| DescribeSQLDetails | 根据 SQLID 查询一条 SQL 的 SQL 文本信息 | 查看文档去调试 |
| DescribeSQLPlans | 根据 SQLID 查询诊断系统存储的 SQL 执行计划信息 | 查看文档去调试 |
| DescribeSQLHistoryList | 根据 SQLID 查询一条 SQL 在时间段内的执行历史 | 查看文档去调试 |
| DescribeTopSQLList | 查询诊断系统采集到的 SQL 执行性能数据列表 | 查看文档去调试 |
| DescribeSlowSQLList | 查询慢 SQL 列表 | 查看文档去调试 |
| DescribeSlowSQLHistoryList | 根据 SQLID 查询一条 SQL 在时间段内的被判定为 Slow SQL 时的执行历史 | 查看文档去调试 |