CreateAgent - EventBridge - Alibaba Cloud Documentation Center

Creates a custom agent.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:CreateAgent

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the agent.	my-agent
Description	string	No	The description of the event bus.	连接配置描述信息
Prompt	string	No	You are an IoT data analytics assistant...	我想要她，你这样增加请求头获取用户IP CF-Connecting-IP%3B
Metadata	object	No	The associated metadata.
Attachments	array<object>	No	The array of attached metadata objects.
	object	No	The attached metadata object.
MimeType	string	No	The object type of the attached metadata.	inner-resource/event-table
Arn	string	No	The ARN of the attached metadata object.	acs:eventbridge:cn-hangzhou:12345:eventhouse/system-rocketmq/namespace/rmq-cn-XXX/table/order

Response elements

Element	Type	Description	Example
	object	The response parameters.
Message	string	The error message.	Agent with name 'XXX' already exists for account 12345
RequestId	string	The request ID.	B896B484-XXXXXX-DD0E5C361108
Data	object	The returned data.
AgentArn	string	Agent ARN	acs:eventbridge:{region}:{accountId}:agent/{agentName}
Code	string	The response code. Valid values: Success: The request was successful. Other values: An error occurred. For more information, see Error codes.	Success
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.