文档中心

日志服务

请输入

日志管理

DescribeCursor

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

使用说明

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

请求说明

请求参数

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

Query

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

Body

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

返回参数

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

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

请求示例

GET https://{tls-endpoint}/DescribeCursor?TopicId=********&ShardId=0​
{​
    "From": "begin"​
}​

返回示例

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

错误码

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

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

最近更新时间：2026.02.06 15:54:27

这个页面对您有帮助吗？

有用

无用