GetDataAgent - Simple Log Service: Central de Documentação do Alibaba Cloud

Descrição da operação

Retorna a configuração completa de um único DataAgent por nome, incluindo a função RAM assumida, os modelos de contexto associados e o prompt do sistema. Retorna um erro 404 se o DataAgent não existir.

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

log:GetDataAgent

get

*DataAgent

acs:log:{#regionId}:{#accountId}:dataagent/{#name}

Nenhuma

Sintaxe da solicitação

GET /dataagents/{name} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
name	string	Sim	O nome do DataAgent. O DataAgent deve existir na conta atual. O nome pode conter apenas letras maiúsculas e minúsculas, dígitos, sublinhados (_) e hifens (-), e deve ter de 4 a 128 caracteres de comprimento.	order-analysis-agent

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta. Retorna a configuração completa do DataAgent.
contextModels	array	A lista de nomes dos modelos de contexto associados ao DataAgent.
	string	O nome de um modelo de contexto.	order-context
createdAt	string	A hora de criação no formato ISO 8601 no fuso horário UTC, com precisão de segundos.	2026-08-14T10:00:03Z
description	string	A descrição do DataAgent. Uma string vazia é retornada se não estiver definida.	Analyzes order and revenue-related logs and generates daily summary reports
displayName	string	O nome de exibição. Se não estiver definido, uma string vazia "" é retornada em vez de usar o name como fallback. Para fins de exibição, use displayName \|\| name como fallback.	Order Analysis Assistant
name	string	O nome do DataAgent.	order-analysis-agent
roleArn	string	O ARN da função RAM assumida pelo DataAgent.	acs:ram::123456789012****:role/sls-dataagent-role
systemPrompt	string	O prompt do sistema do DataAgent. Uma string vazia é retornada se não estiver definido.	You are a data analysis assistant for the order domain. Only answer questions related to orders and revenue. If you are unsure, explain the reason instead of guessing
updatedAt	string	A hora da última atualização, no mesmo formato de createdAt.	2026-08-15T09:20:31Z
userId	string	O ID da conta Alibaba Cloud à qual o DataAgent pertence.	123456789012****

Exemplos

Resposta de sucesso

JSON formato

{
  "contextModels": [
    "order-context"
  ],
  "createdAt": "2026-08-14T10:00:03Z",
  "description": "Analyzes order and revenue-related logs and generates daily summary reports",
  "displayName": "Order Analysis Assistant",
  "name": "order-analysis-agent",
  "roleArn": "acs:ram::123456789012****:role/sls-dataagent-role",
  "systemPrompt": "You are a data analysis assistant for the order domain. Only answer questions related to orders and revenue. If you are unsure, explain the reason instead of guessing",
  "updatedAt": "2026-08-15T09:20:31Z",
  "userId": "123456789012****"
}

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.