describeSnapshot()

This operation retrieves detailed information about a specific snapshot.

await milvusClient.describeSnapshot(data: DescribeSnapshotReq)

Request Syntax

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

PARAMETERS:

• collection_name (string) - [REQUIRED] The name of the collection the snapshot belongs to.

• snapshot_name (string) - [REQUIRED] The name of the snapshot to describe.

• db_name (string) - The name of the database. Optional.

• 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.describeSnapshot({
    collection_name: 'my_collection',
    snapshot_name: 'snapshot_2024_01',
});