You need to enable JavaScript to run this app.
Torch Log Service

Torch Log Service

Copy page
Download PDF
Kafka protocol consumption API
CloseKafkaConsumer
Copy page
Download PDF
CloseKafkaConsumer
Call CloseKafkaConsumer to turn off the Kafka protocol consumption function for the specified log topic.​
Usage notes​
After stopping consumption, you can call this interface to turn off the Kafka protocol consumption function. The frequency of this interface is limited to 20 times/s, and an ExceedQPSLimit error will be reported if the frequency limit is exceeded.​
Request syntax​
  • Request Method:PUT​
  • Request URL:https://{tls-endpoint}/CloseKafkaConsumer​
Request parameters​
Body​
​
Name​
Type​
Required​
Example​
Description​
TopicId​
String​
True​
0fdaa6b6-3c9f-424c-8664-fc0d222c****​
Topic ID.​
​
Responses​
none​
Sample Request​
​
PUT https://{tls-endpoint}/CloseKafkaConsumer HTTP/1.1​
Content-Type: application/json​
{​
"TopicId": "66********"​
}​
​
Sample Response​
​
HTTP/1.1 200 OK​
Content-Type: application/json; charset=utf-8 ​
{}​
​
Error code​
For more information, see Common error codes.​
​
HTTP status code​
Error code​
Error message​
Description​
400​
InvalidArgument​
Invalid argument key %s, value %s, please check argument.​
Parameter is invalid.​
404​
TopicNotExist​
topic %s does not exist.​
The journal topic does not exist.​
500​
InternalServerError​
We encountered an unexpected server error, please try again later.​
Internal server error.​
​
​
Last updated: 2025.10.28 18:42:00