All Products
Search
Document Center

CloudFlow:ListFlows

Last Updated:Apr 01, 2024

Queries a list of flows.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NextTokenstringNo

The token to start the query.

flow_nextxxx
LimitintegerNo

The number of flows to be queried. Valid values: 1 to 1000.

1

Response parameters

ParameterTypeDescriptionExample
object

The details of flows.

NextTokenstring

The start key for the next query. This parameter is not returned if all results have been returned.

flow_nextxxx
RequestIdstring

The request ID.

testRequestId
Flowsobject []

The details of flows.

Typestring

The type of the flow.

FDL
Definitionstring

The definition of the flow. The definition must comply with the Flow Definition Language (FDL) syntax.

version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
RoleArnstring

The Alibaba Cloud resource name (ARN) of the specified Resource Access Management (RAM) role that Serverless Workflow assumes to invoke resources when the flow is executed.

acs:ram::${accountID}:${role}
Descriptionstring

The description of the flow.

test flow
Namestring

The name of the flow.

flow
CreatedTimestring

The time when the flow was created.

2019-01-01T01:01:01.001Z
LastModifiedTimestring

The time when the flow was last modified.

2019-01-01T01:01:01.001Z
Idstring

The unique ID of the flow.

e589e092-e2c0-4dee-b306-3574ddf5****
ExecutionModestring

The execution mode or the enumeration type. Valid values: Express and Standard. A value of Standard indicates an empty string.

Standard

Examples

Sample success responses

JSONformat

{
  "NextToken": "flow_nextxxx",
  "RequestId": "testRequestId",
  "Flows": [
    {
      "Type": "FDL",
      "Definition": "version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass",
      "RoleArn": "acs:ram::${accountID}:${role}",
      "Description": "test flow",
      "Name": "flow",
      "CreatedTime": "2019-01-01T01:01:01.001Z",
      "LastModifiedTime": "2019-01-01T01:01:01.001Z",
      "Id": "e589e092-e2c0-4dee-b306-3574ddf5****",
      "ExecutionMode": "Standard"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400ActionNotSupportedThe requested API operation '%s' is incorrect. Please check.-
400APIVersionNotSupportedThe requested API version '%s' is not supported yet. Please check.-
400InvalidArgumentParameter error.Parameter error.
400MissingRequiredHeaderThe HTTP header '%s' must be specified.The HTTP header '%s' must be specified.
400MissingRequiredParamsThe HTTP query '%s' must be specified.The HTTP query '%s' must be specified.
403AccessDeniedThe resources doesn't belong to you.-
403InvalidAccessKeyIDThe AccessKey ID %s is invalid.The AccessKey ID %s is invalid.
403RequestTimeTooSkewedThe difference between the request time %s and the current time %s is too large.The difference between the request time %s and the current time %s is too large.
403SignatureNotMatchThe request signature we calculated does not match the signature you provided. Check your access key and signing method.The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm.
415UnsupportedMediaTypeThe content type must be "application/json".The content type must be "application/json".
429ResourceThrottledThe request is throttled. Please try again later.The request is throttled. Please try again later.
500InternalServerErrorAn internal error has occurred. Please retry.An internal error has occurred. Please retry.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-03-14The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 415
    delete Error Codes: 429
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: RequestId
2023-08-29The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 415
    delete Error Codes: 429
    delete Error Codes: 500
Output ParametersThe response structure of the API has changed.