DescribeFlow - CloudFlow - Alibaba Cloud Documentation Center

Queries the information about a flow.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the flow.	flow

Response parameters

Parameter	Type	Description	Example
	object	The schema of response.
Type	string	The type of the workflow.	FDL
Definition	string	The flow definition, which follows the flow definition language (FDL) syntax standard. Considering compatibility, the system supports the two flow definition specifications.	version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
RoleArn	string	The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies. During the execution of the flow, CloudFlow assumes the role to call API operations of relevant services.	acs:ram::${accountID}:${role}
RequestId	string	The request ID.	testRequestId
Description	string	The description of the flow.	test flow
Name	string	The name of the flow.	flow
CreatedTime	string	The time when the flow was created.	2019-01-01T01:01:01.001Z
LastModifiedTime	string	The time when the flow was last modified.	2019-01-01T01:01:01.001Z
Id	string	The unique ID of the flow.	e589e092-e2c0-4dee-b306-3574ddfdddf5****
ExecutionMode	string	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

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-03-20	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-08-29	The Error code has changed. The response structure of the API has changed	View Change Details

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	EntityTooLarge	The payload size exceeds maximum allowed size (%s bytes).	The payload size exceeds maximum allowed size (%s bytes).
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.
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.
404	FlowNotExists	Flow %s does not exist.	Flow %s does not exist.
412	PreconditionFailed	The resource to be modified has been changed.	The resource to be modified has been changed. Please try again later.
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.
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.