InvokeAction-阿里云帮助中心

Invokes a connector action.

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 syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ConnectorId	string	Yes	The connector ID.	connector-xxx
ConnectorVersion	string	No	The connector version.	1
ActionId	string	Yes	The action ID.	action-xxx
ActionVersion	string	No	The action version.	1
Body	object	No	The request body for the action.
	any	No	The content of the request body. All content must be in JSON format.	{ "model": "openclaw", "input": "hello" "user": "test-user" }
Headers	object	No	The request header parameters for the action.
	string	No	A request header.	{"X-Request-User":"test"}
Query	object	No	The query parameters for the action.
	string	No	A query parameter.	{"count":3}
Path	object	No	The path parameters for the action.
	string	No	A path parameter.	{"version":1}
AuthConfig	object	No	The authentication information for the action.
Type	string	No	The type of authentication information. Valid values: raw : The raw authentication content in JSON format. id : The ID of the AppFlow credential.	raw
Value	any	No	The authentication content. Its value is a raw JSON object or a credential ID, as determined by the `Type` parameter.	{"AppId":"xxxx","AppSecret":"sk-xxx"}
Stream	boolean	No	Specifies whether to use streaming output.	false

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	346E5EE9-D5FE-56A0-B3E2-A43E0F67302A
Result	object	The execution result.
Status	string	The execution status.	RUNNING、COMPLETED
ErrorMessage	string	The error message.	The provided parameter xxx is invalid.
Output	any	The output of the action.	{ "output": { "finishReason": "stop", "text": "hello" }, "requestId": "433944e3-2163-9c7a-9664-2a27c0dda0ec", "usage": { "inputTokens": 13, "outputTokens": 16, "totalTokens": 29 } }

Examples

Success response

JSON format

{
  "RequestId": "346E5EE9-D5FE-56A0-B3E2-A43E0F67302A",
  "Result": {
    "Status": "RUNNING、COMPLETED",
    "ErrorMessage": "The provided parameter xxx is invalid.",
    "Output": "{\n  \"output\": {\n    \"finishReason\": \"stop\",\n    \"text\": \"hello\"\n  },\n  \"requestId\": \"433944e3-2163-9c7a-9664-2a27c0dda0ec\",\n  \"usage\": {\n    \"inputTokens\": 13,\n    \"outputTokens\": 16,\n    \"totalTokens\": 29\n  }\n}"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.