创建 MySQL 数据源

更新时间：2026-04-14 15:40:47

编辑

本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）社区版提供的 OpenAPI：创建 MySQL 数据源 CreateMysqlDataSource。

功能说明

本接口用于创建 MySQL 数据源。

调用说明

接口约束

本接口适用于 OMS 社区版 V4.1.1-CE 及之后版本。

请求路径

POST /api/v2?Action=CreateMySqlDataSource

请求参数

参数	类型	描述
name	string	数据源标识。建议使用中文、数字和字母的组合。名称中不能包含空格，长度不能超过 32 个字符。
ip	string	数据库宿主机的 IP。
port	integer	数据库宿主机 IP 的端口号。
schema	string	数据库的名称。填写后，仅对该数据库进行数据迁移或数据同步。
username	string	用于数据迁移或数据同步的数据库用户的名称。
password	string	数据库用户的密码，需要使用 Base64 编码。
tryKeepHb	boolean	增量同步时，是否允许 OMS 自动向该实例写入心跳数据，以解决源端在无业务写入场景下的高延时问题。
region	string	数据源所属的地域。
description	string	数据源的备注信息，不能超过 128 个字符。

返回结果

参数	类型	描述
success	boolean	是否调用成功。
errorDetail	object	错误详情。
code	string	错误码。
message	string	描述信息。
advice	string	建议。
requestId	string	请求 ID。
pageNumber	integer	页序号，分页查询时生效。
pageSize	integer	页大小，分页查询时生效。
totalCount	integer	总数，分页查询时生效。
cost	string	请求耗时，单位为秒。
data	string	MySQL 数据源的 ID。

示例

请求示例

{
    "name":"mysql_test",
    "ip":"xxx.xxx.xxx.1",
    "port":2883,
    "schema":"test",
    "username":"tes***",
    "password":"pas***",
    "tryKeepHb":true,
    "region":"cn-anhui",
    "description":null
}

返回示例

{
    "success":true,
    "errorDetail":null,
    "code":null,
    "message":null,
    "advice":null,
    "requestId":"a7b57****",
    "pageNumber":null,
    "pageSize":null,
    "totalCount":null,
    "cost":"27 ms",
    "data":"e_edz****"
}