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

Modifica o título de uma sessão de agente acessível pela identidade atual sem alterar o status de execução da tarefa.

Descrição da operação

Modifica o título de uma sessão de agente acessível pela identidade atual sem alterar o status de execução da tarefa.

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:UpdateAgentSessionTitle

none

*Todos os recursos.

*

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 protocolo JSON-RPC. Defina o valor como 2.0.	2.0
Id	string	Não	O ID de correlação JSON-RPC para a solicitação atual. É especificado pelo chamador e usado para correlacionar a solicitação e a resposta.	updateagentsessiontitle-rpc-001
Params	object	Não	Os parâmetros da solicitação para modificar o título da sessão, incluindo o ID da sessão de destino e o novo título.
SessionId	string	Sim	O ID da sessão do agente que pertence à conta atual.	123e4567-e89b-42d3-a456-426614174000
Title	string	Sim	O novo título. O comprimento deve ser de 1 a 512 caracteres após a remoção dos espaços em branco à esquerda e à direita.	New title

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID exclusivo da solicitação OpenAPI atual. Você pode usá-lo para solucionar problemas de solicitação.	01A0B6E0-E005-1465-B5DE-5CD17677426F
JsonRpcResponse	object	A resposta JSON-RPC. Result é retornado em caso de sucesso, e Error é retornado em caso de erro de protocolo.
Jsonrpc	string	A versão do protocolo JSON-RPC.	2.0
Id	string	O ID de correlação JSON-RPC para a solicitação atual. É passado pelo chamador e retornado como está.	updateagentsessiontitle-rpc-001
Timestamp	integer	A hora da resposta. É um timestamp UNIX em milissegundos.	1789549200000
Result	object	O resultado da operação.
SessionId	string	O ID da sessão do agente cujo título é modificado. Corresponde ao SessionId na solicitação.	123e4567-e89b-42d3-a456-426614174000
Title	string	O título da sessão salvo após a modificação. Os caracteres de espaço em branco à esquerda e à direita são removidos.	New title
Error	object	A mensagem de erro JSON-RPC. Este campo não é retornado em caso de sucesso.
Code	integer	O código de erro JSON-RPC.	500
ErrorCode	string	O código de erro de negócio.	0x4883300000000019
Message	string	A mensagem de erro.	The session does not exist or the current account is not authorized to access it. Return to the session list and select another session
Data	any	As informações adicionais opcionais sobre o erro. O conteúdo depende do tipo de erro.	{}

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "01A0B6E0-E005-1465-B5DE-5CD17677426F",
  "JsonRpcResponse": {
    "Jsonrpc": "2.0",
    "Id": "updateagentsessiontitle-rpc-001",
    "Timestamp": 1789549200000,
    "Result": {
      "SessionId": "123e4567-e89b-42d3-a456-426614174000",
      "Title": "New title"
    },
    "Error": {
      "Code": 500,
      "ErrorCode": "0x4883300000000019",
      "Message": "The session does not exist or the current account does not have access. Return to the session list and select another session",
      "Data": "{}"
    }
  }
}

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.