You need to enable JavaScript to run this app.
导航
消息队列 Kafka版
  • 文档首页
    • /
  • 消息队列 Kafka版

DescribeTopicAccessPolicies

最近更新时间：2024.03.08 11:37:25

首次发布时间：2023.03.30 19:59:26

我的收藏

调用 DescribeTopicAccessPolicies 接口查看 Topic 的权限列表。

使用说明

此接口用于查看指定 Topic 的权限列表，即哪些 SASL 用户拥有此 Topic 的何种权限。

请求参数

参数

参数类型

是否必选

示例值

说明

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

Array of AccessPolicyObject

/

自定义权限配置，即为某些用户设置对于此 Topic 的自定义权限。仅在 AllAuthority 为 False 时需要设置。详细信息请参考数据结构中的 AccessPolicyObject 部分。

示例

请求示例

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
    }
}