更新时间:2024-10-31 GMT+08:00
分享

触发Flink作业保存点

功能介绍

触发Flink作业保存点。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1.0/{project_id}/streaming/jobs/{job_id}/savepoint

表1 路径参数

参数

是否必选

参数类型

描述

job_id

String

Flink作业的作业ID。

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

action

String

操作类型。

枚举值:

TRIGGER:触发

savepoint_path

String

Savepoint路径。请确保在使用前完成桶的相关操作授权。

配置示例:obs://bucket-name/dir/savepoint/

响应参数

状态码: 200

表3 响应Body参数

参数名称

参数类型

说明

is_success

Boolean

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

message

String

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

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述信息。

状态码: 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述信息。

请求示例

触发Flink作业保存点。

{
 "action": "TRIGGER",
 "savepoint_path": "obs://bucket-name/dir/savepoint"
}

响应示例

{
    "is_success": true,
    "message": "{\"is_success\":\"true\",\"message\":\"api.msg.deal_savepoint_success\"}"
}

状态码

状态码

描述

200

修改成功。

400

请求错误。

500

内部服务器错误。

错误码

请参见错误码

相关文档