メインコンテンツまでスキップ

listRoles()

この操作はすべてのカスタムロールを一覧表示します。

javascript
await milvusClient.listRoles(data)

リクエスト構文​

javascript
await milvusClient.listRoles(
includeUserInfo?: boolean,
timeout?: number
)

パラメータ:

  • includeUserInfo (boolean) -

    ユーザー情報を含めるかどうかを示すブール値です。

  • timeout (number)

    この操作のタイムアウト時間です。

    これを None に設定すると、何らかのレスポンスが到着した時点、または何らかのエラーが発生した時点でこの操作はタイムアウトします。

戻り値 Promise<SelectRoleResponse>

このメソッドは、SelectRoleResponse オブジェクトに解決される promise を返します。

typescript
{
results: RoleResult[],
status: ResStatus
}

パラメータ:

  • results (RoleResult[]) -
    現在の Milvus インスタンスで定義されている各ロールにつき1つの RoleResult オブジェクトのリストです。RoleResult の完全なフィールド参照については、describeRole() のドキュメントを参照してください。

  • ResStatus
    ResStatus オブジェクトです。

    • code (number) -

      操作結果を示すコードです。この操作が成功した場合は 0 のままです。

    • error_code (string | number) -

      発生したエラーを示すエラーコードです。この操作が成功した場合は Success のままです。

    • reason (string) -

      報告されたエラーの理由を示す理由です。この操作が成功した場合は空文字列のままです。

例​