CancelAgentSession - DataWorks: Central de Documentação do Alibaba Cloud

Descrição da operação

Descrição da solicitação

Esta operação é usada principalmente para interromper ativamente uma sessão em andamento, especialmente quando a sessão está em estado de resposta em streaming.
sessionId é um parâmetro obrigatório que identifica a sessão específica a ser cancelada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:CancelAgentSession

none

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Jsonrpc	string	Não	A versão do JSON-RPC. Valor fixo: 2.0.	2.0
Id	string	Não	O ID fornecido pelo solicitante, retornado inalterado na resposta.	676303114031776
Params	object	Não	Os parâmetros de negócio da solicitação.
SessionId	string	Não	O ID da sessão a ser cancelada. Este parâmetro é obrigatório.	sess_0f12abc34

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
RequestId	string	O ID da solicitação.	7CD3D216-5876-5DB1-A34A-396806F4A413
JsonRpcResponse	object	A resposta JSON-RPC.
Jsonrpc	string	A versão do JSON-RPC. Valor fixo: 2.0.	2.0
Id	string	O ID fornecido pelo solicitante, retornado inalterado na resposta.	7675839888324361477
Result	object	O objeto de resultado do cancelamento da sessão.
SessionId	string	O ID da sessão.	session-d5d549fe4c2c4180a9814fb74190f502

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.