Message Queue for Kafka
Message Queue for Kafka
Document
- Documentation
Message Queue for KafkaAPI ReferenceV2（2022-05-01）Operation auditDescribeTopicAuditInfo - Query topic audit information
Copy page
Download PDFOperation audit
DescribeTopicAuditInfo - Query topic audit information
Copy pageDownload PDFDescribeTopicAuditInfo - Query topic audit information
Call the DescribeTopicAuditInfo API to query production or consumption records for a specified topic.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.
Action string required Example: DescribeTopicAuditInfo
The operation to be performed: DescribeTopicAuditInfo.
Version string required Example: 2022-05-01
API version, value: 2022-05-01.
PageNumber integer required Example: 1
The pagination code used for the query.
PageSize integer required Example: 10
Page size for the query.
InstanceId string required Example: kafka-cnngf4pulq81xxxx
Instance ID.
Topic string required Example: topic-test
The name of the Topic to query.
Type string requiredOptional Example: Produce
Record type for the query. The options are as follows:
- Produce: Production
- Consume: Consumption
SourceIp string Optional Example: 192.168
Source IP used for filtering. Fuzzy match. No filtering by default.
SourcePort string Optional Example: 23
The source port used for filtering. Fuzzy match, not filtered by default.
SortOrder string Optional Example: Desc
The results are sorted based on the last modification time. The options are as follows:
- Desc (default): Descending
- Asc: Ascending
Response parameters
Only the unique response parameters of this API are listed below. For more details, see response structure.
Total integer Example: 3
Total number of matching results.
Records object[] Example: see code sample
Query results.
Topic string Example: topic-test
Topic name.
SourceIp string Example: 11.156.xxx.xxx
The source IP address for the connection.
SourcePort integer Example: 58950
The source port for the connection.
LastUpdateTime string Example: 2024-11-05T12:05:12Z
The most recent time the Topic was operated.
CreateTime string Example: 2024-11-05T12:05:11Z
Time when the connection was established.
CloseTime string Example: none
Time when the connection was closed. This may be empty, indicating that the current connection is still active.
Request example
POST /?Action=DescribeTopicAuditInfo&Version=2022-05-01 HTTP/1.1
Host: kafka.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241105T120515Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241105/cn-beijing/Kafka/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"PageNumber": 1,
"PageSize": 10,
"InstanceId": "kafka-cnngf4pulq81xxxx",
"Topic": "topic-test",
"Type": "Produce"
}
Response example
{
"ResponseMetadata": {
"RequestId": "20241105200531860139816C6D5D14D7B7-e7****",
"Action": "DescribeTopicAuditInfo",
"Version": "2022-05-01",
"Service": "Kafka",
"Region": "cn-xxxx"
},
"Result": {
"Records": [
{
"CloseTime": "",
"CreateTime": "2024-11-05T12:05:11Z",
"LastUpdateTime": "2024-11-05T12:05:14Z",
"SourceIp": "11.156.xxx.xxx",
"SourcePort": 58950,
"Topic": "topic-test"
},
{
"CloseTime": "",
"CreateTime": "2024-11-05T12:05:11Z",
"LastUpdateTime": "2024-11-05T12:05:13Z",
"SourceIp": "11.156.xxx.xxx",
"SourcePort": 57904,
"Topic": "topic-test"
},
{
"CloseTime": "",
"CreateTime": "2024-11-05T12:05:11Z",
"LastUpdateTime": "2024-11-05T12:05:12Z",
"SourceIp": "11.156.xxx.xxx",
"SourcePort": 65124,
"Topic": "topic-test"
}
],
"Total": 3
}
}
Error code
The following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.
Status code | Error code | Error message | Description |
400 | InvalidParameter.PageNumber | The specified parameter PageNumber is not valid. | The value of PageNumber is invalid. Check and try again. |
400 | InvalidParameter.PageSize | The specified parameter PageSize is not valid. | The PageSize parameter value is invalid. Check and try again. |
400 | InvalidParameter.Type | The specified parameter Type is not valid. | The parameter value Type is invalid. Please check and try again. |
Last updated: 2026.09.22 15:53:40
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
