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

更新SQL作业

功能介绍

该API用于修改Flink SQL作业。

调试

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

URI

  • URI格式

    PUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}

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

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    job_id

    Long

    作业ID。

请求消息

表2 请求参数说明

参数名称

是否必选

参数类型

说明

name

String

作业名称。长度限制:0-57个字符。

desc

String

作业描述。长度限制:0-512个字符。

queue_name

String

队列名称。长度限制:1-128个字符。

sql_body

String

Stream SQL语句,至少包含source, query, sink三个部分。长度限制:0-1024*1024个字符。

run_mode

String

作业运行模式:

  • shared_cluster:共享。
  • exclusive_cluster:独享。
  • edge_node:边缘节点。

默认值为“shared_cluster”

cu_number

Integer

用户为作业选择的CU数量。默认值为“2”。

parallel_number

Integer

用户设置的作业并行数目。默认值为“1”。

checkpoint_enabled

Boolean

是否开启作业自动快照功能。

  • 开启:true
  • 关闭:false
  • 默认:false

checkpoint_mode

Integer

快照模式,。两种可选:

  • 1:表示exactly_once,数据只被消费一次。
  • 2:at_least_once,数据至少被消费一次。

默认值为1。

checkpoint_interval

Integer

快照时间间隔。单位为秒,默认值为“10”

obs_bucket

String

“checkpoint_enabled”“true”时,该参数是用户授权保存快照的OBS路径。

“log_enabled”“true”时,该参数是用户授权保存作业日志的OBS路径。

log_enabled

Boolean

是否开启作业的日志上传到用户的OBS功能。默认为“false”

smn_topic

String

当作业异常时,向该SMN主题推送告警信息。

restart_when_exception

Boolean

是否开启作业异常自动重启。默认为“false”

idle_state_retention

Integer

空闲状态过期周期,单位为秒,默认值为“3600”

edge_group_ids

Array of Strings

边缘计算组ID列表, 多个ID以逗号分隔。

dirty_data_strategy

String

作业脏数据策略。

  • “2:obsDir”:保存,obsDir表示脏数据存储路径。
  • “1”:抛出异常。
  • “0”:忽略。

默认值为“0”。

udf_jar_url

String

用户已上传到DLI资源管理系统的资源包名,用户sql作业的udf jar通过该参数传入。

manager_cu_number

Integer

用户为作业选择的管理单元(jobmanager)CU数量,默认值为“1”。

tm_cus

Integer

每个taskmanager的CU数,默认值为“1”。

tm_slot_num

Integer

每个taskmanager的slot数,默认值为“(parallel_number*tm_cus)/(cu_number-manager_cu_number)”。

operator_config

String

算子的并行度配置。

resume_checkpoint

Boolean

异常重启是否从checkpoint恢复。

resume_max_num

Integer

异常重试最大次数,单位:次/小时。取值范围:-1或大于0。默认值为“-1”,表示无限次数。

static_estimator_config

String

每个算子的流量/命中率配置,json格式的字符串。例如:

{"operator_list":[{"id":"0a448493b4782967b150582570326227","rate_factor":0.55},{"id":"6d2677a0ecc3fd8df0b72ec675edf8f4","rate_factor":1},{"id":"ea632d67b7d595e5b851708ae9ad79d6","rate_factor":0.55},{"id":"bc764cd8ddf7a0cff126f51c16239658","output_rate":2000}]}

runtime_config

String

Flink作业运行时自定义优化参数。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

消息内容。

job

Object

作业更新信息。具体请参考表4

表4 job参数说明

参数名称

是否必选

参数类型

说明

update_time

Long

作业更新时间,毫秒数。

示例

  • 请求样例
    {
        "name": "myjob",
        "desc": "这是我的第一个作业",
        "queue_name": "testQueue",
        "sql_body": "select * from source_table",
        "run_mode": "shared_cluster",
        "cu_number": 4,
        "parallel_number": 4,
        "checkpoint_enabled": false,
        "checkpoint_mode": "exactly_once",
        "checkpoint_interval": 10,
        "obs_bucket": "",
        "log_enabled": false,
        "smn_topic": "",
        "restart_when_exception": false,
        "idle_state_retention": 3600,
        "edge_group_ids": [
            "62de1e1c-066e-48a8-a79d-f461a31b2ee1",
            "2eb00f85-99f2-4144-bcb7-d39ff47f9002"
        ],
        "dirty_data_strategy": "0",
        "udf_jar_url": "group/test.jar"
    }
  • 响应样例
    {
        "is_success": "true",
        "message": "作业更新成功",
        "job": {
            "update_time": 1578905682534
        }
    }

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

作业更新成功。

400

输入参数无效。

错误码

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

分享:

    相关文档

    相关产品

close