You need to enable JavaScript to run this app.
导航

DescribeCursor

最近更新时间2023.11.13 16:31:27

首次发布时间2022.05.11 11:26:48

通过 DescribeCursor 接口获取日志下载游标。

使用说明

本接口通过指定时间戳获取对应主题分区的消费游标(Cursor)。调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。

URI

请求方法
GET

URI

https://tls-{Region}.ivolces.com/DescribeCursor

传输协议

HTTPS

URI请求参数

参数
参数类型
是否必选
示例值
说明

TopicId

String

必选

c7e********

要获取日志游标的日志主题 ID。

ShardId

Integer

必选

0

对应日志分区的 ID。您可以通过 DescribeShardId 接口获取指定主题的分区列表。

Body请求参数

参数
参数类型
是否必选
示例值
说明

From

String

必选

begin

时间点(Unix 时间戳,以秒为单位)或者字符串 begin、end。begin 对应该分区最早的一条日志,end 则对应下一条将要被写入的日志。

响应参数

参数
类型
示例值
描述

Cursor

String

m****

返回的游标值。

示例

请求示例

GET https://tls-{Region}.ivolces.com/DescribeCursor?TopicId=********&ShardId=0
Content-Type: application/json
...
{
    "From": "begin"
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 
...
{
    "Cursor": "M********"
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

TopicAlreadyExist

404

TopicNotExist

日志主题不存在。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码