文档首页> 数据接入服务 DIS> API参考> API说明> Checkpoint管理> 查询Checkpoint详情
更新时间：2022-10-20 GMT+08:00
查看PDF

查询Checkpoint详情

功能介绍

本接口用于查询Checkpoint详情。

URI

GET /v2/{project_id}/checkpoints

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

stream_name

是

String

该Checkpoint所属的通道名称。

partition_id

是

String

该Checkpoint所属的通道分区标识符。

可定义为如下两种样式：

  • shardId-0000000000

  • 0

比如一个通道有三个分区，那么分区标识符分别为0, 1, 2，或者shardId-0000000000, shardId-0000000001, shardId-0000000002

app_name

是

String

该Checkpoint关联App名称。

checkpoint_type

是

String

Checkpoint类型。

  • LAST_READ：在数据库中只记录序列号。

枚举值：

  • LAST_READ

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 204

表4 响应Body参数

参数

参数类型

描述

sequence_number

String

序列号，用来记录该通道的消费检查点。

metadata

String

用户消费程序端的元数据信息。

请求示例

查询Checkpoint详情

GET https://{Endpoint}/v2/{project_id}/checkpoints

响应示例

状态码： 204

正常返回

{
  "sequence_number" : "newstram",
  "metadata" : ""
}

状态码

状态码

描述

204

正常返回

错误码

请参见错误码。

父主题： Checkpoint管理