跳转到主要内容
ZStack
资源中心/云资源池/云主机相关接口

创建停止云主机的定时任务

创建停止云主机的定时任务

POST/zstack/v1/vm-instances/{vmUuid}/schedulers/stopping

操作 ID

CreateStopVmInstanceScheduler

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • vmUuid
    String必填

    云主机uuid

请求体字段

  • params
    Object必填

    请求体参数结构

    • schedulerName
      String必填

      定时任务名称

    • schedulerDescription
      String

      定时任务描述

    • type
      String必填

      定时任务类型，simple或者cron

    • interval
      Integer

      定时任务间隔，单位秒

    • repeatCount
      Integer

      定时任务重复次数，仅针对simple类型的定时任务生效

    • startTime
      Long

      定时任务启动时间，必须遵循unix timestamp格式，0为从立刻开始

    • cron
      String

      cron表达式，需遵循Java Quartz组件cron格式标准

    • resourceUuid
      String

      用户可指定创建Scheduler所使用的uuid

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

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

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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

  • inventory
    SchedulerInventory必填

    详情参考inventory

    • uuid
      String必填

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

    • targetResourceUuid
      String必填

      目标资源UUID。

    • schedulerName
      String必填

      调度器名称。

    • schedulerJob
      String必填

      调度器任务。

    • schedulerType
      String必填

      调度器类型。

    • schedulerInterval
      Integer必填

      调度器周期。

    • repeatCount
      Integer必填

      重试次数。

    • cronScheduler
      String必填

      Cron调度器。

    • startTime
      Timestamp必填

      起始时间。

    • stopTime
      Timestamp必填

      停止时间。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • state
      String必填

      当前状态。