数据接入服务 DIS-获取数据游标:URI
下载数据接入服务 DIS用户手册完整版
URI
GET /v2/{project_id}/cursors
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
stream-name |
是 |
String |
已创建的通道名称。 |
|
partition-id |
是 |
String |
通道的分区标识符。可定义为如下两种样式：- shardId-0000000000- 0比如一个通道有三个分区，那么分区标识符分别为0, 1, 2，或者shardId-0000000000, shardId-0000000001, shardId-0000000002 |
|
cursor-type |
否 |
String |
游标类型。- AT_SEQUENCE_NUMBER：从特定序列号（即starting-sequence-number定义的序列号）所在的记录开始读取数据。此类型为默认游标类型。- AFTER_SEQUENCE_NUMBER：从特定序列号（即starting-sequence-number定义的序列号）后的记录开始读取数据。- TRIM_HORIZON：从最早被存储至分区的有效记录开始读取。例如，某租户使用DIS的通道，分别上传了三条数据A1，A2，A3。N天后（设定A1已过期，A2和A3仍在有效期范围内），该租户需要下载此三条数据，并选择了TRIM_HORIZON这种下载方式。那么用户可下载的数据将从A2开始读取。- LATEST：从分区中的最新记录开始读取，此设置可以保证你总是读到分区中最新记录。- AT_TIMESTAMP：从特定时间戳（即timestamp定义的时间戳）开始读取。 枚举值：
|
|
starting-sequence-number |
否 |
String |
序列号。序列号是每个记录的唯一标识符。序列号由DIS在数据生产者调用PutRecords操作以添加数据到DIS数据通道时DIS服务自动分配的。同一分区键的序列号通常会随时间变化增加。PutRecords请求之间的时间段越长，序列号越大。序列号与游标类型AT_SEQUENCE_NUMBER和AFTER_SEQUENCE_NUMBER强相关，二者共同确定读取数据的位置。取值范围：0~9223372036854775807。 |
|
timestamp |
否 |
Long |
开始读取数据记录的时间戳，与游标类型AT_TIMESTAMP强相关，二者共同确定读取数据的位置。 说明： 此时间戳精确到毫秒。 |
