更新时间:2023-06-15 GMT+08:00

导入Flink作业

功能介绍

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

URI

  • URI格式

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

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

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

请求消息

表2 请求参数说明

参数名称

是否必选

参数类型

说明

zip_file

String

从OBS上导入的作业zip文件路径,支持填写文件夹,导入文件夹下的所有zip文件。

说明:

文件夹中只能包含zip文件。

is_cover

Boolean

如果导入的作业与服务已有的作业同名,是否覆盖服务中已有的作业。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

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

job_mapping

Array of Objects

导入作业的信息。具体请参考表4

表4 job_mapping参数说明

参数名称

是否必选

参数类型

说明

old_job_id

Long

导入的作业ID。

new_job_id

Long

导入后的作业ID,如果“is_cover”“false”,服务中有同名的作业,则该参数返回值为“-1”

remark

String

导入作业的结果信息。

请求示例

从OBS导入Flink作业数据,如果导入的作业与服务已有的作业同名,是否覆盖服务中已有的作业。

{
    "zip_file": "test/ggregate_1582677879475.zip",
    "is_cover": true
}

响应示例

{
    "is_success": true,
    "message": "导入作业成功",
    "job_mapping": [
        {
            "old_job_id": "100",
            "new_job_id": "200",
            "remark": "Job successfully created"
        }
    ]
}

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

导入作业成功。

400

输入参数无效。

错误码

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