跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/云盘相关接口
PUTVolume Operations起始版本 0.6同步需要认证

修改云盘属性

修改云盘属性

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • updatevolumeObject必填

    updatevolume 请求体结构

    • nameString

      云盘名称

    • descriptionString

      云盘的详细描述

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryVolumeInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • primaryStorageUuidString必填

      主存储UUID

    • vmInstanceUuidString必填

      云主机UUID

    • diskOfferingUuidString必填

      云盘规格UUID

    • rootImageUuidString必填

      根镜像UUID。

    • installPathString必填

      安装路径。

    • typeString必填

      类型。

    • formatString必填

      数据格式或导出格式。

    • sizeLong必填

      返回记录数。

    • actualSizeLong必填

      实际大小。

    • deviceIdInteger必填

      设备ID。

    • stateString必填

      当前状态。

    • statusString必填

      状态信息。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • isShareableBoolean必填

      是否可分享。

请求地址

PUT/zstack/v1/volumes/{uuid}/actions

/zstack/v1/volumes/{uuid}/actions

操作 ID

UpdateVolume

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/volumes/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updatevolume":{"name":"<name>","description":"<description>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "31ae1f16a1774ead98a84432e08e438c", "name": "test-volume", "primaryStorageUuid": "dafbef4c002b4bf49ac63a2e0cf8c616", "vmInstanceUuid": "417e81050f424bf88b515c2bbc3e9d24", "diskOfferingUuid": "80b0f3edaa2f4c0284240d16aebf8da4", "rootImageUuid": "edb9e2aa51c5489db12a7073daa6c878", "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-31ae1f16a1774ead98a84432e08e438c/31ae1f16a1774ead98a84432e08e438c.qcow2", "type": "Root", "format": "qcow2", "size": 1.073741824E11, "actualSize": 2.147483648E10, "deviceId": 0.0, "state": "Enabled", "status": "Ready", "createDate": "Jun 7, 2017 9:20:28 PM", "lastOpDate": "Jun 7, 2017 9:20:28 PM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史