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

更新Block主存储

更新Block主存储

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • paramsObject必填

    请求体parameter对象。

    • vendorNameString

      可选存储vendor名称。

    • metadataString

      附加元数据。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • inventoryBlockPrimaryStorageInventory必填

    详情参考inventories

    • vendorNameString必填

      存储vendor名称。

    • metadataString必填

      附加元数据。

    • uuidString必填

      资源UUID。

    • zoneUuidString必填

      区域UUID。

    • nameString必填

      资源名称。

    • urlString必填

      地址。

    • descriptionString必填

      资源的详细描述。

    • totalCapacityLong必填

      总容量。

    • availableCapacityLong必填

      可用容量。

    • totalPhysicalCapacityLong必填

      总物理空间

    • availablePhysicalCapacityLong必填

      可用物理容量。

    • systemUsedCapacityLong必填

      系统已使用容量。

    • typeString必填

      类型。

    • stateString必填

      当前状态。

    • statusString必填

      状态信息。

    • mountPathString必填

      mount路径。

    • createDateTimestamp必填

      创建时间。

    • lastOpDateTimestamp必填

      最后操作时间。

    • attachedClusterUuidsList必填

      集群附加。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

PUT/zstack/v1/primary-storage/block/{uuid}/actions

/zstack/v1/primary-storage/block/{uuid}/actions

操作 ID

UpdateBlockPrimaryStorage

永久链接

请求示例

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

响应示例

200
{ "inventory": { "vendorName": "XStor", "metadata": "{\u0027ip\u0027:\u0027127.0.0.1\u0027, \u0027port\u0027:8443, \u0027user\u0027:\u0027test\u0027, \u0027password\u0027:\u0027password\u0027}", "uuid": "c85e957b4b4b3f949494275d443c9807", "name": "block primary storage", "description": "block primary storage description", "availableCapacity": 1073741824, "availablePhysicalCapacity": 1073741824, "type": "BlockStorage", "state": "Enabled", "status": "Connected", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史