Help Center> Object Storage Service> API Reference> APIs> Data+> Querying the Workflow List
View PDF

Querying the Workflow List

Functions

Queries a workflow list.

Request Syntax

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

Request parameters

Table 1 Request parameters

Parameter

Mandatory

Type

Description

Constraints

graph_name_prefix

No

String

Workflow name prefix

The name should start with a letter or digit, and contain a maximum of 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

x-workflow-prefix

Yes

String

This API queries workflows by prefix.

No parameter value needs to be passed.

x-workflow-start

No

Int

Start position of a query

The value is greater than or equal to 1. The maximum value is 1000. If this parameter is not specified, the default value 1 is used.

x-workflow-limit

No

Int

Maximum number of records returned for a request.

The value ranges from 1 to 1000. If this parameter is not specified, the default value 10 is used.

Request Headers

This request uses common headers. For details, see Table 3.

Request Elements

This request contains no message parameters.

Response Syntax

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

json body

Response Headers

The response to the request uses common headers. For details, see Table 1.

Response Elements

Parameter

Type

Description

count

Int

Number of records in a list

graphs

Array GraphItem

Workflow template list.

next_start

Int

Start position for the next query

is_truncated

Boolean

Whether the returned ListWorkflow result is truncated. true: Not all results are returned. false: All results are returned.
Table 2 Parameters in the GraphItem structure

Parameter

Type

Description

name

String

Workflow name

created_at

String

Creation time of a workflow template recorded in the system

graph_urn

String

Workflow URN

Error Responses

No special error responses are returned. For details about error responses, see Table 2.

Sample Request

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

Sample Response

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>"
    }]
}
Parent topic: Data+