跳转到主要内容
API Explorer|API Explorer
资源中心/硬件设施/主存储相关接口/XStor Block主存储相关接口
POSTXStor Block Primary Storage Operations起始版本 4.6.0同步需要认证

获取Block存储的元数据

获取Block存储的元数据

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramObject必填

    param 请求体结构

    • vendorNameString必填

      Block存储厂商名称

    • metadataString必填

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

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

  • inventoryPrimaryStorageInventory必填

    详情参考inventory

    • vendorNameString必填

      存储厂商名称

    • metadataString必填

      存储元数据

    • uuidString必填

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

    • zoneUuidString必填

      区域UUID

    • nameString必填

      主存储名称

    • urlString必填

      未使用

    • descriptionString

      资源的详细描述

    • totalCapacityLong必填

      总空间

    • availableCapacityLong必填

      可用空间

    • totalPhysicalCapacityLong必填

      总物理空间

    • availablePhysicalCapacityLong必填

      物理可用空间

    • systemUsedCapacityLong必填

      系统使用空间

    • typeString必填

      主存储类型

    • stateString必填

      启用状态

    • statusString必填

      连接状态

    • mountPathString必填

      未使用

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • attachedClusterUuidsList必填

      挂载的集群

请求地址

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

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

操作 ID

GetBlockPrimaryStorageMetadata

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/primary-storage/block/metadata' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"param":{"vendorName":"<vendorName>","metadata":"<metadata>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventories": [ { "vendorName": "XStor", "uuid": "8f93d463f7d73e1c959aee815ff1e9a8" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史