list_users()
Near Deprecation此操作列出所有现有用户的信息。
请求语法
python
list_users(
include_role_info: bool,
using: str,
timeout: float | None
)
参数
-
include_role_info (bool) -
[必需]
是否由 Zilliz Cloud 列出授予指定用户的角色。
-
using (string) -
所使用连接的别名。
默认值为 default，表示此操作使用默认连接。
-
timeout (float | None)
此操作的超时时长。将其设置为 None 表示当收到任何响应或发生任何错误时，此操作超时。
返回类型：
UserInfo
返回值：
包含用户信息的 UserInfo 对象。
python
├── UserInfo
│ └── groups
│ └── UserItem
│ ├── username
│ ├── roles
UserItem 对象包含以下字段：
-
username (str)
用户名称。
-
roles (str)
分配给用户的角色。
异常：
-
MilvusException
在此操作期间发生任何错误时，将引发此异常。
示例
python
from pymilvus import connections, utility
# Connection to YOUR_CLUSTER_ENDPOINT
connections.connect()
# List the information of all existing users
user = utility.list_users(
include_role_info=True,
using="default"
)
# UserInfo groups:
# - UserItem: <username:admin>, <roles:('admin',)>
# - UserItem: <username:root>, <roles:()>
相关操作
以下操作与 list_users() 相关：