Querying User Permissions¶
Function¶
This API is used to query user permissions.
User management is supported only when SASL is enabled for the Kafka instance.
URI¶
GET /v1/{project_id}/instances/{instance_id}/topics/{topic_name}/accesspolicy
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID. For details about how to obtain it, see Obtaining a Project ID. |
instance_id | Yes | String | Instance ID. |
topic_name | Yes | String | Topic name. |
Request Parameters¶
None
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
name | String | Consumer group description. |
topic_type | Integer | Specified IPv4 private IP addresses. The number of specified IP addresses must be less than or equal to the number of new brokers. If the number of specified IP addresses is less than the number of brokers, the unspecified brokers are randomly assigned private IP addresses. |
policies | Array of PolicyEntity objects | New brokers use the standby subnet ID in instance expansion. This value is transferred when a standby subnet is used in instance expansion. Contact customer service to use the value. |
Parameter | Type | Description |
|---|---|---|
owner | Boolean | Whether the user is the one selected during topic creation. |
user_name | String | Username. |
access_policy | String | Permission type.
|
Example Requests¶
Querying user permissions for a topic.
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/topics/{topic_name}/accesspolicy
Example Responses¶
Status code: 200
The query is successful.
{
"name" : "topic-test",
"policies" : [ {
"owner" : false,
"user_name" : "xxxa",
"access_policy" : "pub"
}, {
"owner" : false,
"user_name" : "root",
"access_policy" : "all"
} ],
"topic_type" : 0
}
Status Codes¶
Status Code | Description |
|---|---|
200 | The query is successful. |
Error Codes¶
See Error Codes.