跳到主要内容

创建数据链路

该接口可以在某个数据节点上创建一条链路，创建成功会返回相应的状态信息。

请求 URI​

POST /create

参数说明​

{
  "id": "string",
  "dataPort": "string",
  "ip": "string",
  "agentType": 0,
  "databaseConfig": [
    {
      "host": "string",
      "userName": "string",
      "passWord": "string",
      "dbType": "string"
    }
  ],
  "sourceConfig": {
    "mapUser": "string",
    "mapTable": "string",
    "mapNotTable": "string",
    "fullSyncCnt": "string",
    "mustFullSync": "string",
    "mustSyncDDL": "string",
    "rateLimit": "string",
    "beginTime": "string",
    "ifFzsText": "string",
    "obIncSyncUsername": "string",
    "obIncSyncPassword": "string",
    "obIncSyncConfigURL": "string"
  },
  "sinkConfig": {
    "mapUser": "string",
    "mapTable": "string",
    "mapColumn": "string",
    "ifFzsText": "string",
    "ifDirectLoad": "string",
    "portToQueue": "string",
    "portToAlloc": "string",
    "fullSyncCnt": "string"
  },
  "asmLogin": "string",
  "asmOracleSID": "string",
  "asmOracleHome": "string",
  "asmMode": "string",
  "asmConfig": [
    {
      "asmDev": "string",
      "asmDisk": "string"
    }
  ],
  "execSwitch": "string",
  "extraConfig": {
    "config-key": "config-value"
  }
}

参数说明如下：

参数名说明
idSTRING 类型，FZS Agent ID。此 ID 用于生成 Web Server 上的 FZS Agent 路径。
dataPortSTRING 类型，同步链路的数据传输端口。
ipSTRING 类型，同步链对端节点的 IP 地址。例如：如果此接口向 Web Server 请求，则填写备端 Web Server 的 IP 地址，反之亦然。
agentTypeSTRING 类型，FZS Agent 的类型，0 则代表源端，1 则代表备端。
databaseConfigWeb Server 数据库连接参数。
sourceConfigWeb Server 源端同步参数。注意：仅当请求的是源端 Web Server 时添加。
sinkConfigWeb Server 备端同步参数。注意：仅当请求的是备端 Web Server 时添加。
asmLoginSTRING 类型，Oracle ASM 登录字符串，注意：仅当数据节点的数据库类型为 Oracle 时添加。
asmOracleSIDSTRING 类型，Oracle ASM 登录 SID，注意：仅当数据节点的数据库类型为 Oracle 时添加。
asmOracleHomeSTRING 类型，Oracle ASM Home 路径，注意：仅当数据节点的数据库类型为 Oracle 时添加。
asmModeSTRING 类型，Oracle ASM 模式，0 代表 db 模式，1 代表 raw 模式。注意：仅当数据节点的数据库类型为 Oracle 时添加。
asmConfigASM 配置参数。
execSwitchSTRING 类型，是否执行源端备端的灾备切换，1 则代表执行，0 则代表不执行。
extraConfigFZS Agent 的其他配置项。

databaseConfig 参数说明如下：

参数名说明
hostSTRING 类型，格式：IP/端口。
userNameSTRING 类型，数据库用户名。
passWordSTRING 类型，数据库登录密码。
dbTypeSTRING 类型，数据库类型。

sourceConfig 参数说明如下：

参数名说明
mapUserSTRING 类型，需要同步的用户名。 格式：USER1,USER2,USER3，多个用户逗号分隔
mapTableSTRING 类型，需要同步的表名。 格式：USER.TABLE1,USER.TABLE2,USER.TABLE3，多张表逗号分隔
mapNotTableSTRING 类型，需要排除的表名。 格式：USER.TABLE1,USER.TABLE2,USER.TABLE3，多张表逗号分隔
fullSyncCntSTRING 类型，全量同步的并发数。默认值为 8
mustFullSyncSTRING 类型，是否进行全量同步。是则填写 1，否则填写 0
mustSyncDDLSTRING 类型，是否同步 DDL 语句。是则填写 1，否则填写 0
rateLimitSTRING 类型，同步限速。
beginTimeSTRING 类型，同步指定历史时间。注意：此时间不能大于当前时间
ifFzsTextSTRING 类型，是否开启文本转换。是则填写 1，否则填写 0
obIncSyncUsernameSTRING 类型，OceanBase 增量模块使用的用户名。注意： 仅当源端数据节点类型为 OceanBase 时添加。
obIncSyncPasswordSTRING 类型，OceanBase 增量模块使用的密码。注意： 仅当源端数据节点类型为 OceanBase 时添加。
obIncSyncConfigURLSTRING 类型，OceanBase 增量模块使用的集群配置 URL。注意： 仅当源端数据节点类型为 OceanBase 时添加。

