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

Cria um agente personalizado.

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

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Name	string	Sim	O nome do agente.	my-agent
Description	string	Não	A descrição do barramento de eventos.	Connection configuration description
Prompt	string	Não	Você é um assistente de análise de dados de IoT...	I want her, you add the request header to obtain the user IP CF-Connecting-IP%3B
Metadata	object	Não	Os metadados associados.
Attachments	array<object>	Não	A matriz de objetos de metadados anexados.
	object	Não	O objeto de metadados anexado.
MimeType	string	Não	O tipo de objeto dos metadados anexados.	inner-resource/event-table
Arn	string	Não	O ARN do objeto de metadados anexado.	acs:eventbridge:cn-hangzhou:12345:eventhouse/system-rocketmq/namespace/rmq-cn-XXX/table/order

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado da resposta.
Message	string	A mensagem de erro.	Agent with name 'XXX' already exists for account 12345
RequestId	string	O ID da solicitação.	B896B484-XXXXXX-DD0E5C361108
Data	object	Os dados retornados.
AgentArn	string	O ARN do agente.	acs:eventbridge:{region}:{accountId}:agent/{agentName}
Code	string	O código de resposta da API. Valores válidos: Success: indica sucesso. Outros valores: indica um código de erro. Para mais informações, consulte Códigos de erro.	Success
Success	boolean	Especifica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "Agent with name 'XXX' already exists for account 12345",
  "RequestId": "B896B484-XXXXXX-DD0E5C361108",
  "Data": {
    "AgentArn": "acs:eventbridge:{region}:{accountId}:agent/{agentName} "
  },
  "Code": "Success",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	ServiceNotEnable	Service not enable

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.