创建 OceanBase 数据源

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

编辑

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

功能说明

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

调用说明

接口约束

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

请求路径

POST /api/v2?Action=CreateOceanBaseDataSource

请求参数

参数	类型	描述
name	string	数据源标识。
tenant	string	OceanBase 数据库租户的名称。
cluster	string	OceanBase 数据库租户所在集群的名称。
schema	string	数据库的名称。填写后，仅对该数据库进行数据迁移或数据同步。
ip	string	数据库宿主机的 IP。
port	integer	数据库宿主机 IP 的端口号。
username	string	用于数据迁移或数据同步的数据库用户的名称。
password	string	数据库用户的密码，需要使用 Base64 编码。
region	string	数据源所属的地域。
description	string	数据源的备注信息，不能超过 128 个字符。
ocpName	string	关联的 OCP 名称。
configUrl	string	用于获取 OceanBase 数据库底层服务器的真实地址。
drcUserName	string	该用户主要用于读取 OceanBase 数据库增量日志和数据库对象结构信息，请在业务集群 sys 租户下创建该用户。
drcPassword	string	drc_user 用户的密码。
innerDrcPassword	string	__oceanbase_inner_drc_user 的密码。该用户主要用于 OceanBase 数据库内无唯一键表的数据迁移。

返回结果

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

示例

请求示例

{
    "name":"OceanBase 数据源测试",
    "tenant":"tenant_name",
    "cluster":"cluster_name",
    "schema":"test",
    "ip":"string",
    "port":2883,
    "userName":"use***",
    "password":"pas***",
    "region":"cn-anhui",
    "description":"test",
    "ocpName":"cn-anhui-212-xxx.xxx.xxx.1",
    "configUrl":"http://xxx.xxx.xxx.2:8080/services?Action=ObRootServiceInfo&User_ID=alibaba&UID=ocpmaster&ObRegion=ob_1***29.admin",
    "drcUserName":"user_na***",
    "drcPassword":"pas***",
    "innerDrcPassword":"in***"
}

返回示例

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