Querying the User List
Function
This API is used to query the user list.
User management is supported only when SASL is enabled for the Kafka instance.
URI
GET /v2/{project_id}/instances/{instance_id}/users
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. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
users |
Array of ShowInstanceUsersEntity objects |
User list. |
Example Requests
Querying the user list.
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/users
Example Responses
Status code: 200
The query is successful.
{ "users" : [ { "user_name" : "xxxa", "role" : "guest", "default_app" : false, "created_time" : 1615431764734 }, { "user_name" : "test", "role" : "guest", "default_app" : false, "created_time" : 1615364062463 }, { "user_name" : "ROOT", "role" : "guest", "default_app" : false, "created_time" : 1617194246328 } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
The query is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot