You need to enable JavaScript to run this app.
文档中心
消息队列 Kafka版

消息队列 Kafka版

复制全文
下载 pdf
Topic 管理
DescribeTopicAccessPolicies - 查看 Topic 的权限列表
复制全文
下载 pdf
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 的访问权限。​
  • PubSub:拥有发布、订阅权限。​
  • Pub:拥有发布权限。​
  • Sub:拥有订阅权限。​
​
​
​
​
请求示例​
​
POST /?Action=DescribeTopicAccessPolicies&Version=2022-05-01 HTTP/1.1​
Content-Type: application/json​
Host: kafka.volcengineapi.com​
X-Date: 20210328T100802Z​
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=********​
​
{​
"InstanceId": "kafka-cnngbnntswg1****",​
"TopicName": "123",​
"UserName": "user123"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202302272011074873E7AD95D343684BEE",​
"Action": "DescribeTopicAccessPolicies",​
"Version": "2022-05-01",​
"Service": "Kafka",​
"Region": "cn-beijing"​
},​
"Result": {​
"AccessPolicies": [​
{​
"AccessPolicy": "PubSub",​
"UserName": "user123"​
}​
],​
"AllAuthority": false​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
The specified parameter is not valid.​
参数值无效。​
403​
OperationDenied.AccountNotAuthorized​
You are not authorized to perform this operation.​
您不具备相关权限 ,请授权或切换账号后重试。​
404​
InvalidUserName.NotFound​
The specified user name already exists.​
SASL用户不存在。​
​
​
最近更新时间:2025.08.08 17:47:27
这个页面对您有帮助吗?
有用
有用
无用
无用