全部产品
Search

搜索本产品

    云服务器 ECS：DescribeSnapshotLinks - 查询云盘快照链

    文档中心

    云服务器 ECS：DescribeSnapshotLinks - 查询云盘快照链

    更新时间：Nov 14, 2024

    调用DescribeSnapshotLinks查询云盘快照链。快照链是一块云盘所有快照组成的关系链，一块云盘对应一条快照链。

    接口说明

    调用该接口时，您需要注意：

    • 请求参数RegionId、DiskIds和InstanceId等充当过滤器功能，参数间是逻辑与关系。

    • 如果不指定任何参数，则过滤器不起作用。当DiskIds和SnapshotLinkIds都为空数组时，同样视该过滤器有效，但是返回结果为空。

    调试

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

    授权信息

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

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

    请求参数

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

    云盘所属于的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

    		cn-hangzhou
    InstanceIdstring否

    实例 ID。

    		i-bp1h6jmbefj2cyqs****
    DiskIdsstring否

    云盘 ID。一次最多指定 100 个云盘 ID。DiskIds 参数取值格式为 JSON 数组，ID 之间用半角逗号（,）隔开。

    		["d-bp1d6tsvznfghy7y****", "d-bp1ippxbaql9zet7****", … "d-bp1ib7bcz07lcxa9****"]
    SnapshotLinkIdsstring否

    快照链 ID。一次最多指定 100 个快照 ID。SnapshotLinkIds 参数取值格式为 JSON 数组，ID 之间用半角逗号（,）隔开。

    		["sl-bp1grgphbcc9brb5****", "sl-bp1c4izumvq0i5bs****", … "sl-bp1akk7isz866dds****"]
    PageNumberinteger否

    云盘状态列表的页码。起始值：1。

    默认值：1 。

    		1
    PageSizeinteger否

    分页查询时设置的每页行数。取值范围：1~100。

    默认值：10。

    		50

    返回参数

    名称类型描述示例值
    object
    PageSizeinteger

    输入时设置的每页行数。

    		50
    RequestIdstring

    请求 ID。

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    PageNumberinteger

    快照链列表的页码。

    		1
    TotalCountinteger

    快照链总个数。

    		9
    SnapshotLinkobject
    InstantAccessboolean

    是否开启了快照极速可用功能。可能值：

    • true：开启。仅 ESSD 云盘支持开启该功能。
    • false：关闭。即快照为未开启快照极速可用功能的标准快照。
    说明 该参数已弃用。ESSD 云盘标准快照已升级为默认极速可用，您无需额外配置，且不产生额外花销。
    		false
    TotalSizelong

    快照链中所有快照的大小，单位：Byte。

    		2097152
    SourceDiskNamestring

    源云盘的名称。

    		testSourceDiskName
    SourceDiskSizeinteger

    源云盘容量，单位：GiB。

    		40
    SourceDiskTypestring

    源云盘的云盘类型。可能值：

    • system：系统盘。
    • data：数据盘。
    		data
    InstanceIdstring

    实例 ID。

    		i-bp1h6jmbefj2cyqs****
    SnapshotLinkIdstring

    快照链 ID。

    		sl-2ze0y1jwzpb1geqx****
    TotalCountinteger

    快照总个数。

    		1
    RegionIdstring

    快照链源云盘所属地域 ID。

    		cn-hangzhou
    SourceDiskIdstring

    源云盘 ID，如果快照的源云盘已经被删除，该字段仍旧保留。

    		d-bp1d6tsvznfghy7y****
    InstanceNamestring

    实例名称。

    		testInstanceName
    Categorystring

    快照链类型。可能值：

    • standard: 标准快照链。
    • archive: 归档快照链。
    • flash: 极速可用快照链。
    		standard

    示例

    正常返回示例

    JSON格式

    {
  "PageSize": 50,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 9,
  "SnapshotLinks": {
    "SnapshotLink": [
      {
        "InstantAccess": false,
        "TotalSize": 2097152,
        "SourceDiskName": "testSourceDiskName",
        "SourceDiskSize": 40,
        "SourceDiskType": "data",
        "InstanceId": "i-bp1h6jmbefj2cyqs****",
        "SnapshotLinkId": "sl-2ze0y1jwzpb1geqx****",
        "TotalCount": 1,
        "RegionId": "cn-hangzhou",
        "SourceDiskId": "d-bp1d6tsvznfghy7y****",
        "InstanceName": "testInstanceName",
        "Category": "standard"
      }
    ]
  }
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidInstanceId.NotFoundThe specified instanceId is not exists. -
    400InvalidRegionIdThe specified regionId is invalid.指定的 RegionId 不合法。
    400InvalidSnapshotLinkIdsThe specified snapshotLinkIds is invalid.指定的 SnapshotLinkId 不合法。
    400InvalidDiskIdsThe specified diskIds is invalid.指定的磁盘无效。
    500InternalErrorThe request processing has failed due to some unknown error.内部错误，请重试。

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