All Products
Search
Document Center

ApsaraDB RDS:ListCustomAgentTools

Last Updated:Mar 05, 2026

Queries the custom agent tools of the 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:ListCustomAgentToolsnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object

The information about the parameter.

RequestIdstring

The request ID.

32DEFB4A-861F-5D1D-ADD5-918E4FD7****
Dataarray<object>

The returned data.

dataobject

The returned result.

Namestring

The tool name.

describe_db_instances
Zhstring

The description in Simplified Chinese.

Enstring

The description in English.

Queries RDS instances.
Tcstring

The description in Traditional Chinese.

Jastring

The description in Japanese.

Typestring

The read/write type of the tool.

get

Examples

Sample success responses

JSONformat

{
  "RequestId": "32DEFB4A-861F-5D1D-ADD5-918E4FD7****",
  "Data": [
    {
      "Name": "describe_db_instances",
      "Zh": "",
      "En": "Queries RDS instances.",
      "Tc": "",
      "Ja": "",
      "Type": "get"
    }
  ]
}

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
2025-12-04The Error code has changed. The request parameters of the API has changedView Change Details
2025-12-03Add OperationView Change Details