一类节点--数据传输服务dts-释放DTS任务
接口功能介绍
释放一个DTS数据迁移或者数据同步实例(退订)。
接口约束
无
URI
POST /dts/v1/open-api/instance/delete
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | 实例id | 967086730129204281 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
---|---|---|---|---|---|
statusCode | Integer | 返回码 | 0 | ||
error | String | 错误码,格式为:DTS_{statusCode} | DTS_1701 | ||
message | String | 返回消息 | 释放任务失败 | ||
returnObj | Object | 返回数据 | {} |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"prodInstId":"967086730129204281"
}
响应示例
{
"statusCode": 0,
"message": "成功",
"returnObj": {},
"error": ""
}
{
"statusCode": 1701,
"message": "释放任务失败",
"returnObj": {},
"error": "DTS_1701"
}
{
"statusCode": 9997,
"message": "根据提供的参数未找到对应的任务",
"returnObj": {},
"error": "DTS_9997"
}
{
"statusCode": 9998,
"message": "请求参数jobId不合法",
"returnObj": {},
"error": "DTS_9998"
}