CancelAgentSession - CancelAgentSession - DataWorks - Alibaba Cloud Documentation Center

Cancels an agent call in a specified session. This operation also supports interrupting an ongoing streaming response.

Operation description

Description

This operation is used to actively interrupt an ongoing session, especially when the session is generating a streaming response.
sessionId is a required parameter that identifies the specific session to cancel.

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
Jsonrpc	string	No	The JSON-RPC version. Fixed value: 2.0.	2.0
Id	string	No	The ID passed by the requester. The value is returned as-is in the response.	676303114031776
Params	object	No	The business parameters of the request.
SessionId	string	No	The ID of the session to cancel. This parameter is required.	sess_0f12abc34

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	7CD3D216-5876-5DB1-A34A-396806F4A413
JsonRpcResponse	object	The JSON-RPC response.
Jsonrpc	string	The JSON-RPC version. Fixed value: 2.0.	2.0
Id	string	The ID passed by the requester. The value is returned as-is in the response.	7675839888324361477
Result	object	The result object of the session cancellation.
SessionId	string	The session ID.	session-d5d549fe4c2c4180a9814fb74190f502

Examples

Success response

JSON format

{
  "RequestId": "7CD3D216-5876-5DB1-A34A-396806F4A413",
  "JsonRpcResponse": {
    "Jsonrpc": "2.0",
    "Id": "7675839888324361477",
    "Result": {
      "SessionId": "session-d5d549fe4c2c4180a9814fb74190f502"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.