华为云计算 云知识 本接口用于查询用户工作流的实例列表ListWorkflowInstance
本接口用于查询用户工作流的实例列表ListWorkflowInstance

 

接口说明

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

URL
GET  https://dwr.cn-south-1.myhuaweicloud.com/v3/{project_id}/workflowexecutions 
请求参数
名称 类型 IN 必选 描述
X-Auth-Token
 
string header

用户Token。通过调用 IAM 服务获取用户Token接口获取(相应消息头中X-Subject-Token的值)。

project_id
 
string path

项目ID。

limit
 
integer query

请求返回的最大记录条数。分页查询,每页显示的条目数量,最大数量200,超过200后只返回200

graph_name
 
string query

工作流名称。

start_time
 
string query

查询开始时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间。若起始时间未填写,以终止时间前推3天为起始时间

end_time
 
string query

查询终止时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间。若终止时间未填写,以起始时间后退3天未终止时间。若均未填写,默认查询最近3天数据。

status
 
string query

需要过滤的流程实例状态

最小长度:0

最大长度:64

枚举值:

success

fail

running

timeout

cancel

offset
 
integer query

查询的起始位置。start大于等于1,最大1000,不设置则取默认值1。

返回参数
返回码: 200

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", // 如果本次没有返回全部结果,响应请求中将包含此字段,用于标明本次请求列举到的最后一个工作流实例。后续请求可以指定Marker等于该值来列举剩余的工作流实例。 如果is_truncated为false,该字段不会返回。 "executions": [{ // 实例信息列表。 "graph_urn": "urn:fgs:<region_id>:<project_id>:graph:<graph_name>", // 工作流URN。 "execution_urn": "urn:fgs:<region_id>:<project_id>:execution:<graph_name>:<execution_name>:<domain_id>", // 工作流实例URN。 "started_at": "2020-04-23T13:37:43.847Z", // 工作流实例启动时间。 "execution_type": "APICALL", // 工作流执行方式。 "stopped_at": "", // 工作流停止时间。 "execution_state": "RUNNING", // 工作流运行状态。 "execution_name": "<execution_name>" // 工作流名称。 }] }

名称 类型 必选 描述
Date
 
string  
Content-Length
 
string  
Content-Type
 
string  
X-Request-Id
 
string  
名称 类型 必选 描述
count
 
integer

满足条件的运行实例个数。

executions
 
Array of Execution objects

实例信息列表

is_truncated
 
boolean

表明是否本次返回的结果列表被截断。true:表示本次没有返回全部结果。false:表示本次已经返回了全部结果。

next_offset
 
integer

如果本次没有返回全部结果,响应请求中将包含此字段,用于标明本次请求列举到的最后一个工作流实例。后续请求可以指定Marker等于该值来列举剩余的工作流实例。如果is_truncated为false,该字段不会返回。

200 executions
名称 类型 必选 描述
graph_urn
 
string

工作流URN

execution_urn
 
string

工作流实例URN

started_at
 
string

工作流实例启动时间

execution_type
 
string

工作流执行方式。APICALL代表为通过API方式触发。

stopped_at
 
string

工作流停止时间。

execution_state
 
string

工作流运行状态。success,fail,running,timeout,cancel

execution_name
 
string

工作流名称。

返回码: 400
 
名称 类型 必选 描述
error_msg
 
string

错误详细描述

error_code
 
integer

简单错误码

request_id
 
string

请求唯一标识ID

返回码: 500
 
名称 类型 必选 描述
error_msg
 
string

错误详细描述

error_code
 
integer

简单错误码

request_id
 
string

请求唯一标识ID

请求示例
示例 1
 
"/v3/{project_id}/workflowexecutions?next_marker={marker}&limit={limit}&graph_name={graph_name}"
 
"GET /v3/{project_id}/workflowexecutions?next_marker={marker}&limit={limit}&graph_name={graph_name}&execution_type={execution_type} HTTP/1.1\nHost: dwr.cn-north-4.myhuaweicloud.com\nX-Auth-Token: authorization\nContent-Type: application/json\nContent-Length: length\nDate: date"
返回示例
返回码:200

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", // 如果本次没有返回全部结果,响应请求中将包含此字段,用于标明本次请求列举到的最后一个工作流实例。后续请求可以指定Marker等于该值来列举剩余的工作流实例。 如果is_truncated为false,该字段不会返回。 "executions": [{ // 实例信息列表。 "graph_urn": "urn:fgs:<region_id>:<project_id>:graph:<graph_name>", // 工作流URN。 "execution_urn": "urn:fgs:<region_id>:<project_id>:execution:<graph_name>:<execution_name>:<domain_id>", // 工作流实例URN。 "started_at": "2020-04-23T13:37:43.847Z", // 工作流实例启动时间。 "execution_type": "APICALL", // 工作流执行方式。 "stopped_at": "", // 工作流停止时间。 "execution_state": "RUNNING", // 工作流运行状态。 "execution_name": "<execution_name>" // 工作流名称。 }] }

示例 1
 
 
SDK
点击  数据工坊  (DWR) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明

 

上一篇:优学院如何加入班级 下一篇:A8+协同管理软件产品核心价值(二)

弹性云服务器 ECS

 

弹性云服务器(Elastic Cloud Server)是一种可随时自助获取、可弹性伸缩的云服务器,帮助用户打造可靠、安全、灵活、高效的应用环境,确保服务持久稳定运行,提升运维效率