---
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.2.9 社区版

# 概述

更新时间：2026-04-14 15:36:17

[编辑](https://github.com/oceanbase/oms-doc/edit/V4.2.9/zh-CN/1200.reference-guide/100.api-reference/100.api-overview.md)  

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

## OpenAPI 列表

| **OpenAPI 名称** | **描述** |
| --- | --- |
| [创建任务](https://www.oceanbase.com/docs/community-oms-cn-1000000002947449) | 用于创建数据迁移或数据同步任务的接口。 |
| [启动任务](https://www.oceanbase.com/docs/community-oms-cn-1000000002947448) | 用于启动数据迁移或数据同步任务的接口。 |
| [暂停任务](https://www.oceanbase.com/docs/community-oms-cn-1000000002947443) | 用于暂停数据迁移或数据同步任务的接口。 |
| [恢复任务](https://www.oceanbase.com/docs/community-oms-cn-1000000002947426) | 用于恢复数据迁移或数据同步任务的接口。 |
| [释放任务](https://www.oceanbase.com/docs/community-oms-cn-1000000002947447) | 用于释放数据迁移或数据同步任务的接口。 |
| [删除任务](https://www.oceanbase.com/docs/community-oms-cn-1000000002947437) | 用于删除数据迁移或数据同步任务的接口。 |
| [分页查询任务列表](https://www.oceanbase.com/docs/community-oms-cn-1000000002947436) | 用于分页查询数据迁移或数据同步任务列表页面的接口。 |
| [查询任务的详情](https://www.oceanbase.com/docs/community-oms-cn-1000000002947442) | 用于查询数据迁移或数据同步任务详情的接口。 |
| [查询任务步骤的详情](https://www.oceanbase.com/docs/community-oms-cn-1000000002947441) | 用于查询数据迁移或数据同步任务运行步骤的详情的接口。 |
| [查询任务步骤的指标](https://www.oceanbase.com/docs/community-oms-cn-1000000002947428) | 用于查询数据迁移或数据同步任务的运行步骤指标的接口。 |
| [查询任务的进度](https://www.oceanbase.com/docs/community-oms-cn-1000000002947430) | 用于查询数据迁移或数据同步任务进度信息的接口。 |
| [查询任务的组件信息](https://www.oceanbase.com/docs/community-oms-cn-1000000002947429) | 用于查询数据迁移或数据同步任务组件信息的接口。 |
| [查询任务的全量校验结果](https://www.oceanbase.com/docs/community-oms-cn-1000000002947450) | 用于查询数据迁移任务的全量校验结果的接口。 |
| [启动指定标签下所有未启动的任务](https://www.oceanbase.com/docs/community-oms-cn-1000000002947445) | 用于启动指定标签下，所有处于未启动状态的数据迁移或数据同步任务的接口。 |
| [暂停指定标签下所有运行中的任务](https://www.oceanbase.com/docs/community-oms-cn-1000000002947444) | 用于暂停指定标签下，所有处于运行中状态的数据迁移或数据同步任务。 |
| [创建 MySQL 数据源](https://www.oceanbase.com/docs/community-oms-cn-1000000002947427) | 用于创建 MySQL 数据源的接口。 |
| [创建 OceanBase 数据源](https://www.oceanbase.com/docs/community-oms-cn-1000000002947433) | 用于创建 OceanBase 数据源的接口。 |
| [查询数据源列表](https://www.oceanbase.com/docs/community-oms-cn-1000000002947432) | 用于查询已创建数据源列表的接口。 |
| [创建标签](https://www.oceanbase.com/docs/community-oms-cn-1000000002947440) | 用于创建标签的接口。 |
| [查询标签列表](https://www.oceanbase.com/docs/community-oms-cn-1000000002947434) | 用于查询已创建标签列表的接口。 |
| [查询指定传输对象的不一致信息](https://www.oceanbase.com/docs/community-oms-cn-1000000002947451) | 用于查询指定传输对象的不一致信息的接口。 |
| [查询指定传输对象的订正 SQL 语句](https://www.oceanbase.com/docs/community-oms-cn-1000000002947452) | 用于查询指定传输对象的订正 SQL 语句的接口。 |
| [更新 Store 组件](https://www.oceanbase.com/docs/community-oms-cn-1000000002947446) | 用于更新 Store 组件的接口。 |
| [更新 Full-Import 组件](https://www.oceanbase.com/docs/community-oms-cn-1000000002947431) | 用于更新 Full-Import 组件的接口。 |
| [更新 Incr-Sync 组件](https://www.oceanbase.com/docs/community-oms-cn-1000000002947438) | 用于更新 Incr-Sync 组件的接口。 |
| [更新 Full-Verification 组件](https://www.oceanbase.com/docs/community-oms-cn-1000000002947425) | 用于更新 Full-Verification 组件的接口。 |

## 鉴权方式

您可以使用 curl 工具调用 OpenAPI 的接口。下述示例中，访问 OMS 的地址为 xxx.xxx.xxx.1，端口为 8089，访问的接口为创建任务。其中， `YWRtaW46cm9vdA==` 为 `username:password` 的 Base64 编码。

```shell
curl "http://xxx.xxx.xxx.1:8089/api/v2?Action=CreateProject"  \
  -H "Authorization: Basic YWRtaW46cm9vdA=="
  -H 'Content-Type: application/json'

```

 上一篇 下一篇 ![有帮助](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) 咨询热线
