跳转到主要内容
API Explorer|API Explorer
数据保护/快照相关接口
POSTSnapshot Interfaces起始版本 3.6.0同步需要认证

创建快照组

创建快照组

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • rootVolumeUuidString必填

      根硬盘UUID

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • resourceUuidString

      资源UUID。若指定，资源会使用该字段值作为UUID。

    • tagUuidsList

      标签UUID列表

  • 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必填

        最后一次修改时间

请求地址

POST/zstack/v1/volume-snapshots/group

/zstack/v1/volume-snapshots/group

操作 ID

CreateVolumeSnapshotGroup

永久链接

请求示例

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

响应示例

200
{ "inventory": { "uuid": "4b13e23059033e2dbfac63b5b16eba11", "snapshotCount": 1.0, "name": "group", "vmInstanceUuid": "9ff17180fded31c2b9e4e5751ebcb2ba", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "volumeSnapshotRefs": [ { "volumeSnapshotUuid": "e83b2d306f0d353a889096ca0b44b444", "volumeSnapshotGroupUuid": "4b13e23059033e2dbfac63b5b16eba11", "deviceId": 0.0, "snapshotDeleted": false, "volumeUuid": "edc07fe8d8a335ec8aa00f23b88fc1c6", "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 暂无变更历史记录。

查看全部变更历史