ListCustomAgents - 分页列出 自定义 Agent

更新时间:
复制为 MD 格式

分页列出 自定义 Agent

接口说明

请求说明

  • 搜索关键词:通过 Q 参数可以按 Agent 名称进行模糊匹配。

  • 可见性级别过滤:使用 Visibility 参数可以根据可见性级别(如 TENANTPROJECTUSER)来过滤结果。

  • 分页信息:通过 MaxResultsNextToken 参数实现分页查询,其中 NextToken 用于获取下一页的数据。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

MaxResults

integer

本次请求返回的最大条数。

20

NextToken

string

分页 Token。首次查询不传;后续查询传上一次返回的 NextToken 获取下一页。

12345

Q

string

搜索关键词,按 Agent 名称模糊匹配。

analysis

Visibility

array

按可见性级别过滤,可传多个。

-

string

可见性

TENANT

返回参数

名称

类型

描述

示例值

object

返回参数

RequestId

string

请求 ID。

824F80BA-1778-5D8A-BAFF-668A4D9C4CC7

PagingInfo

object

分页信息。

TotalCount

integer

符合条件的总条数。

100

MaxResults

integer

本次返回的最大条数。

20

NextToken

string

下一页 Token,为空表示已到末页。

5

Agents

array<object>

自定义 Agent 列表。

object

Agent 列表

Name

string

Agent 名称。

my-agent

DisplayName

string

展示名称。

我的助手

Description

string

描述。

数据分析助手

CreatorId

string

创建者 ID。

123456

ModifierId

string

最近修改者 ID。

123456

Visibility

string

可见性级别。

TENANT

GmtCreateTime

string

创建时间(毫秒时间戳)。

1780555634000

GmtModifiedTime

string

最近修改时间(毫秒时间戳)。

1780555634000

示例

正常返回示例

JSON格式

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "PagingInfo": {
    "TotalCount": 100,
    "MaxResults": 20,
    "NextToken": "5",
    "Agents": [
      {
        "Name": "my-agent",
        "DisplayName": "我的助手",
        "Description": "数据分析助手",
        "CreatorId": "123456",
        "ModifierId": "123456",
        "Visibility": "TENANT",
        "GmtCreateTime": "1780555634000",
        "GmtModifiedTime": "1780555634000"
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情