文档首页/ 智能数据湖 AI DataLake/ API参考/ Flink相关API/ Flink Savepoint管理/ 查询Flink作业Savepoint列表 - ListFlinkSavepoint
更新时间：2026-10-10 GMT+08:00
查看PDF
分享

查询Flink作业Savepoint列表 - ListFlinkSavepoint

功能介绍

查询指定Flink作业的Savepoint记录，返回分页列表。此接口为同步接口，响应中包含Savepoint的详细信息。

可通过查询Flink作业Savepoint详情接口获取指定Savepoint的详细信息。

调用方法

请参见如何调用API。

URI

GET /v2/workspaces/{workspace_id}/flink-jobs/{job_id}/flink-savepoints

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：工作空间ID，用于资源隔离。获取方法请参见获取工作空间ID。

约束限制：不涉及。

取值范围：只能由英文字母、数字及中划线组成，且长度为32~36个字符。

默认取值：不涉及。

job_id

是

String

参数解释：Flink作业ID，用于唯一标识一个Flink作业，可通过查询Flink作业列表接口获取。

约束限制：不涉及。

取值范围：采用UUIDv7格式，固定36个字符。

默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：索引位置偏移量，用于分页查询，从0开始。

约束限制：不涉及。

取值范围：0~100000之间的整数。

默认取值：0。

limit

否

Integer

参数解释：查询返回的记录数，用于分页查询。

约束限制：不涉及。

取值范围：1~1000之间的整数。

默认取值：100。

create_time_after

否

Long

参数解释：筛选起始时间（包含），用于按创建时间筛选。

约束限制：不涉及。

取值范围：0~4102416000000，13位毫秒时间戳。

默认取值：不涉及。

create_time_before

否

Long

参数解释：筛选结束时间（包含），用于按创建时间筛选。

约束限制：不涉及。

取值范围：0~4102416000000，13位毫秒时间戳。

默认取值：不涉及。

state

否

String

参数解释：Savepoint状态，用于按状态筛选Savepoint列表。

约束限制：不涉及。

取值范围：

  • TRIGGER_PENDING：排队等待执行。

  • IN_PROGRESS：执行中。

  • COMPLETED：触发成功。

  • FAILED：触发失败。

  • ABANDONED：放弃/失效。

默认取值：不涉及。

trigger_type

否

String

参数解释：Savepoint触发类型，用于按触发类型筛选Savepoint列表。

约束限制：不涉及。

取值范围：固定值USER_REQUEST，表示由用户手动生成。

默认取值：不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token，用于接口认证鉴权，可通过调用获取IAM用户Token接口获取。

约束限制：不涉及。

取值范围：长度不超过65534个字符。

默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释：Savepoint总数。

取值范围：0~2147483647。

savepoints

Array of FlinkSavepointSummary objects

参数解释：Savepoint摘要信息列表。可显示0~1000个FlinkSavepointSummary对象。
表5 FlinkSavepointSummary

参数

参数类型

描述

savepoint_id

String

参数解释：Savepoint唯一标识。

取值范围：UUIDv7格式，固定36位，由英文小写字母、数字及中划线组成。

job_id

String

参数解释：关联的Flink作业ID。

取值范围：UUIDv7格式，固定36位，由英文小写字母、数字及中划线组成。

trigger_type

String

参数解释：Savepoint触发类型。

取值范围：固定值USER_REQUEST，表示由用户手动生成。

status

FlinkSavepointStatus object

参数解释：Savepoint的状态信息。

created_time

Long

参数解释：创建时间戳。

取值范围：0~4102416000000，13位毫秒时间戳。

location

String

参数解释：快照存储路径。

取值范围：1~512个字符，需以obs://开头。

description

String

参数解释：作业快照描述。

取值范围：0~512个字符。
表6 FlinkSavepointStatus

参数

参数类型

描述

state

String

参数解释：Savepoint当前状态。

取值范围：

  • TRIGGER_PENDING：排队等待执行。

  • IN_PROGRESS：执行中。

  • COMPLETED：触发成功。

  • FAILED：触发失败。

  • ABANDONED：放弃/失效。

