Manually Stopping the Current Task
Function
This API is used to manually stop the current task.
URI
POST /v2/{project_id}/fdi/instances/{instance_id}/tasks/{task_id}/terminate
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference. Minimum: 1 Maximum: 64 |
| instance_id | Yes | String | Instance ID. Minimum: 1 Maximum: 64 |
| task_id | Yes | String | Task ID, the unique identifier of a task. Minimum: 1 Maximum: 64 |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| message | String | Message returned when a task is manually started or stopped successfully. Minimum: 1 Maximum: 10 |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. Minimum: 8 Maximum: 36 |
| error_msg | String | Error message. Minimum: 2 Maximum: 512 |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. Minimum: 8 Maximum: 36 |
| error_msg | String | Error message. Minimum: 2 Maximum: 512 |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. Minimum: 8 Maximum: 36 |
| error_msg | String | Error message. Minimum: 2 Maximum: 512 |
Example Requests
None
Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |
Error Codes
See Error Codes.
Last Article: Manually Triggering a Single Task
Next Article: Creating a Schedule
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.