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

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

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
swas-open:ListSnapshots	get	Snapshot acs:swas-open:{#regionId}:{#accountId}:snapshot/* Snapshot acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	快照对应的轻量应用服务器所属的地域 ID。	cn-hangzhou
InstanceId	string	否	指定的轻量应用服务器的实例 ID。	2ad1ae67295445f598017499dc****
DiskId	string	否	指定的磁盘 ID。	d-bp14wq0149cpp2xy****
SnapshotIds	string	否	快照 ID。取值可以由多个快照 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。	["s-bp16oazlsold4dks**", "s-bp16oazlsold4abc**"]
PageSize	integer	否	分页查询时设置的每页行数。最大值：100。默认值：10。	10
PageNumber	integer	否	快照列表的页码。默认值：1。	1
SourceDiskType	string	否	快照源云盘的云盘类型。取值范围： System：系统盘。 Data：数据盘。	Data
Tag	array<object>	否	快照的标签列表。
	object	否	标签。
Key	string	否	快照的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。	TestKey
Value	string	否	快照的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。	TestValue
ResourceGroupId	string	否	指定的资源组 ID。	rg-aek2bti7cf7****

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	快照的总条数。	1
RequestId	string	请求 ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	分页查询时设置的每页行数。	10
PageNumber	integer	快照列表的页码。	1
Snapshots	array<object>	快照信息组成的数组。
Snapshot	object
Status	string	快照状态。可能值： Progressing：正在创建。 Accomplished：创建成功。 Failed：创建失败。	Accomplished
CreationTime	string	快照创建时间。时间格式以 ISO8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2021-03-09T07:12:49Z
SourceDiskId	string	源磁盘 ID。即使快照的源磁盘已经被释放，仍保留该返回值。	d-bp14wq0149cpp2xy****
SnapshotName	string	快照名称。	test-SnapshotName
Progress	string	快照创建的进度。	100%
Remark	string	快照备注。	test-Remark
SnapshotId	string	快照 ID。	s-bp16oazlsold4dks****
SourceDiskType	string	快照源磁盘的磁盘类型。可能值： System：系统盘。 Data：数据盘。	System
RegionId	string	地域 ID。	cn-hangzhou
InstanceId	string	轻量应用服务器实例 ID。注：系统盘快照该字段有值，数据盘快照该值为空。	2ad1ae67295445f598017499dc****
Tags	array<object>	快照的标签列表。
tag	object	标签。
Key	string	快照的标签键。	TestKey
Value	string	快照的标签值。	TestValue
RollbackTime	string	最近一次回滚时间。	2021-03-09T07:12:49Z
ResourceGroupId	string	快照所属的资源组 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	错误码	错误信息	描述
400	RegionIdNotMatchHost	The parameter regionId does not match the endpoint host.	传入的regionId和请求的地址不匹配。
403	InvalidParam	The specified parameter value is invalid.	参数非法。
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	指定的实例不存在，请您检查实例ID是否正确。
404	InvalidDiskId.NotFound	The specified DiskId does not exist.	指定的磁盘不存在，请您检查磁盘ID是否正确。
500	InternalError	An error occurred while processing your request.	内部错误，请重试。如果多次尝试失败，请提交工单。

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

变更历史

变更时间	变更内容概要	操作
2024-05-29	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-02-20	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-09-20	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-09-18	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-05-25	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情