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

查询沙箱实例列表

最近更新时间：2026-09-14 01:09:23
我的收藏

本页目录：

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

过滤条件
MaxResults 否 Integer

每次调用返回的最大结果数。如果查询返回的时候有NextToken返回，您可以使用NextToken值获取更多页结果， 当NextToke返回空或者返回的结果数量小于MaxResults时，表示没有更多数据了。允许的最大页面大小为 100。


示例值：20
NextToken 否 String

如果NextToken返回非空字符串 ，表示还有更多可用结果。 NextToken是每个页面唯一的分页令牌。使用返回的令牌再次调用以检索下一页。需要保持所有其他参数不变。每个分页令牌在 24 小时后过期。


示例值：eyJ2IjoxLCJjIjp7Li4ufX0
NeedTotalCount 否 Boolean

是否返回符合当前查询条件的沙箱实例总数，仅在使用 MaxResults/NextToken 分页时生效。设置为 true 时，首次请求（NextToken 为空）计算并返回精确的 TotalCount；后续使用 NextToken 翻页时返回首次请求计算的 TotalCount，分页期间该值保持不变。重新发起不带 NextToken 的请求时将重新计算。使用 NextToken 翻页时，本参数及其他查询参数必须与首次请求保持一致。默认值为 false，此时 TotalCount 返回 0。


示例值：false

3. 输出参数

参数名称 类型 描述
InstanceSet Array of SandboxInstance

沙箱实例列表
TotalCount Integer

符合条件的实例总数


示例值：100
NextToken String

如果NextToken返回非空字符串 ，表示还有更多可用结果。 NextToken是每个页面唯一的分页令牌。使用返回的令牌再次调用以检索下一页。需要保持所有其他参数不变。每个分页令牌在 24 小时后过期。


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

4. 示例

示例1 查询实例声明的访问策略

返回实例自己声明的访问策略，不包含 Tool 与 Instance 合并后的内部结果。

输入示例

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

{
    "InstanceIds": [
        "ins-policy123"
    ]
}

输出示例

{
    "Response": {
        "InstanceSet": [
            {
                "InstanceId": "ins-policy123",
                "ToolId": "sdt-policy123",
                "ToolName": "browser-policy-sandbox",
                "Status": "RUNNING"
            }
        ],
        "TotalCount": 1,
        "RequestId": "req-describe-instance-policy-example"
    }
}

示例2 查询沙箱实例列表

输入示例

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。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.Unknown 未分类内部错误
InvalidParameter 参数错误。
InvalidParameterValue.InstanceIds InstanceIds 参数格式错误或 ID 列表超过最大数量限制
InvalidParameterValue.OffsetTooLarge Offset must be at most 10000
MissingParameter 缺少参数错误。
中国站