查询工作流列表ListWorkflows
接口说明
本接口用于查询工作流列表。
URL
GET https://dwr.cn-south-1.myhuaweicloud.com/v3/{project_id}/workflows
请求参数
| 名称 | 类型 | IN | 必选 | 描述 |
|---|---|---|---|---|
|
X-Auth-Token
|
string | header | 是 |
用户Token。通过调用 IAM 服务获取用Token接口获取(相应消息头中X-Subject-Token的值)。 |
|
project_id
|
string | path | 是 |
项目ID。 |
|
prefix
|
string | query | 否 |
工作流的名称前缀。名称必须以字母或数字开头,只能由字母、数字、下划线和中划线组成,长度小于等于64个字符。 |
|
offset
|
integer | query | 否 |
查询的起始位置。start大于等于1,最大1000,不设置则取默认值1。 |
|
limit
|
integer | query | 否 |
请求返回的最大记录条数。limit取值最小1,最大1000,不设置则取默认值10。 |
返回参数
返回码: 200
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
Content-Length
|
string | 否 |
响应消息体的字节长度。 |
|
Connection
|
string | 否 |
指明与服务器的连接是长连接还是短连接。有效值:keep-alive | close。 |
|
Date
|
string | 否 |
DWR系统响应的时间。 |
|
x-request-id
|
string | 否 |
由DWR创建来唯一确定本次请求的值,可以通过该值来定位问题。 |
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
count
|
integer | 否 |
列表总条数。 |
|
graphs
|
Array of GraphItem objects | 否 |
工作流模板列表信息。 |
|
next_offset
|
integer | 否 |
下一次查询的起始位置。 |
|
is_truncated
|
boolean | 否 |
表明是否本次返回的ListWorkflow结果列表被截断。“true”表示本次没有返回全部结果;“false”表示本次已经返回了全部结果。 |
200 graphs
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
name
|
string | 否 |
工作流的名称。 |
|
created_at
|
string | 否 |
系统记录的创建工作流模板的时间。 |
|
graph_urn
|
string | 否 |
工作流的URN。 |
|
id
|
string | 否 |
工作流ID |
返回码: 400
请求参数错误
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error_msg
|
string | 否 |
错误详细描述 |
|
error_code
|
integer | 否 |
简单错误码 |
|
request_id
|
string | 否 |
请求唯一标识ID |
返回码: 401
请求未认证
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error_msg
|
string | 否 |
错误详细描述 |
|
error_code
|
integer | 否 |
简单错误码 |
|
request_id
|
string | 否 |
请求唯一标识ID |
返回码: 403
没有访问权限
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error_msg
|
string | 否 |
错误详细描述 |
|
error_code
|
integer | 否 |
简单错误码 |
|
request_id
|
string | 否 |
请求唯一标识ID |
返回码: 500
系统内部错误
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error_msg
|
string | 否 |
错误详细描述 |
|
error_code
|
integer | 否 |
简单错误码 |
|
request_id
|
string | 否 |
请求唯一标识ID |
返回示例
返回码：200
示例 1
{
"count": 1,
"is_truncated": true,
"next_offset": 3,
"graphs": [
{
"name": "<graph_name>",
"create_at": "2020-04-23T12:32:11.131Z",
"graph_urn": "urn:fgs:<region_id>:<project_id>:graph:<graph_name>"
}
]
}
"count": 1,
"is_truncated": true,
"next_offset": 3,
"graphs": [
{
"name": "<graph_name>",
"create_at": "2020-04-23T12:32:11.131Z",
"graph_urn": "urn:fgs:<region_id>:<project_id>:graph:<graph_name>"
}
]
}
SDK
点击 数据工坊 (DWR) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明。
