CancelAgentSession - DataWorks - Centro de documentación de Alibaba Cloud

Descripción de la operación

Descripción de la solicitud

Esta operación se utiliza principalmente para interrumpir activamente una sesión en curso, especialmente cuando la sesión se encuentra en un estado de respuesta en streaming.
sessionId es un parámetro obligatorio que identifica la sesión específica que se va a cancelar.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:CancelAgentSession

none

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Jsonrpc	string	No	La versión de JSON-RPC. Valor fijo: 2.0.	2.0
Id	string	No	El ID proporcionado por el solicitante, que se devuelve sin modificaciones en la respuesta.	676303114031776
Params	object	No	Los parámetros de negocio de la solicitud.
SessionId	string	No	El ID de la sesión que se va a cancelar. Este parámetro es obligatorio.	sess_0f12abc34

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	7CD3D216-5876-5DB1-A34A-396806F4A413
JsonRpcResponse	object	La respuesta JSON-RPC.
Jsonrpc	string	La versión de JSON-RPC. Valor fijo: 2.0.	2.0
Id	string	El ID proporcionado por el solicitante, que se devuelve sin modificaciones en la respuesta.	7675839888324361477
Result	object	El objeto de resultado de la cancelación de la sesión.
SessionId	string	El ID de la sesión.	session-d5d549fe4c2c4180a9814fb74190f502

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.