You need to enable JavaScript to run this app.
导航
ModifyUserAuthority - 更改 SASL 用户默认权限
最近更新时间:2024.09.26 15:55:18首次发布时间:2023.03.30 19:59:27

调用 ModifyUserAuthority 接口更改指定 SASL 用户对于所有用户的默认权限。

使用说明

消息队列 Kafka版为 SASL 用户提供灵活的权限策略,支持 Topic 粒度的权限管控。您可以通过此接口指定 SASL 用户对于所有 Topic 的默认权限,即是否开启 All Permitted,若为关闭状态,则可以针对不同 Topic 设置更为精细的权限控制策略。详细说明请参考创建 ACL

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

ModifyUserAuthority

要执行的操作,取值:ModifyUserAuthority。

Version
String

2022-05-01

API的版本,取值:2022-05-01。

InstanceId
String

kafka-cnngbnntswg1****

SASL 用户所属的实例 ID。

UserName
String

my_user

SASL 用户名称。

AllAuthority
Boolean

True

指定用户是否具备所有 Topic 的读写权限。

  • true:此用户具备所有Topic的读写权限。
  • false:此用户不具备所有Topic的读写权限。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

POST /?Action=ModifyUserAuthority&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-cnng1si21igu****",
  "AllAuthority": true,
  "UserName": "test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202302272112469B56E707EFFA7E6BAA4E",
        "Action": "ModifyUserAuthority",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter
The specified parameter is not valid.

参数值无效。

403
OperationDenied.InvalidInstanceStatus
The operation is not valid for the current status of the instance.

当前实例状态不允许执行该操作。

403
OperationDenied.AccountNotAuthorized
You are not authorized to perform this operation.

您不具备相关权限 ,请授权或切换账号后重试。

404
InvalidUserName.NotFound
The specified user name already exists.

SASL用户不存在。

404
InvalidInstanceId.NotFound
The specified Instance ID does not exist.

实例不存在。

500
InternalError
The request failed due to some unknown error, exception or failure.

内部错误,请稍后重试。