一类节点--数据传输服务dts-启动DTS任务
接口功能介绍
用户购买DTS实例并配置任务后,调用此OpenApi接口启动DTS迁移/同步任务。
注意:禁止在60s内多次启停任务
接口约束
必须先购买DTS实例并配置任务后,才能调用此接口。
URI
POST /dts/v1/open-api/instance/start-job
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 否 | String | 实例Id说明:1、jobld和prodlnstld至少填写一个;2、jobld和prodlnstld都存在时,以prodlnstld为准 | 037633537988242728 | |
jobId | 否 | Integer | 任务id说明:1、jobld和prodlnstld至少填写一个;2、jobld和prodlnstld都存在时,以prodlnstld为准 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
---|---|---|---|---|---|
statusCode | Integer | 返回码 | 0 | ||
error | String | 错误码,格式为:DTS_{statusCode} | DTS_9999 | ||
message | String | 返回消息 | 成功 | ||
returnObj | Object | 返回信息 | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"prodInstId":"037633537988242728",
"jobId":null
}
响应示例
{
"statusCode":0,
"message":"成功",
"returnObj":{
},
"error":""
}