Skip to main content
ZStack
Platform O&M/Backup Management/CBT Operations

DisableCbtTask

DisableCbtTask

POST/zstack/v1/cbt-task/disable/{uuid}

Operation ID

DisableCbtTask

Since

5.3.28

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • uuid
    StringRequired

    The resource UUID.

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • force
      boolean

      Optional. Forcible or not.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    booleanRequired

    Whether the operation succeeded.

  • error
    ErrorCodeRequired

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

    • code
      StringRequired

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

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

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

  • inventory
    CbtTaskInventoryRequired

    See inventory

    • uuid
      StringRequired

      The resource UUID.

    • name
      StringRequired

      The resource name.

    • description
      StringRequired

      The resource description.

    • createDate
      TimestampRequired

      The creation time.

    • lastOpDate
      TimestampRequired

      The last operation time.

    • status
      CbtTaskStatusRequired

      See status

      • Created
        CbtTaskStatusRequired

        The task is created.

      • Starting
        CbtTaskStatusRequired

        The task is starting.

      • Running
        CbtTaskStatusRequired

        The task is running.

      • Stopped
        CbtTaskStatusRequired

        The task is stopped.

      • Failed
        CbtTaskStatusRequired

        The task failed.