跳转到主要内容
API Explorer|API Explorer
平台运维/灾备管理/CBT相关接口
POSTCBT Operations起始版本 5.3.28同步需要认证

创建CBT任务

创建CBT任务

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • resourceUuidsList必填

      资源UUID列表。

    • 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

  • inventoryCbtTaskInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • statusCbtTaskStatus必填

      详情参考status

      • CreatedCbtTaskStatus必填

        已创建

      • StartingCbtTaskStatus必填

        启动中

      • RunningCbtTaskStatus必填

        运行中

      • StoppedCbtTaskStatus必填

        停止

      • FailedCbtTaskStatus必填

        失败

请求地址

POST/zstack/v1/cbt-task/create

/zstack/v1/cbt-task/create

操作 ID

CreateCbtTask

永久链接

请求示例

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

响应示例

200
{ "inventory": { "uuid": "b70f4160919c38748f908f489ba306ce", "name": "My Task", "status": "Created" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史