Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to check the heartbeat of a consumer group.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: SendConsumerHeartbeat. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ConsumerGroup | Yes | String | Flag of the consumer group that reports the heartbeat. |
| Consumer | Yes | String | Consumer name for reporting heartbeat (alphanumeric underscore, no numbers or _ at the beginning, length less than 256) |
| LogsetId | Yes | String | Logset ID |
| TopicPartitionsInfo.N | Yes | Array of TopicPartitionInfo | Topic partition information. |
| Parameter Name | Type | Description |
|---|---|---|
| ConsumerGroup | String | Consumer group flag corresponding to a log topic. |
| TopicPartitionsInfo | Array of TopicPartitionInfo | Partition information |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
SendConsumerHeartbeat
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendConsumerHeartbeat
<Common request parameters>
{
"ConsumerGroup": "test-123",
"Consumer": "test-123-1",
"LogsetId": "6f6ded3f-948c-4616-9c7c-956a95d8c1a3",
"TopicPartitionsInfo": [
{
"TopicID": "6f6ded3f-948c-4616-9c7c-956a95d8c1a3",
"Partitions": [
1
]
}
]
}
{
"Response": {
"ConsumerGroup": "test-123",
"TopicPartitionsInfo": [
{
"TopicID": "6f6ded3f-948c-4616-9c7c-956a95d8c1a3",
"Partitions": [
1
]
}
],
"RequestId": "6f6ded3f-948c-4616-9c7c-956a95d8c1a3"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback