查询工作流实例列表-ListWorkflowExecution

功能介绍

本接口用于查询用户工作流的实例列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。

URI

GET /v3/{project_id}/workflowexecutions

请求消息样式

GET /v2/workflowexecutions?x-workflow-next-marker={marker}&x-workflow-limit={limit}&x-workflow-graph-name={graph_name}&x-workflow-execution-type={execution_type} HTTP/1.1
Host: obs.cn-north-4.myhuaweicloud.com 
Authorization: authorization
Content-Type: application/json
Content-Length: length
Date: date

请求消息参数

表1 参数说明
名称	是否必选	参数类型	说明	约束
x-workflow-execution-type	否	String	工作流实例的执行方式。	只能是如下枚举值： APICALL：要查询以API触发的工作流实例。 TRIGGERCAL：要查询以事件触发的工作流实例列表。
x-workflow-next-marker	否	String	列举列表时，指定一个标识符，返回的工作流实例列表将是按照字典顺序排序后这个标识符以后的所有工作流实例。	该标识由两部分组成：触发类型+工作流实例名，其中触发类型枚举值见“x-workflow-execution-type”字段的约束。
x-workflow-limit	否	Int	请求返回的最大记录条数。	limit取值最小1，最大1000，不设置则取默认值10。
x-workflow-graph-name	是	string	工作流名称。	是已存在的工作流。

请求消息头

该请求使用公共消息头，具体参见表3。

请求消息元素

该请求消息中不使用消息参数。

响应消息样式

HTTP/1.1 status_code 
Date: date 
Content-Length: length 
Content-Type: type
X-Request-ID: obs request id

json body

响应消息头

该请求的响应消息使用公共消息头，具体请参考响应消息头。

响应消息元素

表2 响应元素
名称	参数类型	说明
count	Int	满足条件的运行实例个数。
executions	Array Execution	实例信息列表。
is_truncated	Boolean	表明是否本次返回的结果列表被截断。 true：表示本次没有返回全部结果。 false：表示本次已经返回了全部结果。
next_marker	String	如果本次没有返回全部结果，响应请求中将包含此字段，用于标明本次请求列举到的最后一个工作流实例。后续请求可以指定Marker等于该值来列举剩余的工作流实例。如果is_truncated为false，该字段不会返回。

表3 Execution信息表
名称	参数类型	说明
graph_urn	String	工作流URN。
execution_urn	String	工作流实例URN。
started_at	String	工作流实例启动时间。
execution_type	String	工作流执行方式。 APICAL：表示通过API方式触发。
stopped_at	String	工作流停止时间。
execution_state	String	工作流运行状态。 success：表示成功。 fail：表示失败。 running：表示运行中。 timeout：表示超时。 cancel：表示取消。
execution_name	String	工作流名称。

错误响应消息

无特殊错误，所有错误已经包含在错误码中。

请求示例

GET /v2/workflowexecutions?x-workflow-next-marker={marker}&x-workflow-limit={limit}&x-workflow-graph-name={graph_name}&x-workflow-execution-type={execution_type} HTTP/1.1
Host: obs.cn-north-4.myhuaweicloud.com 
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo=
Content-Type: application/json
Content-Length: 0
Date: Thu, 27 Aug 2020 12:38:10 GMT

响应示例

HTTP/1.1 200 OK 
Date: Thu, 27 Aug 2020 12:38:10 GMT 
Content-Length: 100 
Content-Type: application/json
X-Request-ID: 6a63a18b8bab40ffb71ebd9cb80d0085
{
    "count": 1,
    "is_truncated": true,
    "next_marker": "TRIGGERCALaa76d0ccc918619a2853ce2c5965c592ca6d8dfa1c39635029dacea2",
    "executions": [{
        "graph_urn": "urn:fgs:<region_id>:<project_id>:graph:<graph_name>",
        "execution_urn": "urn:fgs:<region_id>:<project_id>:execution:<graph_name>:<execution_name>:<domain_id>",
        "started_at": "2020-04-23T13:37:43.847Z",
        "execution_type": "APICALL",
        "stopped_at": "",
        "execution_state": "RUNNING",
        "execution_name": "<execution_name>"
    }]
}

父主题：API

上一篇：API异步启动工作流-AsyncInvokeApiStartWorkflow

下一篇：查询工作流实例-GetWorkflowExecution