获取数据游标
功能介绍
本接口用于获取数据游标。
URI
GET /v2/{project_id}/cursors
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
stream-name |
是 |
String |
已创建的通道名称。 |
partition-id |
是 |
String |
通道的分区标识符。 可定义为如下两种样式:
比如一个通道有三个分区,那么分区标识符分别为0, 1, 2,或者shardId-0000000000, shardId-0000000001, shardId-0000000002 |
cursor-type |
否 |
String |
游标类型。
枚举值:
|
starting-sequence-number |
否 |
String |
序列号。序列号是每个记录的唯一标识符。序列号由DIS在数据生产者调用PutRecords操作以添加数据到DIS数据通道时DIS服务自动分配的。同一分区键的序列号通常会随时间变化增加。PutRecords请求之间的时间段越长,序列号越大。 序列号与游标类型AT_SEQUENCE_NUMBER和AFTER_SEQUENCE_NUMBER强相关,二者共同确定读取数据的位置。 取值范围:0~9223372036854775807。 |
timestamp |
否 |
Long |
开始读取数据记录的时间戳,与游标类型AT_TIMESTAMP强相关,二者共同确定读取数据的位置。 说明: 此时间戳精确到毫秒。 |
stream-id |
否 |
String |
通道的唯一标识符。在获取被授权通道的迭代器器时必选。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
partition_cursor |
String |
数据游标。 取值范围:1~512个字符。 说明: 数据游标有效期为5分钟。 最小长度:1 最大长度:512 |
请求示例
获取数据游标
GET https://{Endpoint}/v2/{project_id}/cursors
响应示例
状态码: 200
正常返回
{ "partition_cursor" : "eyJnZXRJdGVyYXRvclBhcmFtIjp7InN0cmVhbS1uYW1lIjoianpjIiwicGFydGl0aW9uLWlkIjoiMCIsImN1cnNvci10eXBlIjoiQVRfU0VRVUVOQ0VfTlVNQkVSIiwic3RhcnRpbmctc2VxdWVuY2UtbnVtYmVyIjoiMTAifSwiZ2VuZXJhdGVUaW1lc3RhbXAiOjE1MDYxNTk1NjM0MDV9" }
状态码
状态码 |
描述 |
---|---|
200 |
正常返回 |
错误码
请参见错误码。