更新时间:2022-04-16 GMT+08:00
分享

批量停止作业

功能介绍

该API用于批量停止正在运行的作业。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    POST /v1.0/{project_id}/streaming/jobs/stop

  • 参数说明
    表1 URI参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

请求消息

表2 请求参数说明

参数名称

是否必选

参数类型

说明

job_ids

Array of Long

作业ID。

trigger_savepoint

Boolean

在停止作业之前,用户可以选择是否对作业创建保存点,保存作业的状态信息。类型为boolean。

  • 当triggerSavePoint为true时,表示创建保存点。
  • 当triggerSavePoint为false时,表示不创建保存点。默认为false。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

数组元素

Array of Objects

返回的响应消息组。具体请参考表4

表4 数组元素参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

消息内容。

示例

  • 请求样例
    {
      "job_ids": [128, 137],
      "trigger_savepoint": false
    }
  • 响应样例
    {
        "is_success": "true",
        "message": "作业停止请求下发成功"
    }

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

停止作业的请求发送成功。

400

输入参数无效。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

close