ListFlow - Chat App Message Service - Alibaba Cloud Documentation Center

Queries a list of Flows.

Operation description

You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cams:ListFlow	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
FlowName	string	No	The name of the Flow that you want to query. If FlowName is left empty, the information about all Flows is queried.	flow_001
Page	object	No	The returned pages.
Size	integer	No	The number of entries per page.	20
Index	integer	No	The page number.	1
CustSpaceId	string	No	The space ID of the RAM user within the independent software vendor (ISV) account.	99948484

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1612C226-E271-4CFE-9F18-4066D550F91B
Code	string	If OK is returned, the request was successful.	OK
Message	string	The error message.	None
Data	array<object>	The returned data.
	object	The returned data.
FlowId	string	The Flow ID.	3939393***
FlowName	string	The Flow name.	flow-02020
Categories	array	The categories of the Flows.
	string	The category of the Flow.	SIGN_UP

Examples

Sample success responses

JSONformat

{
  "RequestId": "1612C226-E271-4CFE-9F18-4066D550F91B",
  "Code": "OK",
  "Message": "None",
  "Data": [
    {
      "FlowId": "3939393***",
      "FlowName": "flow-02020",
      "Categories": [
        "SIGN_UP"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	Product.Unsubscript	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.

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

Change history

Change time	Summary of changes	Operation
2024-04-26	API Description Update. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details