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

listRefreshExternalCollectionJobs()

この操作は、external collection のすべてのリフレッシュジョブを一覧表示します。collection 名とデータベース名でフィルタリングできます。

typescript
await milvusClient.listRefreshExternalCollectionJobs(data?: ListRefreshExternalCollectionJobsReq)

リクエスト構文​

typescript
await milvusClient.listRefreshExternalCollectionJobs({
    collection_name?: string,
    db_name?: string,
    timeout?: number,
    client_request_id?: string,
})

パラメーター:

  • collection_name (string) -
    collection 名でのオプションのフィルターです。

  • db_name (string) -
    データベース名でのオプションのフィルターです。

  • timeout (number) -
    RPC に許可するオプションの時間（ミリ秒）です。undefined に設定すると、サーバーが応答するかエラーが発生するまで、クライアントは待機を続けます。デフォルトは undefined です。

  • client_request_id (string) -
    リクエスト追跡用のトレース ID です。オプションです。

戻り値 Promise<ListRefreshExternalCollectionJobsResponse>

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

typescript
{
    jobs: RefreshExternalCollectionJobInfo[],
    status:  ResStatus
}

パラメーター:

  • jobs (RefreshExternalCollectionJobInfo[]) -
    要求されたデータベースおよび collection フィルターに一致するリフレッシュジョブのリストです。RefreshExternalCollectionJobInfo の完全なフィールドリファレンスについては、getRefreshExternalCollectionProgress() のドキュメントを参照してください。

  • 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.listRefreshExternalCollectionJobs({
    collection_name: 'my_external_collection',
});
Ctrl I