listRestoreSnapshotJobs()

This operation lists all snapshot restore jobs. You can filter by target collection name and database name.

await milvusClient.listRestoreSnapshotJobs(data?: ListRestoreSnapshotJobsReq)

Request Syntax

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

PARAMETERS:

• collection_name (string) - Optional filter by target collection name.

• db_name (string) - Optional filter by database name.

• timeout (number) - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or an error occurs. Default is undefined.

• client_request_id (string) - A trace ID for request tracking. Optional.

RETURNS:

Promise

EXCEPTIONS:

• MilvusError

  This exception will be raised when any error occurs during this operation.

Example

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

const client = new MilvusClient({
    address: 'localhost:19530',
    token: 'root:Milvus',
});

const res = await client.listRestoreSnapshotJobs({
    collection_name: 'restored_collection',
});