调用ListSavepoints获取满足查询条件的快照列表。

调试

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

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

名称 类型 是否必选 示例 描述
workspace String 是 a14bd5d90a****

工作空间ID。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
namespace String Path 是 default-namespace

项目空间名称。
deploymentId String Query 否 88a8fc49-e090-430a-85d8-3ee8c79c****

作业ID，非必填。
jobId String Query 否 99a8fc49-e090-430a-85d8-3ee8c79c****

实例ID，非必填。
pageSize Integer Query 否 100

分页参数，表示所请求页码元素数量，最大值为1000，最小值为1，默认值为100。
pageIndex Integer Query 否 1

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

返回数据

名称 类型 示例值 描述
requestId String CBC799F0-AS7S-1D30-8A4F-882ED4DD****

请求ID。
success Boolean true

表示业务请求是否成功。
httpCode Integer 200

固定值200。
errorCode String ""
  • 当success为false，返回业务错误码；
  • 当success为true，返回空值。
errorMessage String ""
  • 当success为false，返回业务错误信息；
  • 当success为true，返回空值。
pageSize Integer 100

分页参数，所请求页码的元素数量。
pageIndex Integer 1

分页参数，页码索引，表示所请求页码。
totalSize Integer 500

满足查询条件的所有元素的数量。
data Array of Savepoint
  • 当success为true，返回满足查询条件的快照列表；
  • 当success为false，返回空值。

示例

请求示例

GET /api/v2/namespaces/default-namespace/savepoints?deploymentId=88a8fc49-e090-430a-85d8-3ee8c79c****&jobId=99a8fc49-e090-430a-85d8-3ee8c79c****&pageSize=100&pageIndex=1 HTTP/1.1
Host:ververica.aliyuncs.com
workspace:a14bd5d90a****
Content-Type:application/json

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListSavepointsResponse>
    <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>
    <success>true</success>
    <httpCode>200</httpCode>
    <errorCode>""</errorCode>
    <errorMessage>""</errorMessage>
    <pageSize>100</pageSize>
    <pageIndex>1</pageIndex>
    <totalSize>500</totalSize>
    <data>
        <savepointId>354dde66-a3ae-463e-967a-0b4107fd****</savepointId>
        <deploymentId>1d716b22-6aad-4be2-85c2-50cfc757****</deploymentId>
        <jobId>5af678c0-7db0-4650-94c2-d2604f0a****</jobId>
        <namespace>namespacetest</namespace>
        <savepointOrigin>USER_REQUEST</savepointOrigin>
        <nativeFormat>true</nativeFormat>
        <stopWithDrainEnabled>true</stopWithDrainEnabled>
        <savepointLocation>https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf6078****/checkpoints/sp-3285</savepointLocation>
        <status>
            <state>COMPLETED</state>
        </status>
        <createdAt>1659066711</createdAt>
        <modifiedAt>1659069473</modifiedAt>
    </data>
</ListSavepointsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success" : true,
  "httpCode" : 200,
  "errorCode" : "\"\"",
  "errorMessage" : "\"\"",
  "pageSize" : 100,
  "pageIndex" : 1,
  "totalSize" : 500,
  "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,
    "stopWithDrainEnabled" : true,
    "savepointLocation" : "https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf6078****/checkpoints/sp-3285",
    "status" : {
      "state" : "COMPLETED"
    },
    "createdAt" : 1659066711,
    "modifiedAt" : 1659069473
  } ]
}