Agent 沙箱服务查询沙箱实例列表

1. 接口描述

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

查询沙箱实例列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSandboxInstanceList。
Version	是	String	公共参数，本接口取值：2025-09-20。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceIds.N	否	Array of String	沙箱实例ID列表，指定要查询的实例。如果为空则查询所有实例。最大支持100个ID 示例值：["c8f390ac57ce454db5cefff77fc8174a"]
ToolId	否	String	沙箱工具ID，指定时查询该沙箱模板下的实例，为空则查询所有沙箱模板的实例示例值：sdt-ee4ywozw
Offset	否	Integer	偏移量，默认为0 示例值：10
Limit	否	Integer	返回数量，默认为20，最大值为100 示例值：20
Filters.N	否	Array of Filter	过滤条件

3. 输出参数

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

4. 示例

示例1 查询沙箱实例列表

输入示例

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

{
    "ToolId": "sdt-ee4ywozw",
    "Offset": 0,
    "Limit": 20,
    "Filters": [
        {
            "Name": "Status",
            "Values": [
                "RUNNING"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "InstanceSet": [
            {
                "InstanceId": "12345678123412341234123456789abc",
                "ToolId": "sdt-ee4ywozw",
                "ToolName": "my-browser-tool",
                "Status": "RUNNING",
                "TimeoutSeconds": 600,
                "ExpiresAt": "2024-01-01T10:30:00Z",
                "CreateTime": "2024-01-01T10:00:00Z",
                "UpdateTime": "2024-01-01T10:00:00Z"
            }
        ],
        "TotalCount": 1,
        "RequestId": "12345678123412341234123456789012"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue.InstanceIds	InstanceIds 参数格式错误或 ID 列表超过最大数量限制
MissingParameter	缺少参数错误。