文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心

查询Agent实例列表

最近更新时间：2025-09-11 15:38:27

我的收藏

本页目录：

1. 接口描述

接口请求域名： tdai.tencentcloudapi.com 。

本接口（DescribeAgentInstances）用于查询智能体实例列表，通常在用户查询所购买的所有智能体列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeAgentInstances。
Version 是 String 公共参数，本接口取值：2025-07-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
Offset 否 Integer 查询开始位置
示例值：10
Limit 否 Integer 列表查询数量
示例值：10
InstanceId 否 String 实例ID，为空时查询所有，如果填写则会根据InstanceId筛选
示例值：agentins-efbt5y3h
InstanceName 否 String 实例名，为空时查询所有，如果填写则会根据InstanceName筛选
示例值：风险SQL治理Agent实例
AgentId 否 String 智能体ID，为空时查询所有，如果填写则会根据AgentId筛选
示例值：agt-xpcn2t3e
AgentName 否 String 智能体名称，为空时查询所有，如果填写则会根据AgentName筛选
示例值：风险SQL治理Agent智能体
AgentInternalName 否 String 智能体类型，为空时查询所有，如果填写则会根据AgentName筛选
示例值：aid
Status 否 String 智能体实例状态，为空时查询所有，如果填写则会根据Status筛选
示例值：running
TagFilter.N 否 Array of TagFilter 标签过滤信息

3. 输出参数

参数名称 类型 描述
TotalCount Integer 查询结果总数量
示例值：100
Items Array of AgentInstance 智能体实例列表
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询智能体实例列表

输入示例

POST / HTTP/1.1
Host: tdai.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentInstances
<公共请求参数>

{
    "InstanceId": "agentins-efbt5y3h",
    "InstanceName": "agentins-efbt5y3h",
    "AgentId": "agt-xpcn2t3e",
    "AgentName": "sqlAgent测试",
    "AgentInternalName": "aid",
    "Status": "running",
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "Items": [
            {
                "InstanceId": "agentins-efbt5y3h",
                "InstanceName": "agentins-efbt5y3h",
                "AgentId": "agt-xpcn2t3e",
                "AgentName": "sqlAgent测试",
                "AgentInternalName": "aid",
                "AgentType": "chat",
                "AgentVersion": "v1.0.0",
                "Status": "running",
                "Parameters": [
                    {
                        "Key": "git_branch",
                        "Value": "master",
                        "ValueType": "string"
                    }
                ],
                "CreateTime": "2025-07-15 16:06:10",
                "UpdateTime": "2025-07-15 16:06:10"
            }
        ],
        "RequestId": "a070f1a2-7538-5318-c843-6b47607aa78c",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
OperationDenied 操作被拒绝。
ResourceNotFound 资源不存在。
中国站
目录