使用DescribeExecution API获取执行状态-云工作流-阿里云

获取一次执行的状态信息，支持长轮询模式，长轮询最长等待时间由 WaitTimeSeconds 参数指定。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

fnf:DescribeExecution

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
FlowName	string	是	流程名称。	my_flow_name
ExecutionName	string	是	执行名称。	my_exec_name
WaitTimeSeconds	integer	否	请求长轮询的最长等待时间。取值范围[0,60]，单位为秒。取值说明如下：取值等于 0：请求立即返回当前执行状态。取值大于 0：请求在服务端长轮询等待执行结束，最长等待设定的秒数。	20

返回参数

名称	类型	描述	示例值
	object	返回数据。
Status	string	执行状态。取值说明如下： Starting Running Stopped Succeeded Failed TimedOut	Succeeded
StoppedTime	string	执行停止时间。	2019-01-01T01:01:01.001Z
RequestId	string	请求 ID。	testRequestId
StartedTime	string	执行开始时间。	2019-01-01T01:01:01.001Z
FlowDefinition	string	执行的流程定义。	旧版： "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"
Output	string	执行的输出，为 JSON 对象格式。	{"key":"value"}
FlowName	string	流程名称。	my_flow_name
Name	string	执行名称。	my_exec_name
Input	string	执行的输入，为 JSON 对象格式。	{"key":"value"}
Environment	object	Flow 执行时使用的环境变量列表
Variables	array<object>	Flow 执行时使用的环境变量列表
	object	Flow 执行期间可以访问的变量列表
Name	string	变量名称	key
Value	string	变量值	value

示例

正常返回示例

JSON格式

{
  "Status": "Succeeded",
  "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\"}",
  "Environment": {
    "Variables": [
      {
        "Name": "key",
        "Value": "value"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidArgument	Parameter error.	请求参数错误。具体内容请参考实际错误信息。
400	MissingRequiredHeader	The HTTP header '%s' must be specified.	请求所需参数缺失。具体内容请参考实际错误信息。
400	MissingRequiredParams	The HTTP query '%s' must be specified.	请求所需参数缺失。具体内容请参考实际错误信息。
400	ActionNotSupported	The requested API operation '%s' is incorrect. Please check.
400	APIVersionNotSupported	The requested API version '%s' is not supported yet. Please check.
400	EntityTooLarge	The payload size exceeds maximum allowed size (%s bytes).	请求消息体过大。
412	PreconditionFailed	The resource to be modified has been changed.	资源查看或更新检查失败，该资源可能已被更改。请稍后重试。
500	InternalServerError	An internal error has occurred. Please retry.	服务器内部错误。请稍后重试。
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.	AccessKey ID无效。
403	RequestTimeTooSkewed	The difference between the request time %s and the current time %s is too large.	您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。
403	SignatureNotMatch	The request signature we calculated does not match the signature you provided. Check your access key and signing method.	您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。
403	AccessDenied	The resources doesn't belong to you.
404	ExecutionNotExists	Execution %s for flow %s does not exist.	所请求资源不存在，请确保流程已创建并存在待查询的执行。
404	FlowNotExists	Flow %s does not exist.	所请求资源不存在，请确保流程已创建。
415	UnsupportedMediaType	The content type must be "application/json".	请求消息体类型错误。
429	ResourceThrottled	The request is throttled. Please try again later.	因某些原因系统流量已达瓶颈。请稍后重试。

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

变更历史

更多信息，参考变更详情。