list_roles()
Near Deprecation此操作列出现有所有角色的信息。
请求语法
python
list_roles(
include_user_info: bool,
using: str,
timeout: float | None
)
参数：
-
include_user_info (bool) -
[必需]
是否让 Zilliz Cloud 列出与所列角色关联的用户。
-
using (str) -
所使用连接的别名。
默认值为 default，表示此操作使用默认连接。
-
timeout (float | None)
此操作的超时时长。将其设置为 None 表示当收到任何响应或发生任何错误时，此操作才会超时。
返回类型：
RoleInfo
返回值：
一个 RoleInfo 对象，其中包含 RoleItem 对象列表。
python
├── RoleInfo
│ └── groups
│ └── RoleItem
│ ├── role_name
│ ├── users
RoleItem 对象包含以下字段：
-
role_name (str)
角色名称。
-
users (str)
被授予该角色的用户。
异常：
-
MilvusException
当此操作期间发生任何错误时，将引发此异常。
示例
python
from pymilvus import connections, Role, utility
# Connection to YOUR_CLUSTER_ENDPOINT
connections.connect()
# Create a user
user = utility.create_user(user="admin", password="123456")
# Create a role
role=Role(
name="admin",
)
role.create()
# Add the user to the role
role.add_user(username="admin")
# List role information
utility.list_roles(include_user_info=True)
# RoleInfo groups:
# - RoleItem: <role_name:admin>, <users:('admin',)>
# - RoleItem: <role_name:public>, <users:()>
相关操作
以下操作与 list_roles() 相关