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

文档中心

立即注册

导航

消息队列 Kafka版

ModifyTopicAuthorities

最近更新时间：2022.10.18 16:24:27首次发布时间：2022.04.24 15:56:38

调用 ModifyTopicAuthorities 接口更改指定 Topic 的用户权限。

使用说明

该接口用于修改 Topic 的用户权限，可以调整 Topic 对所有用户的默认权限，也可以自定义设置某些用户对于此 Topic 的权限。关于权限设置的详细说明，请参考设置 SASL 用户权限。

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

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	kafka-****	Topic 的实例 ID。
TopicName	String	必选	my_topic	Topic 的名称。
AllAuthority	Bool	必选	false	所有用户是否默认具备此 Topic 的读写权限。默认值为 true。 true：所有用户默认具备当前 Topic 的读写权限。 false：所有用户默认对当前 Topic 都不具备读取或写入的权限。此时可以通过 Authorities 字段设置指定用户对当前 Topic 的权限。
Authorities	List	可选		Topic 的详细权限配置。详细说明请参考Authority。仅在 AllAuthority 配置为 false 时，Authorities 中的配置才会生效，否则无论 Authorities 中的配置为何，所有用户都可以读写此 Topic。

响应参数

无

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=ModifyTopicAuthorities&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",
  "AllAuthority": false,
  "Authorities": [
    {
      "Name": "test",
      "Permission": "Read"
    }
  ]
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "ModifyTopicAuthorities",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": null
}