全部产品
Search
文档中心

轻量应用服务器:ListSnapshots - 获取快照

更新时间:Mar 19, 2024

查询一个或多个已创建的快照信息。

接口说明

InstanceIdDiskIdSnapshotIds不是必需的请求参数,但是可以构建过滤器逻辑,参数之间为逻辑与(And)关系。

QPS 限制

本接口的单用户 QPS 限制为 10 次/分钟。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

快照对应的轻量应用服务器所属的地域 ID。

cn-hangzhou
InstanceIdstring

指定的轻量应用服务器的实例 ID。

2ad1ae67295445f598017499dc****
DiskIdstring

指定的磁盘 ID。

d-bp14wq0149cpp2xy****
SnapshotIdsstring

快照 ID。取值可以由多个快照 ID 组成一个 JSON 数组,最多支持 100 个 ID,ID 之间用半角逗号(,)隔开。

["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"]
PageSizeinteger

分页查询时设置的每页行数。最大值:100。

默认值:10。

10
PageNumberinteger

快照列表的页码。

默认值:1。

1
SourceDiskTypestring

快照源云盘的云盘类型。取值范围:

  • System:系统盘。
  • Data:数据盘。
Data
Tagobject []

快照的标签列表。

Keystring

快照的标签键。标签键长度的取值范围:1~64。N 的取值范围:1~20。

TestKey
Valuestring

快照的标签值。标签值长度的取值范围:1~64。N 的取值范围:1~20。

TestValue

返回参数

名称类型描述示例值
object
TotalCountinteger

快照的总条数。

1
RequestIdstring

请求 ID。

20758A-585D-4A41-A9B2-28DA8F4F534F
PageSizeinteger

分页查询时设置的每页行数。

10
PageNumberinteger

快照列表的页码。

1
Snapshotsobject []

快照信息组成的数组。

Statusstring

快照状态。可能值:

  • Progressing:正在创建。
  • Accomplished:创建成功。
  • Failed:创建失败。
Accomplished
CreationTimestring

快照创建时间。时间格式以 ISO8601 为标准,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2021-03-09T07:12:49Z
SourceDiskIdstring

源磁盘 ID。即使快照的源磁盘已经被释放,仍保留该返回值。

d-bp14wq0149cpp2xy****
SnapshotNamestring

快照名称。

test-SnapshotName
Progressstring

快照创建的进度。

100%
Remarkstring

快照备注。

test-Remark
SnapshotIdstring

快照 ID。

s-bp16oazlsold4dks****
SourceDiskTypestring

快照源磁盘的磁盘类型。可能值:

  • System:系统盘。
  • Data:数据盘。
System
RegionIdstring

地域 ID。

cn-hangzhou
InstanceIdstring

轻量应用服务器实例 ID。

注:系统盘快照该字段有值,数据盘快照该值为空。

2ad1ae67295445f598017499dc****
Tagsobject []

快照的标签列表。

Keystring

快照的标签键。

TestKey
Valuestring

快照的标签值。

TestValue
RollbackTimestring

最近一次回滚时间。

2021-03-09T07:12:49Z

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": [
    {
      "Status": "Accomplished",
      "CreationTime": "2021-03-09T07:12:49Z",
      "SourceDiskId": "d-bp14wq0149cpp2xy****",
      "SnapshotName": "test-SnapshotName",
      "Progress": "100%",
      "Remark": "test-Remark",
      "SnapshotId": "s-bp16oazlsold4dks****",
      "SourceDiskType": "System",
      "RegionId": "cn-hangzhou",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "RollbackTime": "2021-03-09T07:12:49Z"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400RegionIdNotMatchHostThe parameter regionId does not match the endpoint host.传入的regionId和请求的地址不匹配。
403InvalidParamThe specified parameter value is invalid.参数非法。
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的实例不存在,请您检查实例ID是否正确。
404InvalidDiskId.NotFoundThe specified DiskId does not exist.指定的磁盘不存在,请您检查磁盘ID是否正确。
500InternalErrorAn error occurred while processing your request.内部错误,请重试。如果多次尝试失败,请提交工单。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:Tag
出参OpenAPI 返回结构发生变更
2023-09-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    删除入参:AcsProduct
2023-09-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:AcsProduct
2023-05-25OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:SourceDiskType
出参OpenAPI 返回结构发生变更