调用SuspendTaskFlowInstance接口，暂停运行中的任务流实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 SuspendTaskFlowInstance

系统规定参数。取值：SuspendTaskFlowInstance。

Tid Long 否 3***

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息，详情请参见查看租户信息。
DagId Long 是 7***

任务流ID，可通过调用接口ListTaskFlow或ListLhTaskFlowAndScenario获取该参数的值。

DagInstanceId Long 是 47****

任务流运行记录ID，可通过调用接口ListTaskFlowInstance获取该参数的值。

返回数据

名称 类型 示例值 描述
RequestId String 028BF827-3801-5869-8548-F4A039256305

请求ID，用于定位日志，排查问题。
ErrorCode String UnknownError

错误码。
ErrorMessage String UnknownError

调用失败时，返回的错误信息。
Success Boolean true

请求是否成功，返回值如下：

  • true：请求成功
  • false：请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=SuspendTaskFlowInstance
&Tid=3***
&DagId=7***
&DagInstanceId=47****
&公共请求参数

正常返回示例

XML格式 

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

<SuspendTaskFlowInstanceResponse>
    <RequestId>028BF827-3801-5869-8548-F4A039256305</RequestId>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
</SuspendTaskFlowInstanceResponse>

JSON格式 

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

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

错误码

访问错误中心查看更多错误码。