GetFlow - Queries the details of a flow-阿里云帮助中心

Queries the details of a flow.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
FlowId	string	Yes	The ID of the flow.	flow-xxxxx
FlowVersion	string	No	The version of the flow.	6

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	B6E1E38D-011F-5368-ADD8-4DC278254AA3
Flow	object	The flow object.
FlowId	string	The flow ID.	flow-xxxxxxxx
FlowVersion	string	The flow version.	2
FlowName	string	The flow name.	WeChat Flow 1
FlowDesc	string	The flow description.	Sends an AI card to a DingTalk group chat. To support private chat as well, use a template that supports both group chat and private chat.
Enabled	string	Indicates whether the flow is enabled.	true
FlowVersionStatus	string	The flow version status.	1
FlowTemplate	string	The flow template content.	{ "FormatVersion": "appflow-2025-07-01", "Nodes": [ {} ] }
GmtCreate	string	The creation time.	2025-07-30T02:13:22Z
GmtModified	string	The last modification time.	2025-11-13T02:11:56Z
FlowNodes	array<object>	The list of nodes.	Flow node information.
	object
FlowId	string	The flow ID.	flow-856cb84b309747e48b43
FlowVersion	string	The flow version.	1
ConnectorId	string	The connector ID.	connector-xxx24b139c62
ConnectorVersion	string	The connector version.	2
RefId	string	The ID of the trigger or action.	trigger-xxxxxxxxxx
RefVersion	string	The trigger or action version.	1
NodeId	string	The node ID.	fn-xxxxxxxx
NodeKey	string	The node key.	Node1
NodeName	string	The node name.	NotifyMessage_1
NodeType	string	The node type.	Trigger
PrevNodeId	string	The ID of the previous node.	fn-xxxxx,fn-yyyyyy
InputSchema	string	The metadata of the node.	{}
AuthMetadata	string	The authentication credentials of the node.	{\"authconfigId\":\"uac-xxxxxxxxx\"}
WebhookUrl	string	The webhook URL.	https://{uid}.computenest.aliyun.com/webhook/xxxxxxxx
Tags	array<object>	A list of tags.
	object
Key	string	The tag key. The value can be up to 64 characters in length.	Environment
Value	string	The tag value.	pre

Examples

Success response

JSON format

{
  "RequestId": "B6E1E38D-011F-5368-ADD8-4DC278254AA3",
  "Flow": {
    "FlowId": "flow-xxxxxxxx",
    "FlowVersion": "2",
    "FlowName": "WeChat Flow 1",
    "FlowDesc": "Sends an AI card to a DingTalk group chat. To support private chat as well, use a template that supports both group chat and private chat.",
    "Enabled": "true",
    "FlowVersionStatus": "1",
    "FlowTemplate": "{\n  \"FormatVersion\": \"appflow-2025-07-01\",\n  \"Nodes\": [\n        {}\n   ]\n}",
    "GmtCreate": "2025-07-30T02:13:22Z",
    "GmtModified": "2025-11-13T02:11:56Z",
    "FlowNodes": [
      {
        "FlowId": "flow-856cb84b309747e48b43",
        "FlowVersion": "1",
        "ConnectorId": "connector-xxx24b139c62",
        "ConnectorVersion": "2",
        "RefId": "trigger-xxxxxxxxxx",
        "RefVersion": "1",
        "NodeId": "fn-xxxxxxxx",
        "NodeKey": "Node1",
        "NodeName": "NotifyMessage_1",
        "NodeType": "Trigger",
        "PrevNodeId": "fn-xxxxx,fn-yyyyyy",
        "InputSchema": "{}",
        "AuthMetadata": "{\\\"authconfigId\\\":\\\"uac-xxxxxxxxx\\\"}",
        "WebhookUrl": "https://{uid}.computenest.aliyun.com/webhook/xxxxxxxx"
      }
    ],
    "Tags": [
      {
        "Key": "Environment",
        "Value": "pre"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.