Domain name for API request: ckafka.intl.tencentcloudapi.com.
This API is used to get topic list details (only for call in the console).
A maximum of 100 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: DescribeTopicDetail. |
| Version | Yes | String | Common Params. The value used for this API: 2019-08-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | ckafka cluster instance Id, which can be obtained through the DescribeInstances API |
| SearchWord | No | String | (Filtering Conditions) Filter by topicName. Fuzzy query is supported. |
| Offset | No | Integer | Offset, which is 0 by default |
| Limit | No | Integer | Number of returned results. Default value: 20. Value must be above 0. |
| AclRuleName | No | String | Acl preset policy name |
| OrderBy | No | String | Sort by specific attributes (Currently supports PartitionNum/CreateTime). Default value is CreateTime. If empty, default to reverse sort by CreateTime. |
| OrderType | No | Integer | 0-sequential, 1-reverse, default value is 0. |
| Filters.N | No | Array of Filter | Currently supports filtering by ReplicaNum (number of replicas) |
| Parameter Name | Type | Description |
|---|---|---|
| Result | TopicDetailResponse | Returned topic detail entity |
| 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. |
https://ckafka.intl.tencentcloudapi.com/?Action=DescribeTopicDetail
&InstanceId=ckafka-xxooa0
&<Common request parameters>
{
"Response": {
"RequestId": "071db315-27d5-4a7c-8bb3-e05c23e7a69c",
"Result": {
"TopicList": [
{
"Config": {
"CleanUpPolicy": "delete",
"LogMsgTimestampType": null,
"MaxMessageBytes": 8388608,
"MinInsyncReplicas": 1,
"Retention": 259200000,
"RetentionBytes": null,
"SegmentBytes": null,
"SegmentMs": null,
"UncleanLeaderElectionEnable": 1
},
"CreateTime": 1716452124,
"EnableWhiteList": false,
"ForwardCosBucket": "",
"ForwardInterval": 0,
"ForwardStatus": 1,
"IpWhiteListCount": 0,
"Note": "",
"PartitionNum": 10,
"ReplicaNum": 2,
"RetentionTimeConfig": {
"Current": 4320,
"Expect": 4320,
"ModTimeStamp": 1716452125000
},
"Status": 0,
"Tags": null,
"TopicId": "topic-4mi2t5w2",
"TopicName": "yourname"
},
{
"Config": {
"CleanUpPolicy": "delete",
"LogMsgTimestampType": null,
"MaxMessageBytes": 8388608,
"MinInsyncReplicas": 1,
"Retention": 86400000,
"RetentionBytes": null,
"SegmentBytes": null,
"SegmentMs": null,
"UncleanLeaderElectionEnable": 1
},
"CreateTime": 1720525148,
"EnableWhiteList": false,
"ForwardCosBucket": "",
"ForwardInterval": 0,
"ForwardStatus": 1,
"IpWhiteListCount": 0,
"Note": "",
"PartitionNum": 1,
"ReplicaNum": 2,
"RetentionTimeConfig": {
"Current": 1440,
"Expect": 1440,
"ModTimeStamp": 1720525149000
},
"Status": 0,
"Tags": null,
"TopicId": "topic-24gugwns",
"TopicName": "test-shilinlu"
}
],
"TotalCount": 2
}
}
}
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 | Invalid parameter. |
| InvalidParameterValue.InstanceNotExist | The instance does not exist. |
| InvalidParameterValue.SubnetNotBelongToZone | The subnet is not in the zone. |
| InvalidParameterValue.WrongAction | The value of the Action parameter is incorrect. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedOperation.OssReject | Oss rejected the operation. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan