更新时间:2024-04-12 GMT+08:00
分享

查询工作流列表

功能介绍

本接口用于查询工作流列表。

请求消息样式

GET /v2/workflows/{graph_name_prefix}?x-workflow-start={start}&x-workflow-limit={limit}&x-workflow-prefix HTTP/1.1
Host: obs.cn-north-4.myhuaweicloud.com 
Authorization: authorization
Content-Type: application/json
Content-Length: length
Date: date

请求消息参数

表1 请求消息参数

名称

是否必选

参数类型

说明

约束

graph_name_prefix

String

工作流的名称前缀。

名称必须以字母或数字开头,只能由字母、数字、下划线和中划线组成,长度小于等于64个字符。

x-workflow-prefix

String

按前缀查询工作流。

不需要传值。

x-workflow-start

Int

查询的起始位置。

start大于等于1,最大1000,不设置则取默认值1。

x-workflow-limit

Int

请求返回的最大记录条数。

limit取值最小1,最大1000,不设置则取默认值10。

请求消息头

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

请求消息元素

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

响应消息样式

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

json body

响应消息头

该请求的响应消息使用公共消息头,具体请参考表1

响应消息元素

名称

参数类型

说明

count

Int

列表条数。

graphs

Array GraphItem

工作流模板列表信息。

next_start

Int

下一次查询的起始位置。

is_truncated

Boolean

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

表2 GraphItem结构体说明

名称

参数类型

说明

name

String

工作流的名称。

created_at

String

系统记录的创建工作流模板的时间。

graph_urn

String

工作流的URN。

错误响应消息

无特殊错误,所有错误已经包含在表2中。

请求示例

GET /v2/workflows/{graph_name_prefix}?x-workflow-start={start}&x-workflow-limit={limit}&x-workflow-prefix HTTP/1.1
Host: obs.cn-north-4.myhuaweicloud.com 
Date: Thu, 27 Aug 2020 12:38:10 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo=
Content-Type: application/json
Content-Length: 0

响应示例

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_start": 3,
    "graphs": [{
        "name": "<graph_name>",
        "create_at": "2020-04-23T12:32:11.131Z",
        "graph_urn": "urn:fgs:<region_id>:<project_id>:graph:<graph_name>"
    }]
}
分享:

    相关文档

    相关产品