DescribeTopicAuthorities--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

消息队列 Kafka版

DescribeTopicAuthorities

最近更新时间：2022.11.22 16:46:00首次发布时间：2022.04.24 15:56:37

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

使用说明

此接口的 API Version 为 2018-01-01。
此接口的调用频率限制为 100 次/s，超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	kafka-****	实例 ID。
TopicName	String	必选	my_topic	Topic 名称。长度为 3～64 个字符，只能包含大小写字母、数字、连字符（-）和下划线（_）。
UserName	String	可选	my_user	用于过滤的用户名称，精确匹配。指定用户名时，只返回指定用户对于此 Topic 的权限。

响应参数

参数参数类型说明

参数	参数类型	说明
AllAuthority	Bool	Topic 是否配置了所有用户都可以访问。 true：所有用户都具备此 Topic 的读写权限。 false：任何用户默认都不具备此 Topic 的读写权限。具备自定义权限的用户及其权限请参考 `Authorities`。
Authorities	List	查询到的用户配置列表，详细信息请参考 Authority。

AllAuthority

Bool

Topic 是否配置了所有用户都可以访问。

true：所有用户都具备此 Topic 的读写权限。
false：任何用户默认都不具备此 Topic 的读写权限。具备自定义权限的用户及其权限请参考 Authorities。

Authorities List 查询到的用户配置列表，详细信息请参考 Authority。

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=DescribeTopicAuthorities&Version=2018-01-01 HTTP/1.1
Accept: application/json
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-****",
  "TopicName": "my_topic",
  "UserName": "my_user"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "DescribeTopicAuthorities",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": {
    "AllAuthority": false,
    "Authorities": [
      {
        "Name": "tetuser",
        "Permission": "Read"
      }
    ]
  }
}