You need to enable JavaScript to run this app.
导航
DescribeCursor
最近更新时间:2024.04.29 17:31:19首次发布时间:2022.05.11 11:26:48

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

使用说明

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

请求说明

  • 请求方式:GET
  • 请求地址:https://tls-{Region}.ivolces.com/DescribeCursor

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
TopicIdStringc7e0e442-19bf-4fb3-b547-5992fb8b****要获取日志游标的日志主题 ID。
ShardIdInteger0对应日志分区的 ID。您可以通过 DescribeShards 接口获取指定主题的分区列表。

Body

参数类型是否必选示例值描述
FromStringbegin时间点(Unix时间戳,以秒为单位)或者字符串begin、end。begin对应该分区最早的一条日志,end则对应下一条将要被写入的日志。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数类型示例值描述
CursorStringm****返回的游标值。

请求示例

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

返回示例

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

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
404TopicAlreadyExistTopicNotExist日志主题不存在。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。