describe_user()

ユーザーアカウントに関連付けられた roles と description を返します。ユーザーが存在しない場合は空の辞書を返します。

Request Syntax

python

describe_user(
    user_name: str,
    timeout: Optional[float] = None,
    **kwargs
) -> dict

PARAMETERS:

• user_name (str) -
  [REQUIRED]
  説明対象のユーザーアカウント名。

• timeout (Optional[float]) -
  デフォルト: None
  RPC の完了を待機する最大時間（秒）。

• kwargs (Any) -
  追加のリクエストコンテキストオプション。

RETURN TYPE:

dict

RETURNS:

user_name、roles、description を含む辞書。ユーザーが見つからない場合は空の辞書を返します。

• user_name (str) -
  説明されたユーザーアカウントの名前。

• roles (list[str]) -
  ユーザーアカウントに割り当てられたロール。

• description (str) -
  ユーザーアカウントに保存されている説明。

EXCEPTIONS:

• MilvusException
  サーバーがリクエストを拒否した場合、または RPC が失敗した場合に発生します。正確な失敗の詳細については、サーバーのエラーメッセージを確認してください。

Examples

python

from pymilvus import MilvusClient

client = MilvusClient(uri="YOUR_CLUSTER_ENDPOINT", token="YOUR_CLUSTER_TOKEN")
user = client.describe_user("analyst")
print(user)
# {
#     "user_name": "analyst",
#     "roles": ["read_only"],
#     "description": "Analytics account",
# }