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

hasRole()

この操作は、Milvus クラスターにロールが存在するかどうかを確認します。

javascript
await milvusClient.hasRole(data: HasRoleReq)

リクエスト構文

javascript
await milvusClient.hasRole({
roleName: string,
timeout?: number,
})

パラメータ:

  • roleName (string) -

    [必須]

    確認するロールの名前です。

  • timeout (number) -

    ミリ秒単位の RPC タイムアウトです。省略可能です。

戻り値 Promise<HasRoleResponse>

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

typescript
{
hasRole: boolean,
status: ResStatus
}

パラメータ:

  • hasRole (boolean) -
    要求されたロールが存在するかどうかを示す boolean 値です。ロールが存在する場合は true、存在しない場合は false です。

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

    • code (number) -

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

    • error_code (string | number) -

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

    • reason (string) -

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

javascript
import { MilvusClient } from '@zilliz/milvus2-sdk-node';

const client = new MilvusClient({
address: 'YOUR_CLUSTER_ENDPOINT',
token: 'YOUR_CLUSTER_TOKEN',
});
const res = await client.hasRole({ roleName: 'my_role' });
console.log(res.hasRole); // true or false
Ctrl I