- 文档首页
消息队列 Kafka版
API 参考
V2(2022-05-01)
Topic 管理
DescribeTopicAccessPolicies - 查看 Topic 的权限列表
Topic 管理
DescribeTopicAccessPolicies - 查看 Topic 的权限列表
DescribeTopicAccessPolicies - 查看 Topic 的权限列表
调用 DescribeTopicAccessPolicies 接口查看 Topic 的权限列表,即哪些 SASL 用户拥有此 Topic 的何种权限。
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。 Action string 必选 示例值:DescribeTopicAccessPolicies
要执行的操作,取值:DescribeTopicAccessPolicies。
Version string 必选 示例值:2022-05-01
API的版本,取值:2022-05-01。
InstanceId string 必选 示例值:kafka-cnngbnntswg1****
实例 ID。
TopicName string 必选 示例值:my_topic
Topic 名称。
UserName string 可选 示例值:my_user
用于过滤的用户名称,仅支持精确匹配。
指定用户名时,只返回指定用户对于此 Topic 的权限。
返回参数
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。 AllAuthority boolean 示例值:true
Topic 是否配置了所有用户都可以访问。
- true:所有用户都具备此 Topic 的读写权限。
- false:任何用户默认都不具备此 Topic 的读写权限。具备自定义权限的用户及其权限请参考参数 AccessPolicies。
AccessPolicies object[] 示例值:--
自定义权限配置,即为某些用户设置对于此 Topic 的自定义权限。仅在 AllAuthority 为 false 时需要设置。
UserName string 示例值:test
SASL 用户名称。
AccessPolicy string 示例值:Sub
SASL 用户对于当前 Topic 的访问权限。
请求示例
返回示例
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
最近更新时间:2025.08.08 17:47:27