Stop Task
Last Updated：2021-05-11
Interface Description
Stop the tasks.
Request URI
POST /v{version}/task/{dtsId}/shutdown
| Parameter name | Parameter type | Required | Description | Example value | Parameter position |
|---|---|---|---|---|---|
| version | String | Yes | API version number | "1" | Path |
| dtsId | String | Yes | Task ID | "dtsmxxxyyy" | Path |
Request Body Parameters
No
Response Header Parameters
No other special header fields are available, except for common header fields.
Response Body Parameters
Instructions for Data Structure of Response Body Field
| Parameter name | Parameter type | Required | Description | Example value |
|---|---|---|---|---|
| success | boolean | Yes | Whether it is successful or not | true |
| result | Object | No | Not used yet | null |
Request Example
POST /v1/task/{dtsId}/shutdown
<Common request header>Response Example
HTTP/1.1 200 OK
<Common response header>
{
"result" : { },
"success" : true
}Error Code
See universal error code.