帮你快速理解、总结文档立即下载
文档中心>API 中心>Agent Runtime>Deployment 管理相关接口>查询 Deployment 列表

查询 Deployment 列表

最近更新时间：2026-08-25 01:09:58
我的收藏

本页目录：

1. 接口描述

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

查询 Deployment 列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDeploymentList。
Version 是 String 公共参数，本接口取值：2025-09-20。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-chongqing, ap-hongkong, ap-shanghai 。
Offset 否 Integer

分页偏移量，默认 0，必须大于等于 0。


示例值：0
Limit 否 Integer

分页返回数量，默认 20，范围 1..200。


示例值：20
Filters.N 否 Array of Filter

查询过滤条件。

Filter.Name 枚举值：

  • deployment-id：按 DeploymentId 精确匹配
  • deployment-name：按 DeploymentName 精确匹配
  • deployment-name-like：按 DeploymentName 进行普通文本包含匹配，%、_ 等字符没有通配语义
  • tool-id：按 ToolId 精确匹配
  • status：按 Deployment 状态精确匹配，支持 ACTIVE、DELETING、DELETE_FAILED

所有匹配均区分大小写。不同 Filter 之间为 AND，同一 Filter 的 Values 之间为 OR。

3. 输出参数

参数名称 类型 描述
DeploymentSet Array of Deployment

当前页完整 Deployment；无匹配时为空数组。
TotalCount Integer

应用 Filters 后、分页前的结果总数。


示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 Deployment 列表

输入示例

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

{
    "Offset": 0,
    "Limit": 20,
    "Filters": [
        {
            "Name": "deployment-name",
            "Values": [
                "workspace-service"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DeploymentSet": [
            {
                "DeploymentId": "dpl-a1b2c3d4",
                "DeploymentName": "workspace-service",
                "ToolId": "sdt-a1b2c3d4",
                "ScalingConfiguration": {
                    "MinInstanceCount": 0,
                    "MaxInstanceCount": 10,
                    "MaxInstanceRequestConcurrency": 100
                },
                "LifecycleConfiguration": {
                    "IdleTimeoutSeconds": 300,
                    "IdleAction": "PAUSE"
                },
                "AffinityConfiguration": {
                    "Mode": "EXCLUSIVE",
                    "HeaderName": "X-Tencent-Agr-Affinity-Id"
                },
                "Status": "ACTIVE",
                "CreatedTime": "2026-08-06T08:00:00Z",
                "UpdatedTime": "2026-08-06T08:00:00Z"
            }
        ],
        "TotalCount": 1,
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.Filters InvalidParameter.Filters
InvalidParameter.Limit InvalidParameter.Limit
InvalidParameter.Offset InvalidParameter.Offset
中国站