Querying the User List

Function

This API is used to query the user list.

URI

GET /v2/{project_id}/instances/{instance_id}/users

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
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

**Table 3** Response body parameters
Parameter	Type	Description
users	Array of User objects	User list.
total	Number	Total number of users.

**Table 4** User
Parameter	Type	Description
access_key	String	Username, which starts with a letter, consists of 7 to 64 characters and can contain only letters, digits, hyphens (-), and underscores (_).
secret_key	String	Secret key. Use 8 to 32 characters. Contain at least three of the following character types: Uppercase letters Lowercase letters Digits Special characters`~!@#$%^&*()-_=+\\|[{}];:'"",<.>/? Cannot be the username or the username spelled backwards. "
white_remote_address	String	IP address whitelist.
admin	Boolean	Whether the user is an administrator.
default_topic_perm	String	Default topic permissions.
default_group_perm	String	Default consumer group permissions.
topic_perms	Array of topic_perms objects	Special topic permissions.
group_perms	Array of group_perms objects	Special consumer group permissions.

**Table 5** topic_perms
Parameter	Type	Description
name	String	Topic name.
perm	String	Permissions.

**Table 6** group_perms
Parameter	Type	Description
name	String	Consumer group name.
perm	String	Permissions.

Example Requests

Querying the user list

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/users?offset=0&limit=10

Example Responses

Status code: 200

Query result.

{
  "users" : [ {
    "access_key" : "test_01",
    "admin" : false,
    "default_group_perm" : "DENY",
    "default_topic_perm" : "SUB",
    "group_perms" : [ ],
    "secret_key" : "**************",
    "topic_perms" : [ ],
    "white_remote_address" : ""
  } ],
  "total" : 1
}