跳转到主要内容
资源中心/硬件设施/镜像服务器相关接口

获取镜像服务器存储容量

获取镜像服务器存储容量

GET/zstack/v1/backup-storage/capacities

操作 ID

GetBackupStorageCapacity

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • zoneUuids
    List

    区域UUID列表

  • backupStorageUuids
    List

    镜像服务器UUID列表 zoneUuids, backupStorageUuids 至少有一个不为空 若zoneUuids, backupStorageUuids均为空,all为真

  • all
    boolean

    当镜像服务器UUID列表为空时,该项为真表示查询系统中所有的镜像服务器。

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

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

  • totalCapacity
    long必填

    总容量(以字节计)

  • availableCapacity
    long必填

    可用容量(以字节计)

  • success
    boolean必填

    成功失败标志

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段,默认为null

    • opaque
      LinkedHashMap必填

      保留字段,默认为null

    • cause
      ErrorCode必填

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