listSnapshots()

此操作会列出某个 Collection 的所有快照。

typescript

await milvusClient.listSnapshots(data: ListSnapshotsReq)

请求语法

typescript

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

参数：

• collection_name (string) -
  [必需]
  Collection 的名称。

• db_name (string) -
  Database 的名称。可选。

• timeout (number) -
  允许 RPC 持续的可选时长，单位为毫秒。如果将其设置为 undefined，客户端会持续等待，直到服务器响应或发生错误。默认值为 undefined。

• client_request_id (string) -
  用于请求跟踪的追踪 ID。可选。

返回值 Promise<ListSnapshotsResponse>

此方法会返回一个 promise，并解析为 ListSnapshotsResponse 对象。

typescript

{
    snapshots: string[],
    status:  ResStatus
}

参数：

• snapshots (string[]) -
  当前请求的 Collection 中存在的快照名称列表。

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