跳转到主要内容
ZStack
资源中心/硬件设施/主存储相关接口/Shared Block主存储相关接口

查询Shared Block主存储

查询Shared Block主存储

GET/zstack/v1/primary-storage/sharedblockgroup
GET/zstack/v1/primary-storage/sharedblockgroup/{uuid}

操作 ID

QuerySharedBlockGroupPrimaryStorage

起始版本

2.3.2

执行模式

同步

认证信息

需要认证

认证信息

调用该 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，唯一标示该资源

    • zoneUuid
      String必填

      区域UUID

    • name
      String必填

      资源名称

    • url
      String必填

      未使用

    • description
      String必填

      资源的详细描述

    • totalCapacity
      Long必填

      总空间

    • availableCapacity
      Long必填

      可用空间

    • totalPhysicalCapacity
      Long必填

      总物理空间

    • availablePhysicalCapacity
      Long必填

      物理可用空间

    • systemUsedCapacity
      Long必填

      系统使用空间

    • type
      String必填

      主存储类型

      • name
        String必填

        资源名称

      • ordinal
        int必填

        ordinal数量。

    • state
      String必填

      启用状态

      • name
        String必填

        资源名称

      • ordinal
        int必填

        ordinal数量。

    • status
      String必填

      连接状态

      • name
        String必填

        资源名称

      • ordinal
        int必填

        ordinal数量。

    • mountPath
      String必填

      未使用

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • attachedClusterUuids
      List必填

      挂载的集群

    • sharedBlocks
      List必填

      详情参考sharedBlocks

      • uuid
        String必填

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

      • sharedBlockGroupUuid
        String必填

        共享块设备组UUID

      • diskUuid
        String必填

        磁盘唯一标示（例如UUID, WWN, WWID）

      • name
        String必填

        资源名称

      • description
        String必填

        资源的详细描述

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

      • type
        SharedBlockType必填

        详情参考type

        • name
          String必填

          资源名称

        • ordinal
          int必填

          ordinal数量。

      • state
        SharedBlockState必填

        详情参考state

        • name
          String必填

          资源名称

        • ordinal
          int必填

          ordinal数量。

      • status
        SharedBlockStatus必填

        详情参考status

        • name
          String必填

          资源名称

        • ordinal
          int必填

          ordinal数量。

    • sharedBlockGroupType
      SharedBlockGroupType必填

      详情参考sharedBlockGroupType

      • name
        String必填

        资源名称

      • ordinal
        int必填

        ordinal数量。