创建 OMS MySQL 数据源。
接口说明
注意 使用该接口需将 OceanBase 数据传输服务器的 IP 地址(请至 OMS 数据源添加页面查询) 加入到您的阿里云数据库实例的白名单、ECS 的安全规则或自建数据库对应的安全设置(通常为您自建数据库的防火墙)中以确保 OceanBase 数据传输服务可成功访问到您的数据库实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 是 | 数据源名称。 说明
不可包含 “/” 等非法字符 | oms-mysql |
Type | string | 是 | MySQL 类型。 | INTERNET |
VpcId | string | 否 | 数据源所属 VPC ID。 说明
如 Type 为 VPC,则该字段必填。 | vpc-12345abcde******* |
InstanceId | string | 否 | 数据源云实例 ID。 说明
如 Type 为 RDS、PolarDB、DG,则该字段必填。 | pc-12ab34cd56****** |
DgDatabaseId | string | 否 | database gateway,数据库网关实例 ID。 说明
如 Type 为 DG,则该字段必填。 | dg-yhss6sdlaff**** |
Ip | string | 否 | 数据源 IP 地址。 说明
如 Type 为 INTERNET、VPC,则该字段必填。 | 10.0.**** |
Port | string | 否 | 数据源端口。 说明
如 Type 为 INTERNET、VPC,则该字段必填。 | 3306 |
Schema | string | 否 | 数据库名。 说明
如填写,后续迁移或同步操作,只会针对该数据库操作。 | test |
Username | string | 是 | 数据库连接用户名。 | omsTestUser |
Password | string | 是 | 数据库连接密码(需经过 Base64 编码后传入)。 | YWJjZDEyM0Ah |
Description | string | 否 | The description of the data source. It must be 2 to 256 characters in length. The default value is null. | OMS 测试 MySQL 数据源 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Data": {
"EndpointId": "e_1234abcd*****"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史