创建任务
更新时间：2025-04-11
接口说明
创建数据传输任务。
请求结构
POST /v{version}/task
Host: dts.baidubce.com
Authorization: authorization string
{
"crossRegionTag": 0,
"directionType": "single",
"standard": "large",
"productType": "postpay",
"sourceInstanceType": "public",
"targetInstanceType": "public",
"type": "migration",
"orderInfo":{
"src":{
"instanceType":"public",
"dbType":"mysql",
"region": "bj"
},
"dst":{
"instanceType":"public",
"dbType":"mysql",
"region": "bj"
}
}
}请求参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| version | String | 是 | API版本号 | "1" | URL参数 |
| type | String | 是 | 任务类型（数据传输任务：migration） | migration | Request Body 参数 |
| productType | String | 是 | 付费类型（后付费：postpay），目前仅支持后付费 | postpay | Request Body 参数 |
| standard | String | 是 | 实例规格（small；medium；large；xlarge），吞吐及性能等数据详见链路规格说明 | large | Request Body 参数 |
| sourceInstanceType | String | 是 | 源端类型（百度智能云数据库：bcerds；自建数据存储：public） | bcerds | Request Body 参数 |
| targetInstanceType | String | 是 | 目标端类型（百度智能云数据库：bcerds；自建数据存储：public） | bcerds | Request Body 参数 |
| crossRegionTag | Integer | 是 | 跨地域标识（当源端、目标端类型均为百度智能云数据库且跨地域时：1；其他情况：0） | 0 | Request Body 参数 |
| directionType | String | 是 | 同步方向（单向同步：single；双向同步：bidirect），目前仅支持单向同步 | single | Request Body 参数 |
| orderInfo | OrderInfo | 是 | 购买类型 | orderInfo | Request Body 参数 |
| rollback | Integer | 否 | 一键反向，1为创建一键反向任务，其余时候不传该参数 | 1 | Request Body 参数 |
| bindTags | List<BindTags> | 否 | 绑定标签 | BindTags | Request Body 参数 |
OrderInfo字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| src | Src | 是 | 源端 | src |
| dst | Dst | 是 | 目标端 | dst |
Src字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceType | String | 是 | 源端接入类型 更多接入类型详见支持的数据流 |
public |
| dbType | String | 是 | 源端数据类型： 更多数据类型详见支持的数据流 |
mysql |
| region | String | 是 | 地域，接入类型为bcegateway和一键反向任务时必传 | bj |
| sliceNum | String | 否 | 分片数量,源端为redis(社区集群版、企业集群版)、kafka、mongodb分片集等数据流需要传，其他数据流不传该参数 | 1 |
| zone | String | 否 | 接入类型为bcegateway时，需要指定可用区 | cn-bd-a |
| vpcShortId | String | 否 | 接入类型为bcegateway时，需要指定VPC短ID | vpc-46k27rb9wppz |
| subnetShortId | String | 否 | 接入类型为bcegateway时，需要指定子网短ID | sbn-qtm3d4eituqc |
Dst字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceType | String | 是 | 目标端接入类型 更多接入类型详见支持的数据流 |
public |
| dbType | String | 是 | 目标端数据类型： 更多数据类型详见支持的数据流 |
mysql |
| region | String | 是 | 地域，接入类型为bcegateway和一键反向任务时必传 | bj |
| sliceNum | String | 否 | 分片数量,创建任务组时必传，其余时候不传该参数 | 1 |
| zone | String | 否 | 接入类型为bcegateway时，需要指定可用区 | cn-bd-a |
| vpcShortId | String | 否 | 接入类型为bcegateway时，需要指定VPC短ID | vpc-46k27rb9wppz |
| subnetShortId | String | 否 | 接入类型为bcegateway时，需要指定子网短ID | sbn-qtm3d4eituqc |
BindTags字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| tagKey | String | 是 | 标签 key | 默认项目 |
| tagValue | String | 是 | 标签 value | dtsTask1 |
除公共头域，无其它特殊头域。
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| dtsTasks | List<DtsTask> | 是 | 任务ID列表 | dtsmxxyy1234 |
DtsTask字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| dtsId | String | 是 | 任务ID | dtsmxxyy1234 |
请求示例
POST /v1/task
Host: dts.baidubce.com
ContentType: application/json
Authorization: authorization string
{
"crossRegionTag": 0,
"directionType": "single",
"standard": "large",
"productType": "postpay",
"sourceInstanceType": "public",
"targetInstanceType": "public",
"type": "migration",
"orderInfo":{
"src":{
"instanceType":"public",
"dbType":"mysql",
"region": "bj"
},
"dst":{
"instanceType":"public",
"dbType":"mysql",
"region": "bj"
}
},
"bindTags": [{"tagKey": "默认项目", "tagValue": "dtstest"}]
}响应示例
HTTP/1.1 200 OK
{
"dtsTasks": [
{
"dtsId": "dtsmxxyy1234"
}
]
}