華為云計(jì)算 云知識(shí) 查詢工作流列表ListWorkflows
查詢工作流列表ListWorkflows

 

接口說明

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

URL
GET  https://dwr.cn-south-1.myhuaweicloud.com/v3/{project_id}/workflows 
請求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
string header

用戶Token。通過調(diào)用 IAM 服務(wù)獲取用Token接口獲取(相應(yīng)消息頭中X-Subject-Token的值)。

project_id
 
string path

項(xiàng)目ID。

prefix
 
string query

工作流的名稱前綴。名稱必須以字母或數(shù)字開頭,只能由字母、數(shù)字、下劃線和中劃線組成,長度小于等于64個(gè)字符。

offset
 
integer query

查詢的起始位置。start大于等于1,最大1000,不設(shè)置則取默認(rèn)值1。

limit
 
integer query

請求返回的最大記錄條數(shù)。limit取值最小1,最大1000,不設(shè)置則取默認(rèn)值10。

返回參數(shù)
返回碼: 200
 
名稱 類型 必選 描述
Content-Length
 
string

響應(yīng)消息體的字節(jié)長度。

Connection
 
string

指明與服務(wù)器的連接是長連接還是短連接。有效值:keep-alive | close。

Date
 
string

DWR系統(tǒng)響應(yīng)的時(shí)間。

x-request-id
 
string

由DWR創(chuàng)建來唯一確定本次請求的值,可以通過該值來定位問題。

名稱 類型 必選 描述
count
 
integer

列表總條數(shù)。

graphs
 
Array of GraphItem objects

工作流模板列表信息。

next_offset
 
integer

下一次查詢的起始位置。

is_truncated
 
boolean

表明是否本次返回的ListWorkflow結(jié)果列表被截?cái)唷!皌rue”表示本次沒有返回全部結(jié)果;“false”表示本次已經(jīng)返回了全部結(jié)果。

200 graphs
名稱 類型 必選 描述
name
 
string

工作流的名稱。

created_at
 
string

系統(tǒng)記錄的創(chuàng)建工作流模板的時(shí)間。

graph_urn
 
string

工作流的URN。

id
 
string

工作流ID

返回碼: 400

請求參數(shù)錯(cuò)誤

名稱 類型 必選 描述
error_msg
 
string

錯(cuò)誤詳細(xì)描述

error_code
 
integer

簡單錯(cuò)誤碼

request_id
 
string

請求唯一標(biāo)識(shí)ID

返回碼: 401

請求未認(rèn)證

名稱 類型 必選 描述
error_msg
 
string

錯(cuò)誤詳細(xì)描述

error_code
 
integer

簡單錯(cuò)誤碼

request_id
 
string

請求唯一標(biāo)識(shí)ID

返回碼: 403

沒有訪問權(quán)限

名稱 類型 必選 描述
error_msg
 
string

錯(cuò)誤詳細(xì)描述

error_code
 
integer

簡單錯(cuò)誤碼

request_id
 
string

請求唯一標(biāo)識(shí)ID

返回碼: 500

系統(tǒng)內(nèi)部錯(cuò)誤

名稱 類型 必選 描述
error_msg
 
string

錯(cuò)誤詳細(xì)描述

error_code
 
integer

簡單錯(cuò)誤碼

request_id
 
string

請求唯一標(biāo)識(shí)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>"
}
]
}
SDK
點(diǎn)擊  數(shù)據(jù)工坊  (DWR) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對應(yīng)語言類型的【使用】目錄下。
錯(cuò)誤碼
請參考 錯(cuò)誤碼說明。