Create UDTS Task - CreateUDTSTask
Overview
Create UDTS Task
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is CreateUDTSTask. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
| Name | string | Task name, length cannot exceed 128 | Yes |
| Type | string | Task type, transfer (data transfer) or integration (data integration) | Yes |
| Source.N.Mode | string | Task mode, the value can be full, incremental, full+incremental, bidirectional | Yes |
| Source.N.DataType | string | Database type, such as mysql | Yes |
| Source.N.NWType | string | Source network type, can be public, user, dedicated_line | Yes |
| Source.N.ServiceType | string | Service type, the value can be small, medium, large, corresponding to "Basic Edition", "Light Edition" and "Flagship Edition" respectively. | Yes |
| Source.N.BandwidthLimit | int | Source speed limit, unit is MB/s | No |
| Source.N.MySQLNode.Host | string | Source Database Address | No |
| Source.N.MySQLNode.Port | int | Source Database Port | No |
| Source.N.MySQLNode.User | string | Source database username | No |
| Source.N.MySQLNode.Password | string | Source Database Password | No |
| Source.N.MySQLNode.VPCId | string | Source database VPC ID, needs to be filled in when the network type is 'user'. It can be obtained from https://console.surfercloud.com/vpc/vpc (opens in a new tab), for example, uvnet-u0ecace. | No |
| Source.N.MySQLNode.SubnetId | string | Source database subnet ID, needs to be filled in when the network type is 'user', can be obtained from https://console.surfercloud.com/vpc/subnet (opens in a new tab), for example, subnet-2sloxs. | No |
| Source.N.MySQLNode.DataRegion | string | Database region, for example cn-bj2 | No |
| Source.N.MySQLNode.Database | string | Name of the DB to be migrated | No |
| Source.N.MySQLNode.Table | string | Name of the table to be migrated | No |
| Source.N.MySQLNode.SyncData.BinlogName | string | The binlog name needs to be specified during the incremental time, which can be obtained through the 'show master status' command, or it will be automatically set in the full + incremental task. | No |
| Source.N.MySQLNode.SyncData.BinlogPos | int | The binlog pos that needs to be specified during incremental time can be obtained through show master status, or it will be automatically set by full + incremental tasks. | No |
| Source.N.MySQLNode.SyncData.ServerID | int | The serverID that needs to be specified during the increment cannot be duplicated with the existing slave. This value will be checked during the pre-check. | No |
| Source.N.MySQLNode.SyncData.BinlogGTID | string | The binlog gtid that needs to be specified during the incremental time can be obtained through the show master status, or it will be automatically set by the full + incremental task. | No |
| QueryData.N.DBName | string | Name of the DB to be migrated during data integration | No |
| QueryData.N.NewDBName | string | DB Name after Data Integration Migration | No |
| QueryData.N.TableData.TableNames | string | This field is temporarily unused | No |
| QueryData.N.TableData.ExcludeTables | boolean | This field is temporarily unused | No |
| TableMaps.N.TableName | string | Table name that needs to be migrated during data integration | No |
| TableMaps.N.NewTableName | string | Table name after data integration migration | No |
| Source.N.MySQLNode.KeepExistData | boolean | Whether to retain the original data, this parameter is only effective when data integration is in progress. | No |
| Source.N.MySQLNode.DupAction | string | Duplication data processing rules, this parameter is only effective during data integration, the value is either ignore or replace. | No |
| Source.N.MySQLNode.SSLSecurity.SSLCA | string | CA certificate, currently only supports PEM format; need to base64 the file content. | No |
| Source.N.MySQLNode.SSLSecurity.SSLCert | string | Client Certificate; The file content needs to be base64 | No |
| Source.N.MySQLNode.SSLSecurity.SSLKey | string | Client private key, the file content needs to be base64 | No |
| Target.Mode | string | Yes | |
| Target.DataType | string | Target database type, for example mysql | Yes |
| Target.NWType | string | Target db network type, currently only supports user | Yes |
| Target.BandwidthLimit | string | Destination end speed limit, unit in MB/s | No |
| Target.MySQLNode.Host | string | Target database address, for example 10.9.37.212 | No |
| Target.MySQLNode.Port | int | Target database port, for example 3306 | No |
| Target.MySQLNode.User | string | Target database username, for example root | No |
| Target.MySQLNode.Password | string | Target Database Password | No |
| Target.MySQLNode.VPCId | string | Target Database VPC, for example uvnet-1wz5rqte | No |
| Target.MySQLNode.SubnetId | string | Target database subnet ID, for example subnet-zl44fktq | No |
| Target.MySQLNode.DataRegion | string | Target database region, for example cn-bj2 | No |
| Target.MySQLNode.NoBinlog | boolean | Whether to temporarily disable the generation of binlog in the target MySQL during the full process, it can be used when the target disk space is insufficient, or when a faster migration speed is needed. This parameter will disrupt the high availability of the target MySQL. | No |
| MaxRetryCount | string | Retry times, maximum is 5. Default is 0. | No |
| Query | string | This field is temporarily unused | No |
| IsUnidirection | string | This field is temporarily unused | No |
| Remark | string | Note information, length cannot exceed 255 | No |
| Quantity | int | Purchase duration, default: 1 | No |
| ChargeType | string | Payment method, enumeration values are: Year, pay annually; Month, pay monthly; Dynamic, pay on demand (permission required); default is monthly payment. | No |
| CouponId | string | Voucher ID, not used by default | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
| Data | object | Yes | |
| TaskId | string | Task ID, currently used for console operation logs | No |
Example
Request Example
https://api.surfercloud.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
&Source.N.MySQLNode.NoBinlog=lBRXNtLr
&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
&Source.N.MySQLNode.NoBinlog=ZmIFChsZ
&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
&Source.N.MySQLNode.NoBinlog=UNQtIBlq
&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=flfTnXPGResponse Example
{
"Action": "CreateUDTSTaskResponse",
"Data": {},
"Message": "FnZvjDcL",
"RetCode": 0,
"TaskID": "zJeiMttl"
}