listAliases()

这是一个方法模板。

javascript

await milvusClient.listAliases(data)

请求语法

此方法具有以下几种形式。

javascript

listAliases({
    db_name: string
    collection_name: string
    timeout?: number
})

参数：

• db_name (string) -

  持有目标 Collection 的 Database 名称。

• collection_name (string) -

  [必需]

  现有 Collection 的名称。

• timeout (number) -

  此操作的超时时长。

  将其设置为 None 表示当返回任意响应或发生错误时，此操作即超时。

返回 Promise<ListAliasesResponse>

此方法返回一个 promise，解析为 ListAliasesResponse 对象。

typescript

{
    db_name: string,
    aliases: string[],
    collection_name: string,
    status:  ResStatus
}

参数：

• db_name (string) -
  拥有所列别名的 Database。

• aliases (string[]) -
  指向所请求 Collection 的所有别名列表。

• collection_name (string) -
  所列别名指向的 Collection 名称。

• ResStatus
  一个 ResStatus 对象。

  • code (number) -

    表示操作结果的代码。如果此操作成功，则其值保持为 0。

  • error_code (string | number) -

    表示已发生错误的错误代码。如果此操作成功，则其值保持为 Success。

  • reason (string) -

    表示所报告错误原因的说明。如果此操作成功，则其值保持为空字符串。

示例

java

const milvusClient = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
const res = await milvusClient.listAliases({ collection_name: 'my_collection' });