文档

StopExecution - 停止一个正在执行的流程

更新时间:

停止一个正在执行的流程。

接口说明

流程必须为执行中。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
FlowNamestring

需要停止的流程名称,可以通过 ListFlows 的返回值获取。

my_flow_name
ExecutionNamestring

需要停止的执行名称,可以通过 ListExecutions 的返回值获取。

my_exec_name
Causestring

停止错误原因。长度为 1~4096 个字符。

for test
Errorstring

停止错误代码。长度为 1~128 个字符。

nill

返回参数

名称类型描述示例值
object

返回数据。

Statusstring

执行状态。取值说明如下:

  • Starting
  • Running
  • Stopped
  • Succeeded
  • Failed
  • TimedOut
Running
StoppedTimestring

执行停止时间。

2019-01-01T01:01:01.001Z
RequestIdstring

请求 ID。

testRequestId
StartedTimestring

执行开始时间。

2019-01-01T01:01:01.001Z
FlowDefinitionstring

执行的流程定义。

旧版: "type: flow\nversion: v1\nname: my_flow_name\nsteps:\n - type: pass\n name: mypass" 新版: "Type: StateMachine\nSpecVersion: v1\nName: my_flow_name\nStartAt: my_state\nStates:\n - Type: Pass\n Name: my_state\n End: true"
Outputstring

执行的输出,为 JSON 对象格式。

{"key":"value"}
FlowNamestring

流程名称。

my_flow_name
Namestring

执行名称。

my_exec_name
Inputstring

执行的输入,为 JSON 对象格式。

{"key":"value"}

示例

正常返回示例

JSON格式

{
  "Status": "Running",
  "StoppedTime": "2019-01-01T01:01:01.001Z",
  "RequestId": "testRequestId",
  "StartedTime": "2019-01-01T01:01:01.001Z",
  "FlowDefinition": "旧版:\n\"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n  - type: pass\\n    name: mypass\"\n\n新版:\n\"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n  - Type: Pass\\n    Name: my_state\\n    End: true\"",
  "Output": "{\"key\":\"value\"}",
  "FlowName": "my_flow_name",
  "Name": "my_exec_name",
  "Input": "{\"key\":\"value\"}"
}

错误码

HTTP status code错误码错误信息描述
400ActionNotSupportedThe requested API operation '%s' is incorrect. Please check.-
400APIVersionNotSupportedThe requested API version '%s' is not supported yet. Please check.-
400EntityTooLargeThe payload size exceeds maximum allowed size (%s bytes).请求消息体过大。
400ExecutionAlreadyCompletedExecution '%s' for flow '%s' has already completed.-
400InvalidArgumentParameter error.请求参数错误。具体内容请参考实际错误信息。
400MissingRequiredHeaderThe HTTP header '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
400MissingRequiredParamsThe HTTP query '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
403AccessDeniedThe resources doesn't belong to you.-
403InvalidAccessKeyIDThe AccessKey ID %s is invalid.AccessKey ID无效。
403RequestTimeTooSkewedThe difference between the request time %s and the current time %s is too large.您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。
403SignatureNotMatchThe request signature we calculated does not match the signature you provided. Check your access key and signing method.您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。
404ExecutionNotExistsExecution %s for flow %s does not exist.所请求资源不存在,请确保流程已创建并存在待查询的执行。
404FlowNotExistsFlow %s does not exist.所请求资源不存在,请确保流程已创建。
409ConcurrentUpdateErrorUpdate conflict, please retry.所请求资源存在并发写操作。请等待一段时间后再次操作。
415UnsupportedMediaTypeThe content type must be "application/json".请求消息体类型错误。
429ResourceThrottledThe request is throttled. Please try again later.因某些原因系统流量已达瓶颈。请稍后重试。
500InternalServerErrorAn internal error has occurred. Please retry.服务器内部错误。请稍后重试。

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

变更历史

变更时间变更内容概要操作
2024-03-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:409
    删除错误码:415
    删除错误码:429
    删除错误码:500
入参OpenAPI 入参发生变更
    删除入参:RequestId