消费者发送心跳到服务端。
接口说明
接口说明
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:ConsumerGroupHeartBeat | acs:log:${regionId}:${accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/{#ConsumerGroupName} |
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
log:ConsumerGroupHeartBeat |
none |
*全部资源
|
|
无 |
请求语法
POST /logstores/{logstore}/consumergroups/{consumerGroup}?type=heartbeat HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| logstore |
string |
是 |
Logstore 名称。 |
ali-test-logstore |
| consumerGroup |
string |
是 |
消费组名称，同一 Project 中消费组名称为唯一值。 |
consumer_group_test |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| project |
string |
是 |
Project 名称。 |
ali-test-project |
| consumer |
string |
是 |
消费者。 |
consumer_1 |
| body |
array |
是 |
正在消费的 Shard ID 列表。 |
|
|
integer |
否 |
正在消费的 Shard ID 列表。 |
[0] |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
array |
消费者消费的所有 Shard ID 列表。 |
||
|
integer |
消费者消费的所有 Shard ID 列表。 |
[0] |
示例
正常返回示例
JSON格式
[
0
]错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。