更新时间:2024-05-22 GMT+08:00

导出Flink作业

功能介绍

该API用于导出Flink作业数据。

URI

  • URI格式

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

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

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

请求消息

表2 请求参数说明

参数名称

是否必选

参数类型

说明

obs_dir

String

OBS路径,用于保存导出的作业文件。

is_selected

Boolean

是否导出指定的作业。

job_selected

Array of Longs

“is_selected”“true”时,该参数是待导出作业的ID集合。

说明:

“is_selected”“true”时,该参数为必选。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

String

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

message

String

系统提示信息,执行成功时,信息可能为空。

zip_file

Array of Strings

导出的作业zip包文件名,保存在OBS上。

请求示例

导出ID为100的作业至OBS。

{
    "obs_dir": "obs-test",
    "is_selected": true,
    "job_selected": [100]
}

响应示例

{
    "is_success": true,
    "message": "导出作业成功",
    "zip_file": ["obs-test/aggregate_1582677879475.zip"]
}

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

导出作业成功。

400

输入参数无效。

错误码

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