---
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.0 企业版

# 概述

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

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

## OpenAPI 列表

| **OpenAPI 名称** | **描述** |
| --- | --- |
| [创建项目](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091531) | 用于创建数据迁移或数据同步项目的接口。 |
| [启动项目](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091517) | 用于启动数据迁移或数据同步项目的接口。 |
| [暂停项目](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091520) | 用于暂停数据迁移或数据同步项目的接口。 |
| [恢复项目](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091525) | 用于恢复数据迁移或数据同步项目的接口。 |
| [释放项目](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091518) | 用于释放数据迁移或数据同步项目的接口。 |
| [删除项目](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091526) | 用于删除数据迁移或数据同步项目的接口。 |
| [分页查询项目列表](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091521) | 用于分页查询数据迁移或数据同步项目列表页面的接口。 |
| [查询项目的详情](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091522) | 用于查询数据迁移或数据同步项目详情的接口。 |
| [查询项目步骤的详情](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091519) | 用于查询数据迁移或数据同步项目运行步骤的详情的接口。 |
| [查询项目步骤的指标](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091528) | 用于查询数据迁移或数据同步项目的运行步骤指标的接口。 |
| [查询项目的进度](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091527) | 用于查询数据迁移或数据同步项目进度信息的接口。 |
| [查询项目的组件信息](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091529) | 用于查询数据迁移或数据同步项目组件信息的接口。 |
| [查询项目的全量校验结果](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091534) | 用于查询数据迁移项目的全量校验结果的接口。 |
| [启动指定标签下所有未启动的项目](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091530) | 用于启动指定标签下，所有处于未启动状态的数据迁移或数据同步项目的接口。 |
| [暂停指定标签下所有运行中的项目](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091515) | 用于暂停指定标签下，所有处于运行中状态的数据迁移或数据同步项目。 |
| [创建 MySQL 数据源](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091516) | 用于创建 MySQL 数据源的接口。 |
| [创建 OceanBase 数据源](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091524) | 用于创建 OceanBase 数据源的接口。 |
| [查询数据源列表](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091535) | 用于查询已创建数据源列表的接口。 |
| [创建标签](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091533) | 用于创建标签的接口。 |
| [查询标签列表](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000000091532) | 用于查询已创建标签列表的接口。 |

## 鉴权方式

您可以使用 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) 咨询热线