更新时间：2022-10-20 GMT+08:00
提交Checkpoint
功能介绍
本接口用于提交Checkpoint。
URI
POST /v2/{project_id}/checkpoints
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
app_name |
是 |
String |
APP的名称，用户数据消费程序的唯一标识符，需要先通过创建App接口创建。 |
checkpoint_type |
是 |
String |
Checkpoint类型。
枚举值：
|
stream_name |
是 |
String |
已创建的通道名称。 |
partition_id |
是 |
String |
通道的分区标识符。 可定义为如下两种样式：
比如一个通道有三个分区，那么分区标识符分别为0, 1, 2，或者shardId-0000000000, shardId-0000000001, shardId-0000000002 |
sequence_number |
是 |
String |
需要提交的序列号，用来记录该通道的消费检查点，需要保证该序列号处于有效范围内。 |
metadata |
否 |
String |
用户消费程序端的元数据信息。 元数据信息的最大长度为1000个字符。 最大长度：1000 |
响应参数
无
请求示例
提交Checkpoint
POST https://{Endpoint}/v2/{project_id}/checkpoints
{
"stream_name" : "newstream",
"app_name" : "newapp",
"partition_id" : "0",
"sequence_number" : "2",
"checkpoint_type" : "LAST_READ"
}
响应示例
无
状态码
状态码 |
描述 |
|---|---|
201 |
正常返回 |
错误码
请参见错误码。
父主题： Checkpoint管理
