跳转到主要内容
API Explorer|API Explorer
系统全局相关/长时任务相关接口
POSTLong Job Operations起始版本 2.3同步需要认证

提交长时任务

提交长时任务

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString

      资源名称

    • descriptionString

      资源的详细描述

    • jobNameString必填

      任务名称

    • jobDataString必填

      任务数据

    • resourceUuidString

      资源UUID

    • targetResourceUuidString

      可选UUID目标资源。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryLongJobInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • apiIdString必填

      用于关联TaskProgress的APIID

    • jobNameString必填

      任务名称

    • jobDataString必填

      任务数据

    • jobResultString必填

      任务结果

    • targetResourceUuidString必填

      目标资源UUID

    • managementNodeUuidString必填

      管理节点UUID

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateLongJobState必填

      详情参考state

      • nameString必填

        资源名称

      • ordinalint必填

        暂无描述。

请求地址

POST/zstack/v1/longjobs

/zstack/v1/longjobs

操作 ID

SubmitLongJob

永久链接

请求示例

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

响应示例

200
{ "inventory": { "uuid": "23598186b9ef35aa89fbebf8f04d497a" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史