ListSnapshotLinks - 查询快照链

查询某个地域下满足条件的快照链。

接口说明

调用该接口时,您需要注意:

  • 请求参数 RegionId、FsIds、LinkIds 等充当过滤器功能,参数间是逻辑与关系。

  • 如果不指定任何参数,则过滤器不起作用。当 FsIds 和 LinkIds 为空数组时,相当于不进行过滤。

调试

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

授权信息

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

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

请求参数

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

所属的地域 ID。

cn-hangzhou
PageNumberinteger

当前页码。

1
PageSizeinteger

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

最大值:100。

默认值:10。

10
FilterKeystring

查询快照链时的筛选键。

与 FilterValue 配合使用,取值必须为 LinkId 或 FsId。

传入 LinkId 则根据快照链 ID 进行筛选,传入 FsId 则根据文件系统 ID 进行筛选。

FsId
FilterValuestring

查询快照链时的筛选值。

与 FilterKey 配合使用。

dbfs-kwziq4dpsle********
FsIdsstring

数据库文件系统 ID。一次最多指定 100 个文件系统 ID。FsIds 参数取值格式为 JSON 数组,ID 之间用半角逗号(,)隔开。

["dbfs-kwziq4dpsle********","dbfs-vuaqvfcjqsg********"]
LinkIdsstring

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

["sl-bp1grgphbcc9brb5****","sl-bp1c4izumvq0i5bs****","sl-bp1akk7isz866dds****"]

返回参数

名称类型描述示例值
object
TotalCountinteger

查询结果总条数。

10
PageSizeinteger

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

10
RequestIdstring

请求 ID。

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

当前页码。

1
Statusstring

数据库文件系统的状态。

取值范围:

  • unattached 待挂载

  • attached 已挂载

  • creating 创建中

  • attaching 挂载中

  • detaching 卸载中

  • deleting 删除中

  • deleted 已删除

  • resizing 扩容中

  • snapshotting 快照中

  • upgrading 升级中

attached
TotalSizelong

快照链中所有快照的大小,单位为 Byte。

50331648
SourceSizeinteger

数据库文件系统容量,单位为 GiB。

20
FsIdstring

数据库文件系统 ID。

dbfs-q7qsgyqptjk******
EcsListobject []

挂载到的 ECS 实例集合。

EcsIdstring

已挂载的 ECS 实例 ID。

i-bp1f4eo2biro*******
SnapshotCountinteger

快照总个数。

1
FsNamestring

DBFS 实例名称。

test
LinkIdstring

快照链 ID

sl-b3zlgraysgcs9jy*******

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "SnapshotLinks": [
    {
      "Status": "attached",
      "TotalSize": 50331648,
      "SourceSize": 20,
      "FsId": "dbfs-q7qsgyqptjk******",
      "EcsList": [
        {
          "EcsId": "i-bp1f4eo2biro*******"
        }
      ],
      "SnapshotCount": 1,
      "FsName": "test",
      "LinkId": "sl-b3zlgraysgcs9jy*******"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegion.DBFSThe region is not supported.不支持的区域。

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

变更历史

变更时间变更内容概要操作
2023-03-16OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:FsIds
    新增入参:LinkIds