All Products
Search
Document Center

ApsaraDB RDS:ListCustomAgent

Last Updated:Mar 05, 2026

Queries the dedicated agents created by a user.

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:ListCustomAgentnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberlongNo

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

1
PageSizelongNo

The page number of the returned page.

10

Response parameters

ParameterTypeDescriptionExample
object

The information about the parameters.

TotalCountinteger

The total number of entries returned. By default, this parameter is not returned.

20
RequestIdstring

The request ID.

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

The page number of the returned page.

1
Dataarray<object>

The returned data.

dataobject

The details of the result.

Namestring

The name of the dedicated agent.

SystemPromptstring

The system prompts.

EnableToolsboolean

Indicates whether tools are enabled.

true
Toolsarray

The information about the tool.

toolsstring

The tool name.

describe_db_instances
CreatedAtstring

The creation time of the agent.

2020-11-27 16:01:28
UpdatedAtstring

The modification time of the agent.

2020-11-27 16:02:28
Idstring

The ID of the agent.

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

The number of entries returned on each page.

10

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

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