state_message

String

参数解释：状态消息详情。

取值范围：0~512个字符。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码，用于标识具体的错误类型。

取值范围：长度为1~256个字符。

error_msg

String

参数解释：错误描述信息，用于说明错误原因。

取值范围：长度为1~1024个字符。

solution_msg

String

参数解释：解决建议，用于提供错误的解决方案。

取值范围：长度为0~1024个字符。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码，用于标识具体的错误类型。

取值范围：长度为1~256个字符。

error_msg

String

参数解释：错误描述信息，用于说明错误原因。

取值范围：长度为1~1024个字符。

solution_msg

String

参数解释：解决建议，用于提供错误的解决方案。

取值范围：长度为0~1024个字符。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码，用于标识具体的错误类型。

取值范围：长度为1~256个字符。

error_msg

String

参数解释：错误描述信息，用于说明错误原因。

取值范围：长度为1~1024个字符。

solution_msg

String

参数解释：解决建议，用于提供错误的解决方案。

取值范围：长度为0~1024个字符。

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码，用于标识具体的错误类型。

取值范围：长度为1~256个字符。

error_msg

String

参数解释：错误描述信息，用于说明错误原因。

取值范围：长度为1~1024个字符。

solution_msg

String

参数解释：解决建议，用于提供错误的解决方案。

取值范围：长度为0~1024个字符。

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码，用于标识具体的错误类型。

取值范围：长度为1~256个字符。

error_msg

String

参数解释：错误描述信息，用于说明错误原因。

取值范围：长度为1~1024个字符。

solution_msg

String

参数解释：解决建议，用于提供错误的解决方案。

取值范围：长度为0~1024个字符。

请求示例

查询指定Flink作业的Savepoint列表，接口默认按创建时间倒序返回，每页最多返回10条记录。

GET /v2/workspaces/{workspace_id}/flink-jobs/{job_id}/flink-savepoints?offset=0&limit=10

响应示例

状态码：200

{
  "count" : 1,
  "savepoints" : [ {
    "savepoint_id" : "019f68a2-5e11-xxxx-xxxx-6e670d65ab03",
    "job_id" : "019f609a-e90c-xxxx-xxxx-a4ec9018e7f2",
    "trigger_type" : "USER_REQUEST",
    "status" : {
      "state" : "COMPLETED"
    },
    "created_time" : 1768444200000,
    "location" : "obs://my-flink-bucket/aidatalake/workspace_57fd5733-xxxx-xxxx-85a9-c6e7f39b1891/flink/endpoint_4702a179-xxxx-xxxx-81c3-6cd4d8090671/jobs/savepoint/019f609a-e90c-xxxx-xxxx-a4ec9018e7f2/2026-01-15_10-30-00/savepoint-2bf36d-c160c7d530c8",
    "description" : "升级前备份。"
  } ]
}

状态码：400

{
  "error_code" : "AIDataLake.01011001",
  "error_msg" : "Invalid parameter",
  "solution_msg" : "Please check the input parameters according to the documentation."
}

状态码：401

{
  "error_code" : "AIDataLake.01011003",
  "error_msg" : "Auth Token not exists in header",
  "solution_msg" : "Please check if auth Token is included in the request header."
}

状态码：403

{
  "error_code" : "AIDataLake.01011005",
  "error_msg" : "Current account has no permission",
  "solution_msg" : "Please connect administrators to add permission."
}

状态码：404

{
  "error_code" : "AIDataLake.01051001",
  "error_msg" : "Flink job 019f609a-e90c-xxxx-xxxx-a4ec9018e7f2 does not exist",
  "solution_msg" : "Please check if Flink job 019f609a-e90c-xxxx-xxxx-a4ec9018e7f2 is entered correctly or has been deleted."
}

状态码：500

{
  "error_code" : "AIDataLake.01010001",
  "error_msg" : "Internal system error",
  "solution_msg" : "Contact operations for analysis."
}

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

认证失败。

403

权限不足。

404

Flink作业不存在。

500

系统内部错误。
父主题： Flink Savepoint管理

相关文档