DescribeTopicAccessPolicies - 查看 Topic 的权限列表--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

DescribeTopicAccessPolicies - 查看 Topic 的权限列表

最近更新时间：2024.09.26 15:55:18首次发布时间：2023.03.30 19:59:26

调用 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	Array of Object	--	自定义权限配置，即为某些用户设置对于此 Topic 的自定义权限。仅在 AllAuthority 为 false 时需要设置。

请求示例

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用户不存在。