赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 轻量应用服务器
  4. 开发参考
  5. API参考
  6. API目录
  7. 快照
  8. ListSnapshots - 获取快照

ListSnapshots - 获取快照

  • 快照
  • 发布于 2025-04-16
  • 0 次阅读
文档编辑
文档编辑

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
swas-open:ListSnapshotsget
*Snapshot
acs:swas-open:{#regionId}:{#accountId}:snapshot/*
*Snapshot
acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}
    无
无

请求参数

名称类型必填描述示例值
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
Tagarray<object>否

快照的标签列表。

object否

标签。

Keystring否

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

TestKey
Valuestring否

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

TestValue
ResourceGroupIdstring否

指定的资源组 ID。

rg-aek2bti7cf7****

返回参数

名称类型描述示例值
object
TotalCountinteger

快照的总条数。

1
RequestIdstring

请求 ID。

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

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

10
PageNumberinteger

快照列表的页码。

1
Snapshotsarray<object>

快照信息组成的数组。

Snapshotobject
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****
Tagsarray<object>

快照的标签列表。

tagobject

标签。

Keystring

快照的标签键。

TestKey
Valuestring

快照的标签值。

TestValue
RollbackTimestring

最近一次回滚时间。

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

快照所属的资源组 ID。

rg-aek2bti7cf7****

示例

正常返回示例

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",
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

错误码

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-05-29OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-02-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-09-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-09-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-05-25OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
相关文章

CreateSnapshot - 创建快照 2025-04-16 17:06

为指定的磁盘创建快照。 接口说明

ListSnapshots - 获取快照 2025-04-16 17:06

查询一个或多个已创建的快照信息。 接口说明

UpdateSnapshotAttribute - 修改快照备注信息 2025-04-16 17:06

修改轻量应用服务器指定快照的备注信息。

DeleteSnapshot - 删除快照 2025-04-16 17:06

删除轻量应用服务器指定的快照。 接口说明

DeleteSnapshots - 批量删除快照 2025-04-16 17:06

删除一个或多个已创建的快照。

目录
Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
京ICP备14022346号-15
gongan beian 京公网安备11010802041014号