All Products
Search
Document Center

ApsaraDB RDS:CreateCustomAgent

Last Updated:Mar 05, 2026

Creates a dedicated agent.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rdsai:CreateCustomAgentcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringNo

The operation that you want to perform. Set the value to CreateCustomAgent.

SystemPromptstringYes

The name of the dedicated agent.

EnableToolsbooleanNo

The system prompts.

true
ToolsarrayNo

Specifies whether to enable tools.

stringNo
describe_db_instances

Response parameters

ParameterTypeDescriptionExample
object

The information about the parameters.

RequestIdstring

The request ID.

FE9C65D7-930F-57A5-A207-8C396329****
Namestring

The name of the agent.

CreatedAtstring

The creation time of the agent.

2020-11-27 16:01:28
SystemPromptstring

The system prompts.

EnableToolsboolean

Indicates whether tools are enabled.

true
Toolsarray

The information about the tool.

toolsstring

The details of the tool.

describe_db_instances
Idstring

AgentId

d1b7d639-f34e-44c7-8231-987da14d****

Examples

Sample success responses

JSONformat

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "Name": "",
  "CreatedAt": "2020-11-27 16:01:28",
  "SystemPrompt": "",
  "EnableTools": true,
  "Tools": [
    "describe_db_instances"
  ],
  "Id": "d1b7d639-f34e-44c7-8231-987da14d****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe provided parameter is invalid.Invalid parameter.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2026-02-26The Error code has changedView Change Details
2026-02-02The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2025-12-04The Error code has changed. The request parameters of the API has changedView Change Details
2025-12-03Add OperationView Change Details