跳转到主要内容
API Explorer|API Explorer
平台运维/灾备管理/灾备服务(Plus)/灾备服务相关接口
POSTBackup Service Operations起始版本 3.0.0同步需要认证

创建云主机备份

创建云主机备份

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • rootVolumeUuidString必填

    根云盘UUID

请求体字段

  • paramsObject必填

    请求体参数结构

    • backupStorageUuidString必填

      镜像存储UUID

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • resourceUuidString

      可选。

    • volumeReadBandwidthLong

      云盘读取带宽

    • volumeWriteBandwidthLong

      云盘写入带宽

    • networkReadBandwidthLong

      网络下行带宽

    • networkWriteBandwidthLong

      网络上行带宽

  • systemTagsList

    可选。

  • userTagsList

    可选。

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • volumeUuidString必填

      云盘UUID

    • nameString必填

      备份名称

    • descriptionString必填

      备份的详细描述

    • typeString必填

      云盘的类型

    • stateString必填

      云盘备份的启用状态

    • statusString必填

      云盘备份的状态

    • sizeLong必填

      当前云盘备份的大小

    • metadataString必填

      云盘备份相关元数据

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • backupStorageRefsList必填

      详情参考backupStorageRefs

      • volumeBackupUuidString必填

        云盘备份的uuid

      • backupStorageUuidString必填

        镜像存储UUID

      • installPathString必填

        云盘备份的数据路径

      • statusString必填

        云盘备份在镜像存储的状态

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

POST/zstack/v1/volumes/{rootVolumeUuid}/vm-backups

/zstack/v1/volumes/{rootVolumeUuid}/vm-backups

操作 ID

CreateVmBackup

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/volumes/{rootVolumeUuid}/vm-backups' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"backupStorageUuid":"<backupStorageUuid>","name":"<name>","description":"<description>","resourceUuid":"<resourceUuid>","volumeReadBandwidth":1,"volumeWriteBandwidth":1,"networkReadBandwidth":1,"networkWriteBandwidth":1},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventories": [ { "uuid": "785edb93bb1b3a31857dac1e69cc8392", "volumeUuid": "2ae6b881bb1239cd907d48993e86a2e8", "name": "Root-Volume-Backup-1", "description": "volume backup", "size": 1.073741824E9, "groupUuid": "2f7c0a5bb86430e8a5ac48312172d70d", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" }, { "uuid": "3084eea905f4311b9d484bfe97142bdf", "volumeUuid": "f6c7d5276c873eba8accddd4a09a1ee6", "name": "Data-Volume-Backup-1", "description": "volume backup", "size": 2.147483648E9, "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史