ListCustomAgent - 查询专属Agent列表

该接口用于查询用户创建的专属Agent列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rdsai:ListCustomAgentnone
*全部资源
*

请求参数

名称类型必填描述示例值
PageNumberlong

页码。

1
PageSizelong

每页记录数。

10

返回参数

名称类型描述示例值
object

对象。

TotalCountinteger

TotalCount 本次请求条件下的数据总量,此参数为可选参数,默认可不返回。

20
RequestIdstring

请求 Id。

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

页码。

1
Dataarray<object>

返回数据对象。

dataobject

结果详情。

Namestring

专属 Agent 名称。

日志分析Agent
SystemPromptstring

系统提示。

我是您用来查询实例列表的专属Agent。
EnableToolsboolean

是否启用工具。

true
Toolsarray

工具信息。

toolsstring

工具名称。

describe_db_instances
CreatedAtstring

创建时间。

2020-11-27 16:01:28
UpdatedAtstring

更新时间。

2020-11-27 16:02:28
Idstring

AgentId。

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

每页记录数。

10

示例

正常返回示例

JSON格式

{
  "TotalCount": 20,
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "PageNumber": 1,
  "Data": [
    {
      "Name": "日志分析Agent",
      "SystemPrompt": "我是您用来查询实例列表的专属Agent。\n",
      "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
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-12-03新增 OpenAPI查看变更详情