文档

DescribeSnapshots - 查询快照信息

更新时间:

查询防勒索备份快照信息。

调试

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

授权信息

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

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

请求参数

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

要查询的服务器的 UUID。

说明 调用 DescribeBackupPolicy 接口可以获取该参数。
061d8042-59ff-416e-bc33-294a1cf5****
MachineRegionstring

服务器所在的地域。

us-east-1
MachineRemarkstring

要查询的服务器的名称或 IP 地址。

192.168.XX.XX
StatusListstring

可恢复快照状态列表。取值:

  • COMPLETE:已完成
  • PARTIAL_COMPLETE:备份部分成功
["COMPLETE"]
PageSizeinteger

指定分页查询时,每页显示的数据最大条数。

20
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
NextTokenstring

用来标记当前开始读取的位置,置空表示从头开始。

说明 第一次调用不用填写,会在返回结果中包含第二次调用时用的 NextToken,之后每次调用返回结果中都有下一次调用时的 NextToken。
CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAB4SwmEAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM0NzY3YTZjNjI3NjZmNmU3MjcxNjk3NDY5MzY3MjY4****
ApiVersionstring

防护策略的版本。取值:

  • 1.0.0:表示防护策略的版本为 1.0.0
  • 2.0.0:表示防护策略的版本为 2.0.0
2.0.0
IsAliYunEcsstring

是否阿里云 ECS 主机。取值:

  • true:是
  • false:否
true

返回参数

名称类型描述示例值
object

请求返回数据。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****
PageInfoobject

页面显示的信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
NextTokenstring

查询下一页使用的 token。

CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****
PageSizeinteger

分页查询时,每页显示的备份快照信息的数量。

20
TotalCountinteger

查询到的备份快照信息的总数量。

149
Countinteger

当前页面显示的备份快照信息的数量。

20
Snapshotsobject []

快照列表。

Statusstring

备份快照任务的状态。取值范围:

  • COMPLETE:成功
  • PARTIAL_COMPLETE:部分成功
  • FAILED:失败
COMPLETE
SnapshotHashstring

快照 HASH 值。

9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****
ActualItemslong

快照实际项目数。

说明 目前仅文件备份可用。
123
VaultIdstring

保存备份库快照的仓库 ID。

v-000ccok3zmw7fbzz****
ActualByteslong

去重后快照实际数据量。单位为字节。

686188****
SourceTypestring

数据源类型。取值范围:

  • ECS_FILE:ECS 文件的备份快照。
  • OSS:阿里云 OSS 的备份快照。
  • NAS:阿里云 NAS 的备份快照。
  • OTS_TABLE:阿里云表格存储的备份快照。
ECS_FILE
ClientIdstring

仅当 SourceType 取值为ECS_FILE时,该参数有效。表示备份客户端 ID。

c-000dbefaw9f7gnbw****
ItemsDonelong

备份项目数。

说明 目前仅文件备份可用。
6
BytesTotallong

数据源总量。单位为字节。

3484541815****
Retentionlong

备份快照保留天数。

7
CreatedTimelong

备份快照的创建时间。UNIX 时间,单位为秒。

1646793988
ParentSnapshotHashstring

父备份的快照 HASH 值。

a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****
InstanceIdstring

ECS 实例 ID。

i-2ze78zfakirgh1yl****
PlanIdstring

备份计划 ID。

plan-000ee8gh2ljelsnb****
RegionIdstring

备份服务地域 ID。

us-east-1
Uuidstring

服务器 UUID。

d332af48-1269-4a55-a6db-8543a80f****
ErrorFilestring

记录备份失败信息的文件,包含备份部分完成的信息。

s-0008ndhgrflh55i5****.csv
SnapshotIdstring

快照 ID。

s-0003ahfuqpjdztsg****
JobIdstring

备份任务 ID。

job-000a2q5vg6awgo01****
Pathstring

仅当 SourceType 取值为ECS_FILE时,该参数有效。表示备份的文件路径。

["/home"]
ItemsTotallong

数据源项目总数。

说明 目前仅文件备份可用。
7
BytesDonelong

增量备份的数据量。单位为字节。

800
Pathsarray

仅当 SourceType 取值为 NAS 时,该参数有效。表示备份的文件路径。

string

快照的路径信息。

/home
ClientVersionstring

防勒索客户端版本号。

2.10.0

示例

正常返回示例

JSON格式

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****",
  "PageInfo": {
    "CurrentPage": 1,
    "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****",
    "PageSize": 20,
    "TotalCount": 149,
    "Count": 20
  },
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****",
      "ActualItems": 123,
      "VaultId": "v-000ccok3zmw7fbzz****",
      "ActualBytes": 0,
      "SourceType": "ECS_FILE",
      "ClientId": "c-000dbefaw9f7gnbw****",
      "ItemsDone": 6,
      "BytesTotal": 0,
      "Retention": 7,
      "CreatedTime": 1646793988,
      "ParentSnapshotHash": "a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****",
      "InstanceId": "i-2ze78zfakirgh1yl****",
      "PlanId": "plan-000ee8gh2ljelsnb****",
      "RegionId": "us-east-1",
      "Uuid": "d332af48-1269-4a55-a6db-8543a80f****",
      "ErrorFile": "s-0008ndhgrflh55i5****.csv",
      "SnapshotId": "s-0003ahfuqpjdztsg****",
      "JobId": "job-000a2q5vg6awgo01****",
      "Path": "[\"/home\"]\n",
      "ItemsTotal": 7,
      "BytesDone": 800,
      "Paths": [
        "/home"
      ],
      "ClientVersion": "2.10.0"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