GetAgentDataSemantics - EventBridge: Central de Documentação do Alibaba Cloud

Obtém a semântica de dados atualmente em vigor de um agente.

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

eventbridge:GetAgentDataSemantics

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AgentName	string	Sim	O nome do agente.	bakehouse_agent

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Message	string	A mensagem de resposta. Se a solicitação falhar, uma mensagem de erro será retornada.	Data semantics not found.
RequestId	string	O identificador exclusivo gerado pelo Alibaba Cloud para a solicitação.	5DAF96FB-A4DF-548C-B8A1-F2A8D2F4****
Data	object	Os detalhes da versão atualmente em vigor da semântica de dados. Se a geração estiver em execução, falhar ou for concluída, mas não salva, apenas a versão oficial será retornada, e o snapshot temporário não será retornado.
VersionNo	integer	O número da versão atualmente em vigor.	3
Metrics	array	O conhecimento de expressão SQL. Há suporte para até 100 itens.
	AgentDataSemanticsMetric	O item de conhecimento de expressão SQL.
Joins	array	O conhecimento de junção de dados. Há suporte para até 100 itens.
	AgentDataSemanticsJoin	O item de conhecimento de junção de dados.
Examples	array	O conhecimento de exemplo SQL. Há suporte para até 50 itens.
	AgentDataSemanticsExample	O item de conhecimento de exemplo SQL.
Text	AgentDataSemanticsText	O conhecimento de texto em formato Markdown.
Code	string	O código de resposta.	Success
Success	boolean	Indica se a solicitação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "Data semantics not found",
  "RequestId": "5DAF96FB-A4DF-548C-B8A1-F2A8D2F4****",
  "Data": {
    "VersionNo": 3,
    "Metrics": [
      {
        "Name": "TotalSales",
        "Type": "measure",
        "SQLExpression": "SUM(sales_transactions.totalPrice)",
        "Synonyms": [
          "Sales"
        ],
        "Description": "Use totalPrice para calcular as vendas totais para comparação de desempenho de vendas"
      }
    ],
    "Joins": [
      {
        "LeftTable": "samples.bakehouse.sales_transactions",
        "RightTable": "samples.bakehouse.customers",
        "Condition": {
          "Mode": "form",
          "LeftColumn": "customerID",
          "RightColumn": "customerID",
          "SQLExpression": "sales_transactions.customerID = customers.customerID"
        },
        "RelationshipType": "many_to_one",
        "Description": "Use esta junção ao analisar atributos de clientes associados a transações de vendas"
      }
    ],
    "Examples": [
      {
        "Name": "Clientes de alto valor com vendas semanais superiores a 150",
        "SQLExpression": "SELECT customerID FROM sales_transactions",
        "Parameters": [
          {
            "Name": "start_date",
            "DataType": "date",
            "Value": "2025-01-01",
            "Description": "O limite inferior da data da transação"
          }
        ],
        "Description": "Use este exemplo quando um usuário perguntar sobre clientes de alto valor com base em estatísticas semanais"
      }
    ],
    "Text": {
      "Content": "## Descrição dos dados"
    }
  },
  "Code": "Success",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
500	InternalError	Internal Server Error
403	ServiceNotEnable	Service not enable
403	EventHouseServiceNotEnable	EventHouse service not enable
404	AgentNotFound	Agent not found.
404	DataSemanticsNotFound	Data semantics not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.