跳转到主要内容
API Explorer|API Explorer
平台运维/灾备管理/持续数据保护(CDP)/持续数据保护(CDP)相关接口
PUTCDP Operations起始版本 4.3.6同步需要认证

更新CDP任务

更新CDP任务

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString

      资源名称

    • descriptionString

      资源的详细描述

    • backupBandwidthlong

      单个云盘备份速率

    • maxCapacitylong

      CDP任务规划容量

    • maxLatencylong

      CDP任务RPO最大偏移量

    • resourceUuidString

      资源UUID

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    成功

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryCdpTaskInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • policyUuidString必填

      权限策略UUID

    • backupStorageUuidString必填

      镜像存储UUID

    • backupBandwidthlong必填

      单个云盘备份速率

    • maxCapacitylong必填

      CDP任务规划容量

    • usedCapacitylong必填

      CDP已用容量

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • statusCdpTaskStatus必填

      详情参考status

      • CreatedCdpTaskStatus必填

        创建

      • StartingCdpTaskStatus必填

        启动中

      • RunningCdpTaskStatus必填

        运作中

      • StoppedCdpTaskStatus必填

        停止

      • UnknownCdpTaskStatus必填

        未知

      • FailedCdpTaskStatus必填

        失败

    • stateCdpTaskState必填

      详情参考state

      • EnabledCdpTaskState必填

        启用

      • DisabledCdpTaskState必填

        停止

    • taskTypeCdpTaskType必填

      详情参考taskType

      • VMCdpTaskType必填

        云主机

    • resourceRefsList必填

      详情参考resourceRefs

      • taskUuidString必填

        CDP任务UUID

      • resourceUuidString必填

        资源UUID

      • resourceTypeString必填

        任务资源清单

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

PUT/zstack/v1/cdp-backup-storage/task/{uuid}/actions

/zstack/v1/cdp-backup-storage/task/{uuid}/actions

操作 ID

UpdateCdpTask

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/cdp-backup-storage/task/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","backupBandwidth":1,"maxCapacity":1,"maxLatency":1,"resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "2680ec1b4d0c3b69bc4c7a1813a8b3d0", "name": "My Task", "policyUuid": "aef28d43ccec3118bb597c237aa243ae", "backupStorageUuid": "06f62c4b65b237ee854dbcdf01798188", "status": "Created", "state": "Enabled", "taskType": "VM", "backupBandwidth": 1.048576E8, "maxCapacity": 1.073741824E11, "usedCapacity": 0.0, "maxLatency": 0.0, "currentLatency": 0.0 } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史