ListSavepoints - 获取作业快照及系统检查点列表

获取作业快照及最近系统检查点列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
stream:ListSavepointslist
  • 全部资源
    *

请求语法

GET /api/v2/namespaces/{namespace}/savepoints

请求参数

名称类型必填描述示例值
workspacestring

工作空间 ID。

a14bd5d90a****
namespacestring

项目空间名称。

default-namespace
deploymentIdstring

作业 ID,非必填。

88a8fc49-e090-430a-85d8-3ee8c79c****
jobIdstring

实例 ID,非必填。

99a8fc49-e090-430a-85d8-3ee8c79c****
pageSizeinteger

分页参数,表示所请求页码元素数量,最大值为 100,最小值为 1,默认值为 10。

10
pageIndexinteger

分页参数,页码索引,表示所请求页码,最小值为 1,默认值为 1。

1

返回参数

名称类型描述示例值
object

响应数据。

requestIdstring

请求 ID。

CBC799F0-AS7S-1D30-8A4F-882ED4DD****
successboolean

表示业务请求是否成功。

true
httpCodeinteger

固定值 200。

200
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

""
errorMessagestring
  • 当 success 为 false,返回业务错误信息;

  • 当 success 为 true,返回空值。

""
pageSizeinteger

分页参数,所请求页码的元素数量。

10
pageIndexinteger

分页参数,页码索引,表示所请求页码。

1
totalSizeinteger

满足查询条件的所有元素的数量。

1
dataarray
  • 当 success 为 true,返回满足查询条件的快照列表;

  • 当 success 为 false,返回空值。

Savepoint

快照数据。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "pageSize": 10,
  "pageIndex": 1,
  "totalSize": 1,
  "data": [
    {
      "savepointId": "354dde66-a3ae-463e-967a-0b4107fd****",
      "deploymentId": "1d716b22-6aad-4be2-85c2-50cfc757****",
      "jobId": "5af678c0-7db0-4650-94c2-d2604f0a****",
      "namespace": "namespacetest",
      "savepointOrigin": "USER_REQUEST",
      "nativeFormat": true,
      "description": "作业快照1",
      "stopWithDrainEnabled": true,
      "savepointLocation": "https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf60782c81/checkpoints/sp-3285",
      "status": {
        "state": "COMPLETED",
        "failure": {
          "message": "create savepoint failed",
          "reason": "IO Exception",
          "failedAt": 1655006835
        }
      },
      "createdAt": 1659066711,
      "modifiedAt": 1659069473
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史