Stops a task flow instance that is running.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes StopTaskFlowInstance

The operation that you want to perform. Set the value to StopTaskFlowInstance.

Tid Long No 3***

The ID of the tenant.

Note To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.
DagId Long Yes 7***

The ID of the task flow. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to query the task flow ID.

DagInstanceId Long Yes 47****

The ID of the execution record of the task flow. You can call the ListTaskFlowInstance operation to query the ID.

Response parameters

Parameter Type Example Description
RequestId String 028BF827-3801-5869-8548-F4A039256308

The ID of the request. You can use the ID to query logs and troubleshoot issues.

ErrorCode String UnknownError

The error code returned if the request failed.

ErrorMessage String UnknownError

The error message returned if the request failed.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.

Examples

Sample requests

 
 
 
 
&Common request parameters
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<StopTaskFlowInstanceResponse>
    <RequestId>028BF827-3801-5869-8548-F4A039256308</RequestId>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
</StopTaskFlowInstanceResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "028BF827-3801-5869-8548-F4A039256308",
  "ErrorCode" : "UnknownError",
  "ErrorMessage" : "UnknownError",
  "Success" : true
}

Error codes

For a list of error codes, visit the API Error Center.