调用GetCheckPoint接口获取指定消费组消费数据时Shard的checkpoint。
接口说明
接口说明
请求语法中 Host 由 Project 名称和日志服务 Endpoint 构成,您需要在 Host 中指定 Project。
已创建并获取 AccessKey。更多信息,请参见访问密钥。
阿里云账号 AccessKey 拥有所有 API 的访问权限,风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维。RAM 用户需具备操作日志服务资源的权限。具体操作,请参见创建 RAM 用户及授权。
已明确您查询日志所属的 Project 名称、所属地域、Logstore 名称等。如何查询,请参见管理 Project和管理 Logstore。
已获取消费组名称。更多信息,请参见 ListConsumerGroup 。
鉴权资源
下表列出了 API 对应的授权信息。您可以在 RAM 权限策略语句的 Action 元素中添加该信息,用于为 RAM 用户或 RAM 角色授予调用此 API 的权限。
| 动作(Action) | 授权策略中的资源描述方式(Resource) |
log:GetConsumerGroupCheckPoint | acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup} |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /logstores/{logstore}/consumergroups/{consumerGroup} HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| logstore |
string |
是 |
Logstore 名称。 |
test-logstore |
| consumerGroup |
string |
是 |
消费组名称。 |
consumer-group-1 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| project |
string |
是 |
Project 名称。 |
ali-test-project |
| shard |
integer |
否 |
Shard ID。
|
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
array |
指定消费组消费数据时 Shard 的 Checkpoint 列表。 |
||
|
object |
Checkpoint 结构体。 |
||
| shard |
integer |
Shard ID。 |
0 |
| checkpoint |
string |
Checkpoint 值。 |
MTUyNDE1NTM3OTM3MzkwODQ5Ng== |
| updateTime |
integer |
Checkpoint 最后的更新时间。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。 |
1524224984800922 |
| consumer |
string |
Checkpoint 处的消费者。 |
consumer_1 |
示例
正常返回示例
JSON格式
[
{
"shard": 0,
"checkpoint": "MTUyNDE1NTM3OTM3MzkwODQ5Ng==",
"updateTime": 1524224984800922,
"consumer": "consumer_1"
}
]
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。