# 创建UDTS任务 - CreateUDTSTask

## 简介

创建UDTS任务





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `CreateUDTSTask`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.sigcalcloud.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |No|
| **Name** | string | 任务名称，长度不能超过 128 |**Yes**|
| **Type** | string | 任务类型，唯一值：transfer(数据传输)  |**Yes**|
| **Source.N.Mode** | string | 任务模式，值可以是 full, incremental, full+incremental, bidirectional |**Yes**|
| **Source.N.DataType** | string | 数据库类型，比如 mysql/mongo/redis |**Yes**|
| **Source.N.NWType** | string | 源网络类型，可以是 public,user,dedicated_line |**Yes**|
| **Source.N.ServiceType** | string | 服务类型，值可以是small/medium/large/2xlarge/4xlarge |**Yes**|
| **Source.N.BandwidthLimit** | int | 源端限速值，单位为  MB/s |No|
| **Source.N.MySQLNode.Host** | string | MySQL 源数据库地址 |No|
| **Source.N.MySQLNode.Port** | int | MySQL 源数据库端口 |No|
| **Source.N.MySQLNode.User** | string | MySQL 源数据库用户名 |No|
| **Source.N.MySQLNode.Password** | string | MySQL 源数据库密码 |No|
| **Source.N.MySQLNode.VPCId** | string | MySQL 源数据库 VPC ID，当网络类型为 user 时需要填写，可以从 https://console.sigcalcloud.com/vpc/vpc 获取，比如 uvnet-u0ecace |No|
| **Source.N.MySQLNode.SubnetId** | string | MySQL 源数据库子网 ID，当网络类型为 user 时需要填写，可以从 https://console.sigcalcloud.com/vpc/subnet，比如 subnet-2sloxs |No|
| **Source.N.MySQLNode.DataRegion** | string | MySQL 数据库地域，比如 cn-bj2 |No|
| **Source.N.MySQLNode.Database** | string | MySQL 需要迁移的 DB 名称 |No|
| **Source.N.MySQLNode.Table** | string | MySQL 需要迁移的 table 名 |No|
| **Source.N.MySQLNode.SyncData.BinlogName** | string | MySQL 增量时需要指定的 binlog name，可以通过 show master status 获取，或者全量+增量任务会自动设置 |No|
| **Source.N.MySQLNode.SyncData.BinlogPos** | int | MySQL 增量时需要指定的 binlog pos，可以通过 show master status 获取，或者全量+增量任务会自动设置 |No|
| **Source.N.MySQLNode.SyncData.BinlogGTID** | string | MySQL 增量时需要指定的 binlog gtid，可以通过 show master status 获取，或者全量+增量任务会自动设置 |No|
| **Source.N.MySQLNode.SSLSecurity.SSLCA** | string | MySQL ca 证书，目前仅支持 pem 格式; 需要将文件内容 base64 |No|
| **Source.N.MySQLNode.SSLSecurity.SSLCert** | string | MySQL 客户端证书; 需要将文件内容 base64   |No|
| **Source.N.MySQLNode.SSLSecurity.SSLKey** | string | MySQL 客户端私钥， 需要将文件内容 base64   |No|
| **Source.N.MongoNode.Host** | string | Mongo源数据库地址，目前仅支持单点/副本集，示例：192.168.1.100:27017,192.168.1.120:27017,192.168.1.130:27017 |No|
| **Source.N.MongoNode.User** | string | Mongo 源数据库用户名 |No|
| **Source.N.MongoNode.Password** | string | Mongo 源数据库密码 |No|
| **Source.N.MongoNode.Database** | string | Mongo 需要迁移的 DB 名称 |No|
| **Source.N.MongoNode.Collection** | string | Mongo 需要迁移的 collection 名 |No|
| **Source.N.MongoNode.DataRegion** | string | Mongo 源数据库地域，示例： cn-bj2 |No|
| **Source.N.MongoNode.VPCId** | string | Mongo 源数据库 VPC ID，当网络类型为 user 时需要填写，比如 uvnet-u0ecace |No|
| **Source.N.MongoNode.SubnetId** | string | Mongo 源数据库 子网 ID，当网络类型为 user 时需要填写，比如 subnet-2sloxs |No|
| **Source.N.MongoNode.AuthenticationDB** | string | Mongo 源数据库授权数据库名 ，通常为 admin |No|
| **Source.N.RedisNode.Address** | string | Redis 源数据库地址，只填写主(master)地址。集群模式下，多个地址用";"相连，例如：192.168.1.100:6379;192.168.1.120:6379;192.168.1.130:26379 |No|
| **Source.N.RedisNode.Type** | string | Redis 源数据库类型，支持集群（cluster）/主备（standalone） |No|
| **Source.N.RedisNode.Password** | string | Redis 源数据库密码 |No|
| **Source.N.RedisNode.IsRump** | boolean | Redis 是否开启 Rump 模式，当用户无 psync 权限时需要通过Rump同步。 |No|
| **Source.N.RedisNode.DataRegion** | string | Redis 源数据库地域，示例： cn-bj2 |No|
| **Source.N.RedisNode.VPCId** | string | Redis 源数据库 VPC ID，当网络类型为 user 时需要填写，比如 uvnet-u0ecace |No|
| **Source.N.RedisNode.SubnetId** | string | Redis 源数据库 子网 ID，当网络类型为 user 时需要填写，比如 subnet-2sloxs |No|
| **Target.DataType** | string | 目标数据库类型，比如 mysql/mongo/redis |**Yes**|
| **Target.NWType** | string | 目标 db 网络类型，目前仅支持 user |**Yes**|
| **Target.BandwidthLimit** | string | 目标端限速，单位为 MB/s |No|
| **Target.MySQLNode.Host** | string | MySQL 目标数据库地址， 比如 10.9.37.212 |No|
| **Target.MySQLNode.Port** | int | MySQL 目标数据库端口，比如 3306 |No|
| **Target.MySQLNode.User** | string | MySQL 目标数据库用户名，比如 root |No|
| **Target.MySQLNode.Password** | string | MySQL 目标数据库密码 |No|
| **Target.MySQLNode.VPCId** | string | MySQL 目标数据库 VPC,比如 uvnet-1wz5rqte |No|
| **Target.MySQLNode.SubnetId** | string | MySQL 目标数据库子网 ID ,比如 subnet-zl44fktq |No|
| **Target.MySQLNode.DataRegion** | string | MySQL 目标数据库地域，比如 cn-bj2 |No|
| **Target.MySQLNode.NoBinlog** | boolean | MySQL 是否在全量过程中，临时禁用目标 MySQL 产生 binlog，在目标磁盘空间不足，或者需要获取更快的迁移速度时可以使用，该参数会破坏目标 MySQL 的高可用 |No|
| **Target.MongoNode.Host** | string | Mongo 目标数据库地址，目前仅支持单点/副本集，示例：192.168.1.100:27017,192.168.1.120:27017,192.168.1.130:27017 |No|
| **Target.MongoNode.User** | string | Mongo 目标数据库用户名 |No|
| **Target.MongoNode.Password** | string | Mongo 目标数据库密码 |No|
| **Target.MongoNode.DataRegion** | string | Mongo 目标数据库地域，示例： cn-bj2 |No|
| **Target.MongoNode.VPCId** | string | Mongo 目标数据库 VPC ID，示例 uvnet-u0ecace |No|
| **Target.MongoNode.SubnetId** | string | Mongo 目标数据库 子网 ID，示例 subnet-2sloxs |No|
| **Target.MongoNode.AuthenticationDB** | string | Mongo 目标数据库授权数据库名 ，通常为 admin |No|
| **Target.RedisNode.Address** | string | Redis 目标数据库地址，只填写主(master)地址。集群模式下，多个地址用";"相连，例如：192.168.1.100:6379;192.168.1.120:6379;192.168.1.130:26379 |No|
| **Target.RedisNode.Type** | string | Redis 目标数据库类型，支持集群（cluster）/主备（standalone）/分布式（udredis） |No|
| **Target.RedisNode.Password** | string | Redis 目标数据库密码 |No|
| **Target.RedisNode.DataRegion** | string | Redis 目标数据库地域，示例： cn-bj2 |No|
| **Target.RedisNode.VPCId** | string | Redis 目标数据库 VPC ID，示例 uvnet-u0ecace |No|
| **Target.RedisNode.SubnetId** | string | Redis 目标数据库 子网 ID，示例 subnet-2sloxs |No|
| **ChargeType** | string | 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费；Dynamic, 按需付费(需开启权限)；默认为按月付费 |**Yes**|
| **MaxRetryCount** | string | 重试次数，最大为 5。 默认为0 |No|
| **Remark** | string | 备注信息，长度不能大于 255 |No|
| **Quantity** | int | 购买时长, 默认: 1 |No|
| **CouponId** | string | 代金券ID, 默认不使用 |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **Data** | [*CreateUDTSTaskResData*](#CreateUDTSTaskResData) | 创建任务返回信息 |**Yes**|
| **TaskId** | array[string] | 任务ID，目前用于控制台操作日志 |No|

#### 数据模型


#### CreateUDTSTaskResData

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **TaskId** | string | 任务ID |No|

## 示例

### 请求示例
    
```
https://api.sigcalcloud.com/?Action=CreateUDTSTask
&Region=cn-zj
&ProjectId=RxjtEuje
&Name=AxfpqbHf
&Type=LSwCQRth
&Source=DmzCcRiT
&Target=PIVlSiCd
&MaxRetryCount=iPgQdCJm
&Query=YqlCGHLR
&IsDedicatedLine=false
&IsUnidirection=NYPZcshe
&Source.N.Mode=fWsqXqqm
&Source.N.DataType=TGmlMgtA
&Source.N.MySQLNode.Host=nTEGdKOV
&Source.N.MySQLNode.Port=9
&Source.N.MySQLNode.User=PPPsDLEy
&Source.N.MySQLNode.Password=UEEuSVpz
&Source.N.MySQLNode.VPCId=RbLzaWDM
&Source.N.MySQLNode.SubnetId=sHQsachY
&Source.N.MySQLNode.DataRegion=jQPRqZAQ
&Source.N.MySQLNode.Database=HvYuzdTY
&Source.N.MySQLNode.Table=ikPDQCrF
&Source.N.MySQLNode.SyncData.BinlogName=VSbjNbof
&Source.N.MySQLNode.SyncData.BinlogPos=FpQadMWc
&Source.N.MySQLNode.SyncData.ServerID=vcgeBxiE
&Source.N.MySQLNode.SyncData.BinlogGTID=zLehFoxC
&Remark=EtIKkkRF
&Source.N.Mode=uDwvRgXl
&Source.N.DataType=DbBEiBzx
&Source.N.MySQLNode.Host=QCuymrrw
&Source.N.MySQLNode.Port=4
&Source.N.MySQLNode.User=MarpaRLp
&Source.N.MySQLNode.Password=qdYuFUQV
&Source.N.MySQLNode.VPCId=jNXsoOuw
&Source.N.MySQLNode.SubnetId=ZckYkcsB
&Source.N.MySQLNode.DataRegion=hNFUVoFD
&Source.N.MySQLNode.Database=paqulSIo
&Source.N.MySQLNode.Table=LevJUVpc
&Source.N.MySQLNode.SyncData.BinlogName=yWEMtwth
&Source.N.MySQLNode.SyncData.BinlogPos=4
&Source.N.MySQLNode.SyncData.ServerID=7
&Source.N.MySQLNode.SyncData.BinlogGTID=tkPozizE
&Source.N.MySQLNode.QueryData.N.DBName=PmTlGFxe
&Source.N.MySQLNode.QueryData.N.NewDBName=AuKmDOWG
&Source.N.MySQLNode.QueryData.N.TableData.TableNames=YOqUXbCU
&Source.N.MySQLNode.QueryData.N.TableData.ExcludeTables=false
&Source.N.MySQLNode.QueryData.N.TableMaps.N.TableName=TkNweIYw
&Source.N.MySQLNode.QueryData.N.TableMaps.N.NewTableName=Rkpkgosy
&Source.N.MySQLNode.KeepExistData=false
&Source.N.MySQLNode.DupAction=kNJFnpEk
&Remark=EdjTSZqb
&Source.N.Mode=GCHwvAzt
&Source.N.DataType=KgnzrHgW
&Source.N.MySQLNode.Host=eqKqgEch
&Source.N.MySQLNode.Port=3
&Source.N.MySQLNode.User=SkPjrFne
&Source.N.MySQLNode.Password=kXgeJFVs
&Source.N.MySQLNode.VPCId=wKnpHJUL
&Source.N.MySQLNode.SubnetId=EDvTEptA
&Source.N.MySQLNode.DataRegion=UbTExpri
&Source.N.MySQLNode.Database=kbThgUPN
&Source.N.MySQLNode.Table=kUhnQaHD
&Source.N.MySQLNode.SyncData.BinlogName=ucmFxWqu
&Source.N.MySQLNode.SyncData.BinlogPos=8
&Source.N.MySQLNode.SyncData.ServerID=1
&Source.N.MySQLNode.SyncData.BinlogGTID=vmQUWAso
&Source.N.MySQLNode.QueryData.N.DBName=TjzHlKBS
&Source.N.MySQLNode.QueryData.N.NewDBName=wveCIOeo
&Source.N.MySQLNode.QueryData.N.TableData.TableNames=ZLNqouij
&Source.N.MySQLNode.QueryData.N.TableData.ExcludeTables=false
&Source.N.MySQLNode.QueryData.N.TableMaps.N.TableName=dukuiUfI
&Source.N.MySQLNode.QueryData.N.TableMaps.N.NewTableName=bpOzaOOY
&Source.N.MySQLNode.KeepExistData=true
&Source.N.MySQLNode.DupAction=qpKOxddJ
&Target.Mode=RboYuTfl
&Target.DataType=lGvNkvQC
&Target.MySQLNode.Host=WHsxlqhF
&Target.MySQLNode.Port=9
&Target.MySQLNode.User=fqccASPj
&Target.MySQLNode.Password=aiOFwckd
&Target.MySQLNode.VPCId=eCxGDRjy
&Target.MySQLNode.SubnetId=KTYviHnO
&Target.MySQLNode.DataRegion=JAJjVkwt
&Remark=LqITzTWH
&Source.N.Mode=MeuRHalq
&Source.N.DataType=HGtXznTH
&Source.N.MySQLNode.Host=MXzVlABy
&Source.N.MySQLNode.Port=6
&Source.N.MySQLNode.User=VkFlnvFJ
&Source.N.MySQLNode.Password=cZsjBPEN
&Source.N.MySQLNode.VPCId=yhseMSjn
&Source.N.MySQLNode.SubnetId=vzigyOkC
&Source.N.MySQLNode.DataRegion=GNfKXekt
&Source.N.MySQLNode.Database=VDYbUHJz
&Source.N.MySQLNode.Table=HPoGAdzN
&Source.N.MySQLNode.SyncData.BinlogName=WnhzlWBW
&Source.N.MySQLNode.SyncData.BinlogPos=6
&Source.N.MySQLNode.SyncData.ServerID=5
&Source.N.MySQLNode.SyncData.BinlogGTID=dgpWMwNV
&Source.N.MySQLNode.QueryData.N.DBName=tVfORnwW
&Source.N.MySQLNode.QueryData.N.NewDBName=kATgswhS
&Source.N.MySQLNode.QueryData.N.TableData.TableNames=SRIMxFtx
&Source.N.MySQLNode.QueryData.N.TableData.ExcludeTables=true
&Source.N.MySQLNode.QueryData.N.TableMaps.N.TableName=WBnoOVha
&Source.N.MySQLNode.QueryData.N.TableMaps.N.NewTableName=tNKMGxTU
&Source.N.MySQLNode.KeepExistData=true
&Source.N.MySQLNode.DupAction=QjlOgJIR
&Target.Mode=bxjaBkue
&Target.DataType=rxOuZsXz
&Target.MySQLNode.Host=uCNhKVcq
&Target.MySQLNode.Port=8
&Target.MySQLNode.User=SQvUtfEt
&Target.MySQLNode.Password=mFtYsBCO
&Target.MySQLNode.VPCId=mbxEJZpE
&Target.MySQLNode.SubnetId=hLGVVyoA
&Target.MySQLNode.DataRegion=DzsvzZZo
&Source.N.NWType=yGuzFPDP
&Source.N.BandwidthLimit=6
&Target.NWType=AdfJzmEz
&Target.BandwidthLimit=CFGpkzid
&Source.N.MySQLNode.SSLSecurity.SSLCA=MQKwVQcF
&Source.N.MySQLNode.SSLSecurity.SSLCert=yrUzEnuZ
&Source.N.MySQLNode.SSLSecurity.SSLKey=OYuQESyM
&Source.N.ServiceType=vVuYpUaV
&Quantity=4
&ChargeType=diYSAAQT
&CouponId=flfTnXPG
&Source.N.MongoNode.Host=jOcArCZd
&Source.N.MongoNode.User=amxFCIOr
&Source.N.MongoNode.Password=rYXcnHTl
&Source.N.MongoNode.Database=ElkPkNWH
&Source.N.MongoNode.Collection=WPhkpJhm
&Source.N.MongoNode.DataRegion=JyFTKOxm
&Source.N.MongoNode.VPCId=vqCFMzqY
&Source.N.MongoNode.SubnetId=hCQnHnOf
&Source.N.MongoNode.AuthenticationDB=DNfpgmje
&Source.N.MongoNode.Host=XoloecOb
&Source.N.MongoNode.User=RJujHoSU
&Source.N.MongoNode.Password=PYfotPZl
&Source.N.MongoNode.Database=oPgSolHS
&Source.N.MongoNode.Collection=XOSnNHVO
&Source.N.MongoNode.DataRegion=nwdtPFPf
&Source.N.MongoNode.VPCId=wwrHnbCs
&Source.N.MongoNode.SubnetId=SxviaMiA
&Source.N.MongoNode.AuthenticationDB=lpsbChWo
&Target.MongoNode.Host=hSfjPvqy
&Target.MongoNode.User=jacipLQj
&Target.MongoNode.Password=OuTuOwKi
&Target.MongoNode.DataRegion=iAOgTrXd
&Target.MongoNode.VPCId=zwGaJYaj
&Target.MongoNode.SubnetId=zBGmDUBB
&Target.MongoNode.AuthenticationDB=IQRByjAi
&Source.N.MongoNode.Host=NVrbNufM
&Source.N.MongoNode.User=cgjsYZil
&Source.N.MongoNode.Password=LnuQNStS
&Source.N.MongoNode.Database=nnfMCmMC
&Source.N.MongoNode.Collection=MSzRhnDM
&Source.N.MongoNode.DataRegion=pgfEhBrh
&Source.N.MongoNode.VPCId=QrSCDZpD
&Source.N.MongoNode.SubnetId=tCWWthPI
&Source.N.MongoNode.AuthenticationDB=buPTYExP
&Target.MongoNode.Host=CnwhbDFq
&Target.MongoNode.User=SKbuedxG
&Target.MongoNode.Password=MIjQHvPe
&Target.MongoNode.DataRegion=qmbUbYlN
&Target.MongoNode.VPCId=htgZMOon
&Target.MongoNode.SubnetId=ivjlCrgm
&Target.MongoNode.AuthenticationDB=jHBpdtNH
&Source.N.RedisNode.Address=kpSKAwDs
&Source.N.RedisNode.Type=VfKVhntR
&Source.N.RedisNode.Password=MTewqQXi
&Source.N.RedisNode.IsRump=true
&Source.N.RedisNode.DataRegion=LjzpHyjJ
&Source.N.RedisNode.VPCId=FIoQIQom
&Source.N.RedisNode.SubnetId=cnfXdvJV
&Target.RedisNode.Address=DluHSyln
&Target.RedisNode.Type=eAPkfQuT
&Target.RedisNode.Password=VxuXaFmG
&Target.RedisNode.DataRegion=jUWKTnwv
&Target.RedisNode.VPCId=vsXWjiFm
&Target.RedisNode.SubnetId=NSAPtXSF
```

### 响应示例
    
```json
{
  "Action": "CreateUDTSTaskResponse",
  "Data": {},
  "Message": "FnZvjDcL",
  "RetCode": 0,
  "TaskID": "zJeiMttl"
}
```