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

getReplicas()

この操作は collection の replicas を取得し、各 replica の ID、ノード割り当て、shard の詳細を含む情報を返します。

javascript
await milvusClient.getReplicas(data: GetReplicaReq)

Request Syntax​

javascript
await milvusClient.getReplicas({
    collectionID: number | string,
    with_shard_nodes?: boolean,
    timeout?: number,
})

PARAMETERS:

  • collectionID (number | string) -

    [REQUIRED]

    collection の ID。

  • with_shard_nodes (boolean) -

    レスポンスに shard ノード情報を含めるかどうか。任意です。

  • timeout (number) -

    ミリ秒単位の RPC タイムアウト。任意です。

RETURNS Promise<ReplicasResponse>

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

typescript
{
    replicas: ReplicaInfo[],
    status:  ResStatus
}

PARAMETERS:

  • replicas (ReplicaInfo[]) -
    リクエストされた collection を現在処理している replicas の一覧。

    • replicaID (string) -

      replica 識別子。

    • collectionID (string) -

      collection 識別子。

    • partition_ids (string[]) -

      この replica が対象とする partition 識別子。

    • shard_replicas (ShardReplica[]) -

      shard ごとのリーダーおよびノード割り当て情報。

      • leaderID (string) -

      shard リーダーとして動作する query node の ID。

      • leader_addr (string) -

      リーダー query node のアドレス。

      • dm_channel_name (string) -

      この shard が処理する DML channel。

      • node_ids (string[]) -

      この shard のデータを保持する query node の ID。

      • leaderID (string) -

        shard リーダーとして動作する query node の ID。

      • leader_addr (string) -

        リーダー query node のアドレス。

      • dm_channel_name (string) -

        この shard が処理する DML channel。

      • node_ids (string[]) -

        この shard のデータを保持する query node の ID。

    • node_ids (string[]) -

      この replica に参加している query node の ID。

    • resource_group_name (string) -

      この replica のノードを所有する resource group。

    • num_outbound_node (Record<string, number>) -

      resource group ごとの outbound ノード数で、リバランス時に使用されます。

  • ResStatus
    ResStatus オブジェクト。

    • code (number) -

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

    • error_code (string | number) -

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

    • reason (string) -

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

Example​

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

const client = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
const desc = await client.describeCollection({ collection_name: 'my_collection' });
const replicas = await client.getReplicas({
    collectionID: desc.collectionID,
});
console.log(replicas.replicas);
Ctrl I