sinkConfig 参数说明如下：

参数名说明
mapUserSTRING 类型，需要同步的用户名。 格式：USER1,USER2,USER3，多个用户逗号分隔
mapTableSTRING 类型，需要同步的表名。 格式：USER.TABLE1,USER.TABLE2,USER.TABLE3，多张表逗号分隔
mapColumnSTRING 类型，需要同步的列名。 格式：USER.TABLE.COL1,USER.TABLE.COL2,USER.TABLE.COL3，多个列逗号分隔
ifFzsTextSTRING 类型，是否开启文本转换。是则填写 1，否则填写 0
ifDirectLoadSTRING 类型，是否开启直接路径装载。是则填写 1，否则填写 0
portToQueueSTRING 类型，备端进程装载端口。
portToAllocSTRING 类型，备端进程分配端口。
fullSyncCntSTRING 类型，全量同步的并发数。注意： 此参数的值须与 sourceConfig 中的 fullSyncCnt 相同

asmConfig 参数说明如下：

参数名说明
asmDevSTRING 类型，ASM 路径。
asmDiskSTRING 类型，ASM 名称。

extraConfig 参数说明如下：

点我查看

使用样例​

提示

创建一条完整的数据链路，需要在源端节点与备端节点上分别调用 /create 接口。

以下请求会在 172.21.16.3:8089 的 Web Server 上创建一个源端 FZS Agent，创建成功则会返回相应状态。

curl -i -X POST \
   -H "Content-Type:application/json" \
   -d \
'{
  "id": "V76b2z",
  "dataPort": "8203",
  "ip": "192.168.0.24",
  "agentType": 0,
  "asmLogin": "",
  "asmOracleSID": "",
  "asmOracleHome": "",
  "asmMode": "db",
  "asmConfig": [
    {
      "asmDev": "",
      "asmDisk": ""
    }
  ],
  "databaseConfig": [
    {
      "host": "192.168.0.24:1521/orcl",
      "userName": "fzs1",
      "passWord": "fzs1",
      "dbType": "oracle"
    }
  ],
  "sourceConfig": {
    "dataPort": "8203",
    "mapUser": "",
    "mapTable": "",
    "mapNotTable": "",
    "fullSyncCnt": "8",
    "mustfullSync": "1",
    "mustSyncDDL": "1",
    "rateLimit": null,
    "asmLogin": "",
    "asmOracleSID": "",
    "asmOracleHome": "",
    "asmMode": "db",
    "asmDisk": "",
    "asmDev": "",
    "beginTime": null,
    "extraConfig": "",
    "obIncSyncUsername": null,
    "obIncSyncPassword": null,
    "obIncSyncConfigURL": null,
    "ifFzsText": "0"
  },
  "execSwitch": "0",
  "extraConfig": null
}' \
 'http://172.21.16.3:8089/create'

以下请求会在 172.21.16.4:8089 的 Web Server 上创建一个备端 FZS Agent，创建成功则会返回相应状态。

curl -i -X POST \
   -H "Content-Type:application/json" \
   -d \
'{
  "id": "-ChB4l",
  "dataPort": "8203",
  "ip": "192.168.0.24",
  "agentType": 1,
  "asmLogin": "",
  "asmOracleSID": "",
  "asmOracleHome": "",
  "asmMode": "db",
  "asmConfig": [
    {
      "asmDev": "",
      "asmDisk": ""
    }
  ],
  "databaseConfig": [
    {
      "host": "192.168.0.24:1521/orcl",
      "userName": "fzs1",
      "passWord": "fzs1",
      "dbType": "oracle"
    }
  ],
  "sinkConfig": {
    "id": "69ab59fd-72f7-4f71-a349-032c6f91e96b",
    "usedById": "clonqfx6i0001tzso2l208qob",
    "mapUser": "",
    "mapTable": "",
    "mapColumn": "",
    "ifFzsText": "0",
    "ifDirectLoad": "1",
    "portToQueue": "18409",
    "portToAlloc": "16938",
    "asmLogin": "",
    "asmOracleSID": "",
    "asmOracleHome": "",
    "asmMode": "db",
    "asmDisk": "",
    "asmDev": "",
    "extraConfig": "",
    "fullSyncCnt": "8"
  },
  "extraConfig": null
}' \
 'http://172.21.16.4:8089/create'

响应体格式​

{ "stateCode": 0, "stateMsg": "" }

参数说明如下：

参数名说明
stateCodeNUMBER 类型，错误码。0 表示成功
stateMsgSTRING 类型，错误消息