1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
获取主题属性
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTopicAttributes。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | ckafka集群实例Id 示例值：ckafka-test |
| TopicName | 是 | String | 主题名称 示例值：topic-test |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TopicAttributesResponse | 返回的结果对象 示例值：{"TopicId":"topic-test","CreateTime":1566144000,"Note":"note-test","PartitionNum":20,"EnableWhiteList":0,"IpWhiteList":["10.0.0.5"],"Config":{"Retention":60000,"MinInsyncReplicas":1,"CleanUpPolicy":"delete","SegmentMs":60000,"UncleanLeaderElectionEnable":0,"SegmentBytes":1048576,"MaxMessageBytes":1048576,"RetentionBytes":1048576},"Partitions":[{"Partition":0,"LeaderStatus":0,"IsrNum":2,"ReplicaNum":2}],"EnableAclRule":0,"AclRuleList":[],"QuotaConfig":{"QuotaProducerByteRate":50,"QuotaConsumerByteRate":50},"ReplicaNum":2} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取主题属性
输入示例
https://ckafka.tencentcloudapi.com/?Action=DescribeTopicAttributes
&InstanceId=ckafka-na37x9qa
&TopicName=test-sh
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "2631ff19-2dd4-41a6-9391-c7543dc22c8a",
"Result": {
"AclRuleList": [],
"Config": {
"CleanUpPolicy": "delete",
"LogMsgTimestampType": null,
"MaxMessageBytes": 8388608,
"MinInsyncReplicas": 1,
"Retention": 86400000,
"RetentionBytes": null,
"SegmentBytes": null,
"SegmentMs": null,
"UncleanLeaderElectionEnable": 1
},
"CreateTime": 1720525148,
"EnableAclRule": 0,
"EnableWhiteList": 0,
"IpWhiteList": [],
"Note": "",
"PartitionNum": 1,
"Partitions": [
{
"IsrNum": 2,
"LeaderStatus": 0,
"Partition": 0,
"ReplicaNum": 2
}
],
"QuotaConfig": {
"QuotaConsumerByteRate": null,
"QuotaProducerByteRate": null
},
"ReplicaNum": 2,
"TopicId": "topic-24gugwns"
}
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
| InvalidParameterValue.SubnetIdInvalid | 无效的子网id。 |
| InvalidParameterValue.SubnetNotBelongToZone | 子网不属于zone。 |
| InvalidParameterValue.VpcIdInvalid | 无效的 Vpc Id。 |
| InvalidParameterValue.WrongAction | Action参数取值错误。 |
| InvalidParameterValue.ZoneNotSupport | zone不支持。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation.BatchDelInstanceLimit | 批量删除实例限制。 |
| UnsupportedOperation.OssReject | Oss拒绝该操作。 |
