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

更新云盘快照信息

更新云盘快照信息

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • updatevolumesnapshotObject必填

    updatevolumesnapshot 请求体结构

    • nameString

      快照的新名称

    • descriptionString

      快照的新详细描述

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryVolumeSnapshotInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • typeString必填

      类型。

    • volumeUuidString必填

      云盘UUID

    • treeUuidString必填

      树UUID。

    • parentUuidString必填

      父级资源UUID。

    • primaryStorageUuidString必填

      主存储UUID

    • primaryStorageInstallPathString必填

      主存储安装路径。

    • volumeTypeString必填

      量类型。

    • formatString必填

      数据格式或导出格式。

    • latestBoolean必填

      最新。

    • sizeLong必填

      返回记录数。

    • stateString必填

      当前状态。

    • statusString必填

      状态信息。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • backupStorageRefsList必填

      详情参考backupStorageRefs

      • volumeSnapshotUuidString必填

        云盘快照UUID

      • backupStorageUuidString必填

        镜像存储UUID

      • installPathString必填

        安装路径。

请求地址

PUT/zstack/v1/volume-snapshots/{uuid}/actions

/zstack/v1/volume-snapshots/{uuid}/actions

操作 ID

UpdateVolumeSnapshot

永久链接

请求示例

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

响应示例

200
{ "inventory": { "uuid": "a50e9be4b0eb492aa1cbb767e38ee45e", "name": "My Snapshot 2", "primaryStorageUuid": "/Cloud_ps/rootVolumes/acct-e77f16d460ea46e18262547b56972273/vol-13c66bb52d0949398e520183b917f813/snapshots/2fa6979af5c6479fa98f37d316f44b5f.qcow2", "volumeType": "Root", "format": "qcow2", "latest": false, "size": 1310720.0, "state": "Enabled", "status": "Ready" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史