概述 | OceanBase 文档中心

概述

更新时间：2024-06-07 16:35:26

本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）支持的 OpenAPI 列表，以及 OpenAPI 请求的鉴权方式。

OpenAPI 列表

OpenAPI 名称	描述
创建项目	用于创建数据迁移或数据同步项目的接口。
启动项目	用于启动数据迁移或数据同步项目的接口。
暂停项目	用于暂停数据迁移或数据同步项目的接口。
恢复项目	用于恢复数据迁移或数据同步项目的接口。
释放项目	用于释放数据迁移或数据同步项目的接口。
删除项目	用于删除数据迁移或数据同步项目的接口。
分页查询项目列表	用于分页查询数据迁移或数据同步项目列表页面的接口。
查询项目的详情	用于查询数据迁移或数据同步项目详情的接口。
查询项目步骤的详情	用于查询数据迁移或数据同步项目运行步骤的详情的接口。
查询项目步骤的指标	用于查询数据迁移或数据同步项目的运行步骤指标的接口。
查询项目的进度	用于查询数据迁移或数据同步项目进度信息的接口。
查询项目的组件信息	用于查询数据迁移或数据同步项目组件信息的接口。
查询项目的全量校验结果	用于查询数据迁移项目的全量校验结果的接口。
启动指定标签下所有未启动的项目	用于启动指定标签下，所有处于未启动状态的数据迁移或数据同步项目的接口。
暂停指定标签下所有运行中的项目	用于暂停指定标签下，所有处于运行中状态的数据迁移或数据同步项目。
创建 MySQL 数据源	用于创建 MySQL 数据源的接口。
创建 OceanBase 数据源	用于创建 OceanBase 数据源的接口。
查询数据源列表	用于查询已创建数据源列表的接口。
创建标签	用于创建标签的接口。
查询标签列表	用于查询已创建标签列表的接口。

鉴权方式

您可以使用 curl 工具调用 OpenAPI 的接口。下述示例中，访问 OMS 的地址为 xxx.xxx.xxx.1，端口为 8089，访问的接口为 ListProjects（分页查询项目列表）。其中， YWRtaW46cm9vdA== 为 username:password 的 Base64 编码。

curl -X POST  -H 'Authorization:Basic YWRtaW46cm9vdA=' -H 'Content-Type: application/json'  -d '{"pageNumber":1,"pageSize":1}' http://xxx.xxx.xxx.1:8089/api/v2?Action=ListProjects