GetDasAgentSSE - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Descrição da operação

Esta é uma API paga. Você é cobrado com base no número de caracteres de saída. Antes de usar esta API, certifique-se de que você compreende os métodos de cobrança e os preços do produto DAS Agent.

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

hdm:GetDasAgentSSE

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST /getDasAgentSSE HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Query	string	Sim	A consulta em linguagem natural para o agente.	Are there any issues or abnormalities with my instance rm-xxx?
InstanceId	string	Não	Este parâmetro está obsoleto. Especifique o ID da instância no parâmetro Query.	rm-xxxx
SessionId	string	Não	O ID da sessão, que deve estar no formato UUID. Este parâmetro é opcional. Se você não fornecer um ID de sessão, o serviço cria uma nova sessão. Para continuar uma conversa existente, use o mesmo ID de sessão nas solicitações subsequentes.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
AgentId	string	Não	O ID do agente a ser utilizado. Este parâmetro é opcional. Se você não especificar este parâmetro, o serviço utiliza o agente padrão. Você pode fornecer o ID de um agente que foi gerado quando você habilitou o serviço DAS Agent ou que você criou manualmente.	ag-472T0DxtmjIxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
Id	string	O ID da sessão. Este é o mesmo que o SessionId na solicitação.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
Answer	string	O conteúdo da resposta.	rm-xxxx
Metadata	object	Os metadados.
Code	integer	O código de erro. Este parâmetro está vazio se nenhuma exceção ocorrer.	-1810001
CharCount	integer	O número de caracteres na resposta.	1403
ToolName	string	O nome da ferramenta utilizada.	SqlFilter
ToolParams	array	Os parâmetros da ferramenta.
	string	Uma lista de strings.	["--instanceId", "rm-*****", "--sqlText", "select~from~das~where~name~das1"]
RequestId	string	O ID da solicitação.	04930480-9404-50CB-8252-Axxxxxxxx
Event	string	O tipo da mensagem de resposta. Valores válidos: summary : Estatísticas sobre a resposta. [_single.resp.200.props.Event.enum. error ]Uma mensagem de erro. [_single.resp.200.props.Event.enum.agent_message ]A resposta do agente. [responses.200.schema.properties.Event.enumValueTitles. error ]Uma mensagem de erro. [responses.200.schema.properties.Event.enumValueTitles.agent_message ]A resposta do agente. error : An error message. agent_message : The agent's response.	summary

Exemplos

Resposta de sucesso

JSON formato

{
  "Id": "123e4567-e89b-12d3-a456-xxxxxxxxxxxx",
  "Answer": "rm-xxxx",
  "Metadata": {
    "Code": -1810001,
    "CharCount": 1403,
    "ToolName": "SqlFilter",
    "ToolParams": [
      "[\"--instanceId\", \"rm-*****\", \"--sqlText\", \"select~from~das~where~name~das1\"]"
    ],
    "RequestId": "04930480-9404-50CB-8252-Axxxxxxxx"
  },
  "Event": "summary"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParams	The request parameters are invalid.
500	Timeout	The request processing has failed due to timeout.	Request processing failed due to timeout.
403	NoPermission	You are not authorized to do this action.
404	InstanceNotFound	Requested instance not found.	The corresponding instance ID cannot be found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.