文档

CreateOmsMysqlDataSource - 创建 OMS MySQL 数据源

更新时间:

创建 OMS MySQL 数据源。

接口说明

注意 使用该接口需将 OceanBase 数据传输服务器的 IP 地址(请至 OMS 数据源添加页面查询) 加入到您的阿里云数据库实例的白名单、ECS 的安全规则或自建数据库对应的安全设置(通常为您自建数据库的防火墙)中以确保 OceanBase 数据传输服务可成功访问到您的数据库实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Namestring

数据源名称。
长度为 2~128 个英文或中文字符,可包含数字、下划线(_)、半角句号(.)或者短划线(-)。

说明
不可包含 “/” 等非法字符
oms-mysql
Typestring

MySQL 类型。
包括 INTERNET、VPC、RDS、PolarDB 和 DG。

INTERNET
VpcIdstring

数据源所属 VPC ID。

说明
如 Type 为 VPC,则该字段必填。
vpc-12345abcde*******
InstanceIdstring

数据源云实例 ID。

说明
如 Type 为 RDS、PolarDB、DG,则该字段必填。
pc-12ab34cd56******
DgDatabaseIdstring

database gateway,数据库网关实例 ID。

说明
如 Type 为 DG,则该字段必填。
dg-yhss6sdlaff****
Ipstring

数据源 IP 地址。

说明
如 Type 为 INTERNET、VPC,则该字段必填。
10.0.****
Portstring

数据源端口。

说明
如 Type 为 INTERNET、VPC,则该字段必填。
3306
Schemastring

数据库名。

说明
如填写,后续迁移或同步操作,只会针对该数据库操作。
test
Usernamestring

数据库连接用户名。

omsTestUser
Passwordstring

数据库连接密码(需经过 Base64 编码后传入)。
例如,密码 abcd123@! 经过 Base64 转换后的值为 YWJjZDEyM0Ah。

YWJjZDEyM0Ah
Descriptionstring

The description of the data source. It must be 2 to 256 characters in length. The default value is null.

OMS 测试 MySQL 数据源

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Dataobject

请求的返回结果。

EndpointIdstring

数据源记录 ID。

e_1234abcd*****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": {
    "EndpointId": "e_1234abcd*****"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史