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

获取Block存储的元数据

获取Block存储的元数据

POST/zstack/v1/primary-storage/block/metadata

操作 ID

GetBlockPrimaryStorageMetadata

起始版本

4.6.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • param
    Object必填

    param 请求体结构

    • vendorName
      String必填

      Block存储厂商名称

    • metadata
      String必填

      存储元数据（ip，port，用户名、密码）

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

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

  • success
    boolean必填

    操作是否成功。

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

  • inventory
    PrimaryStorageInventory必填

    详情参考inventory

    • vendorName
      String必填

      存储厂商名称

    • metadata
      String必填

      存储元数据

    • uuid
      String必填

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

    • zoneUuid
      String必填

      区域UUID

    • name
      String必填

      主存储名称

    • url
      String必填

      未使用

    • description
      String

      资源的详细描述

    • totalCapacity
      Long必填

      总空间

    • availableCapacity
      Long必填

      可用空间

    • totalPhysicalCapacity
      Long必填

      总物理空间

    • availablePhysicalCapacity
      Long必填

      物理可用空间

    • systemUsedCapacity
      Long必填

      系统使用空间

    • type
      String必填

      主存储类型

    • state
      String必填

      启用状态

    • status
      String必填

      连接状态

    • mountPath
      String必填

      未使用

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • attachedClusterUuids
      List必填

      挂载的集群