Skip to main content
API Explorer|API Explorer
Platform O&M/Backup Management/Continuous Data Protection (CDP)/CDP Operations
PUTCDP OperationsSince 4.3.6SynchronousAuth Required

UpdateCdpTask

UpdateCdpTask

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    The UUID of the resource.

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • nameString

      Optional. The name of the resource.

    • descriptionString

      Optional. Optional. The detailed description of the resource.

    • backupBandwidthlong

      Optional. The backup rate of a single volume.

    • maxCapacitylong

      Optional. The planning capacity of the CDP task.

    • maxLatencylong

      Optional. The RPO maximum latency of the CDP task.

    • resourceUuidString

      Optional. The UUID of the resource.

    • tagUuidsList

      Optional. The UUID list of the tags.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    Succeeded.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryCdpTaskInventoryRequired

    See inventory.

    • uuidStringRequired

      The UUID of the resource.

    • nameStringRequired

      The name of the resource.

    • descriptionString

      Optional. The detailed description of the resource.

    • policyUuidStringRequired

      The UUID of permission policy.

    • backupStorageUuidStringRequired

      The UUID of backup storage.

    • backupBandwidthlongRequired

      The backup rate of a single volume.

    • maxCapacitylongRequired

      The planning capacity of the CDP task.

    • usedCapacitylongRequired

      The used capacity of the CDP task.

    • createDateTimestampRequired

      The time when the CDP task is created.

    • lastOpDateTimestampRequired

      The time when the CDP task is last modified.

    • statusCdpTaskStatusRequired

      See status.

      • CreatedCdpTaskStatusRequired

        The CDP task is created.

      • StartingCdpTaskStatusRequired

        The CDP task is starting.

      • RunningCdpTaskStatusRequired

        The CDP task is running.

      • StoppedCdpTaskStatusRequired

        The CDP task stopped.

      • UnknownCdpTaskStatusRequired

        The state of the CDP task is unknown.

      • FailedCdpTaskStatusRequired

        The CDP task failed.

    • stateCdpTaskStateRequired

      See state.

      • EnabledCdpTaskStateRequired

        The CDP task is enabled.

      • DisabledCdpTaskStateRequired

        The CDP task is disabled.

    • taskTypeCdpTaskTypeRequired

      See taskType.

      • VMCdpTaskTypeRequired

        The VM instance corresponding to the CDP task.

    • resourceRefsListRequired

      See resourceRefs.

      • taskUuidStringRequired

        The UUID of the CDP task.

      • resourceUuidStringRequired

        The UUID of the resource.

      • resourceTypeStringRequired

        The task resource list.

      • createDateTimestampRequired

        The time when the CDP task is created.

      • lastOpDateTimestampRequired

        The time when the CDP task is last modified.

Endpoint

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

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

Operation ID

UpdateCdpTask

Permalink

Request Example

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>"]}'

Response Example

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 } }

Change History

This API has no change history records yet.

View all change history