listImportTasks()

コレクションのインポートタスクを一覧表示し、一括インポート操作のステータスと詳細を表示します。

javascript
await milvusClient.listImportTasks(data: ListImportTasksReq)

リクエスト構文

javascript
await milvusClient.listImportTasks({
    collection_name: string,
    limit?: number,
    timeout?: number,
})

パラメーター:

collection_name (string) -

[必須]

コレクションの名前。
limit (number) -

返されるタスクの最大数。すべてのタスクを取得するには 0 に設定します。任意です。
timeout (number) -

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

戻り値 Promise<ListImportTasksResponse>

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

typescript
{
    tasks: GetImportStateResponse[],
    status:  ResStatus
}

パラメーター:

tasks (GetImportStateResponse[]) -
インポートタスク記述子の一覧。各エントリには、タスクの状態、行数、segment ID、および作成タイムスタンプが含まれます。
- state (ImportState) -
  
  タスクの状態。可能な値は ImportPending、ImportFailed、ImportStarted、ImportPersisted、ImportCompleted、および ImportFailedAndCleaned です。
- row_count (number) -
  
  タスクによってインポートされた行数。
- id_list (number[]) -
  
  利用可能な場合、インポートされた行に割り当てられた自動生成の主キー。
- infos (KeyValuePair[]) -
  
  診断用のキーと値のペア（例: failed_reason）。
- id (number) -
  
  タスク識別子。
- collection_id (number) -
  
  インポートを受け取ったコレクション。
- segment_ids (number[]) -
  
  タスクによって生成された segment ID。
- create_ts (number) -
  
  タスクの作成タイムスタンプ。
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.listImportTasks({
    collection_name: 'my_collection',
});
console.log(res.tasks);

リクエスト構文​

例​

リクエスト構文

例