CancelAgentSession

Operation description

Request description

This operation is mainly used to actively interrupt an ongoing session, especially when the session is in a streaming response state.
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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:CancelAgentSession

none

*All Resource

*

None

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 in by the requester, 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	Id of the request	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 in by the requester, 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.