Querying Users Granted Permissions for a Topic
Function
This API is used to query the list of users that have been granted permissions for a topic.
URI
GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/accesspolicy
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details, see Obtaining a Project ID. |
instance_id | Yes | String | Instance ID. |
topic | Yes | String | Topic name. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
offset | No | String | Offset, which is the position where the query starts. The value must be greater than or equal to 0. |
limit | No | String | Number of records to query. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter | Type | Description |
---|---|---|
policies | Array of policies objects | User list. |
total | Number | Total number of users. |
name | String | Name of the topic or consumer group. |
Parameter | Type | Description |
---|---|---|
access_key | String | Username. |
secret_key | String | Key. |
white_remote_address | String | IP address whitelist. |
admin | Boolean | Whether the user is an administrator. |
perm | String | Permissions. |
Example Requests
Querying the list of users granted permissions for a topic
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/{topic}/accesspolicy
Example Responses
Status code: 200
List of users granted permissions for a topic queried successfully.
{"policies" : [ ],"total" : 0,"name" : "test"}
Status Codes
Status Code | Description |
---|---|
200 | List of users granted permissions for a topic queried successfully. |
Error Codes
See Error Codes.
- URI