1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
查询沙箱快照
该接口属于 Runtime Snapshot API ,当前为预览版本(Beta)。接口后续可能发生不兼容变更或被弃用,不保证向后兼容。请关注后续版本及变更说明,并根据需要调整调用代码。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeSandboxSnapshotList。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| SnapshotIds.N | 否 | Array of String | 待查询的沙箱快照 ID 列表 示例值:["snapshot-019fd144-889b-8013-9fa3-c51254f347f8"] |
| Filters.N | 否 | Array of Filter | 过滤条件 |
| Offset | 否 | Integer | 偏移量,与 NextToken 参数互斥 示例值:10 |
| Limit | 否 | Integer | 返回数量上限 示例值:10 |
| NextToken | 否 | String | 分页偏移 token,与 Offset 参数互斥 示例值:eyJjcmVhdGVkQXQiOiIyMDI2LTA4LTA1VDA4OjA1OjI2LjU3MloiLCJzbmFwc2hvdElkIjoic25hcHNob3QtMDE5ZmQwZjQtYjdhNi04MDEzLTgxZDItM2NjOTZlOTJmMjliIiwiZmlsdGVySGFzaCI6IjE2ODg2NDg4MmUwYTNhMzAxNjg3NzMwYjZmNzhmNWM4NzA1YTc1NGUxMDA1N2JjOWUyYWNkNzg1OTVjZDQ2MTIifQ |
| MaxResults | 否 | Integer | 每次调用返回的最大结果数。如果查询返回的时候有NextToken返回,您可以使用NextToken值获取更多页结果, 当NextToke返回空或者返回的结果数量小于MaxResults时,表示没有更多数据了。允许的最大页面大小为 100。 示例值:100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SnapshotSet | Array of SandboxSnapshot | 查询到的沙箱快照列表 |
| TotalCount | Integer | 查询到的沙箱快照数量 示例值:3 |
| NextToken | String | 分页偏移 token,可用于下一次查询 示例值:eyJjcmVhdGVkQXQiOiIyMDI2LTA4LTA1VDA3OjA2OjAzLjY4WiIsInNuYXBzaG90SWQiOiJzbmFwc2hvdC0wMTlmZDBiZS01YTFlLTgwMTMtYjcyYS1mZGZjZWFkMWFmN2UiLCJmaWx0ZXJIYXNoIjoiMTdmYTU3ZGRhNjQ0NzU2OTUxNTZlMjA3YzY5NjAyZTYyOWUwYjZlN2IzMzdjNDVmMWU3NDZhOGYzYWY0MTJlZCJ9 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询沙箱快照列表
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSandboxSnapshotList
<公共请求参数>
{}
输出示例
{
"Response": {
"SnapshotSet": [
{
"CreateTime": "2026-08-06T04:59:06.164Z",
"MemoryIncluded": false,
"SnapshotId": "snapshot-019fd570-7a32-8013-8e9b-800f8082a260",
"SourceInstanceId": "ap35sxr52gtvkutvzfbjskfw45vsh3cn2atrkglf",
"Status": "ACTIVE",
"StatusReason": "",
"Tags": [],
"UpdateTime": "2026-08-06T04:59:06.304Z"
}
],
"TotalCount": 3,
"RequestId": "f360264d-452f-4fe7-a71c-02e43f0c32a8"
}
}
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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。