跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/快照组相关接口
PUTSnapshot Group Operations起始版本 3.6.0同步需要认证

更新快照组信息

更新快照组信息

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • updatevolumesnapshotgroupObject必填

    updatevolumesnapshotgroup 请求体结构

    • nameString

      资源名称

    • descriptionString

      资源的详细描述

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryVolumeSnapshotGroupInventory必填

    详情参考inventory

    • uuidString必填

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

    • snapshotCountInteger必填

      组内快照数量

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • vmInstanceUuidString必填

      云主机UUID

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • volumeSnapshotRefsList必填

      详情参考volumeSnapshotRefs

      • volumeSnapshotUuidString必填

        云盘快照UUID

      • volumeSnapshotGroupUuidString必填

        快照组UUID

      • deviceIdint必填

        打快照时云盘的加载序号

      • snapshotDeletedboolean必填

        快照是否已经被删除

      • volumeUuidString必填

        云盘UUID

      • volumeNameString必填

        云盘的名字

      • volumeTypeString必填

        云盘的类型

      • volumeSnapshotInstallPathString必填

        快照的安装路径

      • volumeSnapshotNameString必填

        快照的名字

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

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

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

操作 ID

UpdateVolumeSnapshotGroup

永久链接

请求示例

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

响应示例

200
{ "inventory": { "uuid": "a261086918fe3c04be683430f15920a2", "snapshotCount": 1.0, "name": "group", "vmInstanceUuid": "98ac921100b43981b493071b6430bb2b", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "volumeSnapshotRefs": [ { "volumeSnapshotUuid": "7ac8675cd8a9389ca343a2a7d49c47d7", "volumeSnapshotGroupUuid": "a261086918fe3c04be683430f15920a2", "deviceId": 0.0, "snapshotDeleted": false, "volumeUuid": "6fb0e4a0c3d6315bbb5c08a1a33bc231", "volumeName": "ROOT-volume", "volumeType": "Root", "volumeSnapshotInstallPath": "/Cloud_ps/to/path/snap.qcow2", "volumeSnapshotName": "group-ROOT-volume", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史