跳转到主要内容
ZStack
资源中心/云资源池/快照组相关接口

查询快照组

查询快照组

GET/zstack/v1/volume-snapshots/group
GET/zstack/v1/volume-snapshots/group/{uuid}

操作 ID

QueryVolumeSnapshotGroup

起始版本

3.6.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • q
    String

    查询条件。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • snapshotCount
      Integer必填

      组内快照数量

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • vmInstanceUuid
      String必填

      云主机UUID

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • volumeSnapshotRefs
      List必填

      详情参考volumeSnapshotRefs

      • volumeSnapshotUuid
        String必填

        云盘快照UUID

      • volumeSnapshotGroupUuid
        String必填

        快照组UUID

      • deviceId
        int必填

        打快照时云盘的加载序号

      • snapshotDeleted
        boolean必填

        快照是否已经被删除

      • volumeUuid
        String必填

        云盘UUID

      • volumeName
        String必填

        云盘的名字

      • volumeType
        String必填

        云盘的类型

      • volumeSnapshotInstallPath
        String必填

        快照的安装路径

      • volumeSnapshotName
        String必填

        快照的名字

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间