GetCustomAgent-阿里云帮助中心

Retrieves the details of a specified 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

rdsai:GetCustomAgent

get

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
CustomAgentId	string	No	The custom agent ID.	ebe44453-3b41-4c74-94d1-01d088d7****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329****
Name	string	The name of the custom agent.	查询实例列表Agent
SystemPrompt	string	The system prompt.	我是您用来查询实例列表的专属Agent
EnableTools	boolean	Indicates whether tools are enabled.	true
CreatedAt	string	The creation time.	2025-06-04T02:25:43Z
UpdatedAt	string	The update time.	2020-11-27 16:02:28
Tools	array	A list of tools available to the agent.
	string	A string containing one or more tool names.	[describe_db_instances,describe_db_instance_attribute]
Id	string	The numeric ID of the custom agent.	17053
Skills	array<object>
	object
Id	string
Name	string
Description	string
SkillType	string

Examples

Success response

JSON format

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "Name": "查询实例列表Agent",
  "SystemPrompt": "我是您用来查询实例列表的专属Agent",
  "EnableTools": true,
  "CreatedAt": "2025-06-04T02:25:43Z",
  "UpdatedAt": "2020-11-27 16:02:28",
  "Tools": [
    "[describe_db_instances,describe_db_instance_attribute]"
  ],
  "Id": "17053",
  "Skills": [
    {
      "Id": "",
      "Name": "",
      "Description": "",
      "SkillType": ""
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The provided parameter is invalid.	Invalid parameter.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.