--- title: "概述 | OceanBase 文档中心" description: 概述 本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）支持的 OpenAPI 列表，以及 OpenAPI 请求的鉴权方式。 OpenAPI 列表 OpenAPI 名称 描述 创建任务 用于创建数据迁移或数据同步任务的接口。 启动任务 用于启动数据迁移或数据同… --- 切换语言 - 中文站 - 简体中文 - International - English - 日本站 - 日本語 文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*L03BS6f-o40AAAAAAAAAAAAADiGDAQ/original) 迁移服务 OMSV 4.3.1 企业版 # 概述 更新时间：2026-04-14 15:36:02 本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）支持的 OpenAPI 列表，以及 OpenAPI 请求的鉴权方式。 ## OpenAPI 列表 | **OpenAPI 名称** | **描述** | | --- | --- | | [创建任务](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023248) | 用于创建数据迁移或数据同步任务的接口。 | | [启动任务](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023244) | 用于启动数据迁移或数据同步任务的接口。 | | [暂停任务](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023239) | 用于暂停数据迁移或数据同步任务的接口。 | | [恢复任务](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023214) | 用于恢复数据迁移或数据同步任务的接口。 | | [释放任务](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023242) | 用于释放数据迁移或数据同步任务的接口。 | | [删除任务](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023232) | 用于删除数据迁移或数据同步任务的接口。 | | [分页查询任务列表](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023231) | 用于分页查询数据迁移或数据同步任务列表页面的接口。 | | [查询任务的详情](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023238) | 用于查询数据迁移或数据同步任务详情的接口。 | | [查询任务步骤的详情](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023236) | 用于查询数据迁移或数据同步任务运行步骤的详情的接口。 | | [查询任务步骤的指标](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023216) | 用于查询数据迁移或数据同步任务的运行步骤指标的接口。 | | [查询任务的进度](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023219) | 用于查询数据迁移或数据同步任务进度信息的接口。 | | [查询任务的组件信息](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023217) | 用于查询数据迁移或数据同步任务组件信息的接口。 | | [查询任务的全量校验结果](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023249) | 用于查询数据迁移任务的全量校验结果的接口。 | | [启动指定标签下所有未启动的任务](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023241) | 用于启动指定标签下，所有处于未启动状态的数据迁移或数据同步任务的接口。 | | [暂停指定标签下所有运行中的任务](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023240) | 用于暂停指定标签下，所有处于运行中状态的数据迁移或数据同步任务。 | | [创建 MySQL 数据源](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023215) | 用于创建 MySQL 数据源的接口。 | | [创建 OceanBase 数据源](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023222) | 用于创建 OceanBase 数据源的接口。 | | [创建 ODP 数据源](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023234) | 用于创建 OceanBase ODP 数据源的接口。 | | [查询数据源列表](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023221) | 用于查询已创建数据源列表的接口。 | | [创建标签](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023235) | 用于创建标签的接口。 | | [查询标签列表](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023226) | 用于查询已创建标签列表的接口。 | | [删除数据源](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023245) | 用于删除数据源的接口。 | | [修改传输对象](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023228) | 用于增加或减少表对象的接口。 | | [查询任务的修改记录](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023243) | 用于根据数据迁移或数据同步任务的 ID 查询任务的修改记录的接口。 | | [终止修改操作](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023247) | 用于根据修改记录的 ID 终止修改操作的接口。 | | [重试修改操作](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023225) | 用于根据修改记录的 ID 重试修改操作的接口。 | | [取消修改操作](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023223) | 用于根据修改记录的 ID 取消修改操作的接口。 | | [任务预检查](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023251) | 用于对创建的数据迁移或数据同步任务进行预检查。 | | [查询预检查结果](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023250) | 用于查询数据迁移或数据同步任务的预检查结果。 | | [更新任务配置](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023233) | 用于更新数据迁移或数据同步任务的参数配置。 | | [下载表结构转换信息](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023230) | 用于下载结构迁移完成后有转换的表的结构转换信息。 | | [下载冲突日志文件](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023218) | 用于下载数据迁移或数据同步任务的冲突日志文件。 | | [查询冲突日志文件列表](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023224) | 用于查询数据迁移或数据同步任务的冲突日志文件列表。 | | [修改正反向增量同步的同步位点](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023237) | 用于修改正向增量同步和反向增量同步的同步位点。 | | [推进任务的运行](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023220) | 用于推进数据迁移或同步任务的运行。 | | [查询地域列表](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023246) | 用于查询 OMS 集群地域列表。 | ## curl 示例 您可以使用 curl 工具调用 OpenAPI 的接口。下述示例中，访问 OMS 的地址为 xxx.xxx.xxx.1，端口为 8089，访问的接口为 ListProjects（分页查询任务列表）。其中， `YWRtaW46cm9vdA=` 为 `username:password` 的 Base64 编码。 ```shell 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 ``` 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线