UpdateAgent-阿里云帮助中心

Update 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:UpdateAgent

get

*全部资源

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	Agent name	my-agent
Description	string	No	Event source description details	Filter rules for MNS
Prompt	string	No	You are an IoT data analysis assistant...	Switzerland freezes Maduro's assets in Switzerland
Metadata	object	No	Associated metadata
Attachments	array<object>	No	Bound metadata objects
	object	No	Array of bound metadata objects
MimeType	string	No	Type of the bound metadata object	inner-resource/event-table
Arn	string	No	ARN of the bound metadata object	acs:eventbridge:cn-hangzhou:12345:eventhouse/system-rocketmq/namespace/rmq-cn-xxx/table/order
ClientToken	string	No	The request token generated by the user, used to ensure the idempotency of the request. Note: This parameter value is generated by the client and must be unique across different requests, with a maximum length of 64 ASCII characters.	TF-CreateRule-1652253755-aa33f762-7e99-4aee-bd27-d3370afa5625

Response elements

Element	Type	Description	Example
	object	Return value
Message	string	Error message.	InvalidArgument
RequestId	string	Request ID.	382E6272-XXXXX-A8AF0BFAC1A5
Data	object	Whether the operation was successful.
AgentArn	string	Agent ARN	acs:eventbridge:{region}:{accountId}:agent/{agentName}
Code	string	API return code: Success: Indicates success. Others: Indicates an error code. For error code details, see Error Codes.	Success
Success	boolean	Returns true if the operation is successful.	true

Examples

Success response

JSON format

{
  "Message": "InvalidArgument",
  "RequestId": "382E6272-XXXXX-A8AF0BFAC1A5",
  "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.