1. 接口描述
接口请求域名: lighthouse.tencentcloudapi.com 。
本接口(DescribeSnapshots)用于查询快照的详细信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSnapshots。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SnapshotIds.N | 否 | Array of String | 要查询快照的 ID 列表。每次请求批量快照的上限为 100。 可通过 DescribeSnapshots 接口返回值中的 SnapshotId 获取。 参数不支持同时指定 SnapshotIds 和 Filters。 示例值:["lhsnap-nv6aqcv6"] |
Filters.N | 否 | Array of Filter | 过滤器列表。 类型:String 必选:否 可通过 DescribeSnapshots 接口返回值中的 SnapshotId 获取。 类型:String 必选:否 可通过 DescribeDisks 接口返回值中的 DiskId 获取。 类型:String 必选:否 可通过 DescribeSnapshots 接口返回值中的 SnapshotName 获取。 类型:String 必选:否 可通过 DescribeInstances 接口返回值中的 InstanceId 获取。 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 5。参数不支持同时指定 SnapshotIds 和 Filters。 |
Offset | 否 | Integer | 偏移量,默认为 0。 示例值:0 |
Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100。 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 快照的数量。 示例值:1 |
SnapshotSet | Array of Snapshot | 快照的详情列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看快照列表
输入示例
https://lighthouse.tencentcloudapi.com/?Action=DescribeSnapshots
&Filters.0.Name=disk-id
&Filters.0.Values.0=lhdisk-f71kc5bh
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 1,
"SnapshotSet": [
{
"SnapshotId": "lhsnap-nv6aqcv6",
"DiskUsage": "SYSTEM_DISK",
"DiskId": "lhdisk-f71kc5bh",
"DiskSize": 50,
"SnapshotName": "lighthouse-test1-0903145122",
"SnapshotState": "NORMAL",
"Percent": "100",
"LatestOperation": "RollbackInstanceSnapshot",
"LatestOperationState": "SUCCESS",
"LatestOperationRequestId": "96aee6e3-172c-4f0f-be7c-fc46b9865763",
"CreatedTime": "2020-09-03T06:51:23Z"
}
],
"RequestId": "95aacc96-b271-4d8b-bf83-019647952af9"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InvalidParameter.FilterValueLimitExceeded | 参数非法,Filter 参数中的 Values 取值数量超过允许的最大数量。 |
InvalidParameter.InvalidFilter | 参数非法,Filter 参数非法。 |
InvalidParameter.InvalidFilterInvalidKey | 参数非法,Filter 参数中的 Name 取值非法。 |
InvalidParameter.InvalidFilterInvalidNameNotStr | 参数非法,Filter 参数中的 Name 取值不是字符串。 |
InvalidParameter.InvalidFilterInvalidValuesNotList | 参数非法,Filter 参数中的 Values 不是列表。 |
InvalidParameter.InvalidFilterNotDict | 参数非法,Filter 参数不是字典。 |
InvalidParameter.InvalidFilterNotSupportedName | 参数非法,Filter 参数中有不支持的 Name。 |
InvalidParameter.ParameterConflict | 参数非法,参数冲突。 |
InvalidParameterValue.InstanceIdMalformed | 参数值非法,实例 ID 格式非法。 |
InvalidParameterValue.InvalidDiskIdMalformed | 参数值非法,磁盘 ID 格式非法。 |
InvalidParameterValue.LimitExceeded | 参数值非法,参数值的数量超过最大限制。 |
InvalidParameterValue.Negative | 参数值非法,不能为负值。 |
InvalidParameterValue.OutOfRange | 参数值非法,不在合法范围内。 |
InvalidParameterValue.SnapshotIdMalformed | 参数值非法,快照 ID 格式非法。 |
InvalidParameterValue.SnapshotNameTooLong | 参数值非法,快照名称超过允许的最大长度。 |
UnauthorizedOperation.NoPermission | 无权限。 |