Call ListFlows to query a list of flows - CloudFlow

Retrieves information about multiple flows.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fnf:ListFlows

get

*Flow

acs:fnf:{#regionId}:{#accountId}:flow/*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	Starting name for flow query.	flow_nextxxx
Limit	integer	No	Query quantity. The value range is [1, 1000), and the default value is 60.	1
ResourceGroupId	string	No		rg-xxx

Response elements

Element	Type	Description	Example
	object	Flow list.
NextToken	string	Next query starting key. Not returned if no other data exists.	flow_nextxxx
RequestId	string	Request ID.	testRequestId
Flows	array<object>	Flow list.
	array<object>	Flow list.
Type	string	Flow type.	FDL
Definition	string	Flow definition, follows FDL syntax standard.	version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
RoleArn	string	Resource descriptor information required for flow execution.	acs:ram::${accountID}:${role}
Description	string	Flow description.	my test flow
Name	string	Flow name.	my_flow_name
CreatedTime	string	Flow creation time.	2019-01-01T01:01:01.001Z
LastModifiedTime	string	Last modified time of the flow.	2019-01-01T01:01:01.001Z
Id	string	Unique ID of the flow.	e589e092-e2c0-4dee-b306-3574ddf5****
ExecutionMode	string	Execution mode, enumeration type. Can be Express or Standard. An empty string is equivalent to Standard.	Standard
Environment	object	List of variables accessible during flow execution.
Variables	array<object>	List of variables accessible during flow execution.
	object	List of variables accessible during flow execution.
Description	string	Variable description.	description
Name	string	Variable name.	key
Value	string	Variable value.	value
ResourceGroupId	string		rg-xxx

Examples

Success response

JSON format

{
  "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": "my test flow",
      "Name": "my_flow_name",
      "CreatedTime": "2019-01-01T01:01:01.001Z",
      "LastModifiedTime": "2019-01-01T01:01:01.001Z",
      "Id": "e589e092-e2c0-4dee-b306-3574ddf5****",
      "ExecutionMode": "Standard",
      "Environment": {
        "Variables": [
          {
            "Description": "description",
            "Name": "key",
            "Value": "value"
          }
        ]
      },
      "ResourceGroupId": "rg-xxx"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ActionNotSupported	The requested API operation '%s' is incorrect. Please check.
400	APIVersionNotSupported	The requested API version '%s' is not supported yet. Please check.
400	InvalidArgument	Parameter error.	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.	The HTTP query '%s' must be specified.
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.
403	AccessDenied	The resources doesn't belong to you.
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.	The AccessKey ID %s is invalid.
403	RequestTimeTooSkewed	The 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.
403	SignatureNotMatch	The 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.
415	UnsupportedMediaType	The content type must be "application/json".	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.	The request is throttled. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.