# HttpClient

Look up the Node.js HttpClient constructor, camelCase request fields, HttpError, and TypeScript methods backed by the Milvus REST API.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/

## Section links

- [Constructor](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#constructor)
- [Per-request options](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#per-request-options)
- [Collection APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#collection-apis)
- [createCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createcollection)
- [describeCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describecollection)
- [dropCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropcollection)
- [addCollectionField](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#addcollectionfield)
- [alterCollectionProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#altercollectionproperties)
- [alterCollectionFieldProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#altercollectionfieldproperties)
- [dropCollectionProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropcollectionproperties)
- [listCollections](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listcollections)
- [hasCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#hascollection)
- [renameCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#renamecollection)
- [getCollectionStatistics](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getcollectionstatistics)
- [flushCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#flushcollection)
- [loadCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#loadcollection)
- [releaseCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#releasecollection)
- [getCollectionLoadState](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getcollectionloadstate)
- [compactCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#compactcollection)
- [getCompactionState](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getcompactionstate)
- [refreshLoad](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#refreshload)
- [Collection maintenance example](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#collection-maintenance-example)
- [Data APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#data-apis)
- [insert](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#insert)
- [upsert](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#upsert)
- [get](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#get)
- [query](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#query)
- [search](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#search)
- [hybridSearch](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#hybridsearch)
- [delete](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#delete)
- [Filtering, ordering, and grouping](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#filtering-ordering-and-grouping)
- [Database APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#database-apis)
- [createDatabase](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createdatabase)
- [dropDatabase](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropdatabase)
- [describeDatabase](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describedatabase)
- [listDatabases](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listdatabases)
- [alterDatabaseProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#alterdatabaseproperties)
- [dropDatabaseProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropdatabaseproperties)
- [Index APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#index-apis)
- [createIndex](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createindex)
- [dropIndex](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropindex)
- [describeIndex](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describeindex)
- [listIndexes](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listindexes)
- [alterIndexProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#alterindexproperties)
- [dropIndexProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropindexproperties)
- [Partition APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#partition-apis)
- [listPartitions](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listpartitions)
- [createPartition](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createpartition)
- [dropPartition](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#droppartition)
- [loadPartitions](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#loadpartitions)
- [releasePartitions](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#releasepartitions)
- [hasPartition](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#haspartition)
- [getPartitionStatistics](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getpartitionstatistics)
- [Alias APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#alias-apis)
- [listAliases](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listaliases)
- [createAlias](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createalias)
- [describeAlias](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describealias)
- [alterAlias](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#alteralias)
- [dropAlias](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropalias)
- [Import APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#import-apis)
- [listImportJobs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listimportjobs)
- [createImportJobs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createimportjobs)
- [getImportJobProgress](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getimportjobprogress)
- [commitImportJob](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#commitimportjob)
- [abortImportJob](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#abortimportjob)
- [Import job example](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#import-job-example)
- [Collection Schema Changes](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#collection-schema-changes)
- [addCollectionStructField](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#addcollectionstructfield)
- [dropCollectionField](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropcollectionfield)
- [addFunctionField](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#addfunctionfield)
- [dropFunctionField](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropfunctionfield)
- [alterCollectionFunction](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#altercollectionfunction)
- [truncateCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#truncatecollection)
- [External Collection Refresh](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#external-collection-refresh)
- [refreshExternalCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#refreshexternalcollection)
- [getRefreshExternalCollectionProgress](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getrefreshexternalcollectionprogress)
- [listRefreshExternalCollectionJobs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listrefreshexternalcollectionjobs)
- [Snapshot APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#snapshot-apis)
- [createSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createsnapshot)
- [listSnapshots](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listsnapshots)
- [describeSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describesnapshot)
- [dropSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropsnapshot)
- [pinSnapshotData](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#pinsnapshotdata)
- [unpinSnapshotData](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#unpinsnapshotdata)
- [restoreSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#restoresnapshot)
- [getRestoreSnapshotState](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getrestoresnapshotstate)
- [listRestoreSnapshotJobs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listrestoresnapshotjobs)
- [exportSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#exportsnapshot)
- [getExportSnapshotState](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getexportsnapshotstate)
- [restoreExternalSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#restoreexternalsnapshot)
- [Resource Group APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#resource-group-apis)
- [createResourceGroup](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createresourcegroup)
- [describeResourceGroup](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describeresourcegroup)
- [listResourceGroups](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listresourcegroups)
- [dropResourceGroup](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropresourcegroup)
- [updateResourceGroups](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#updateresourcegroups)
- [transferReplica](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#transferreplica)
- [User and Role APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#user-and-role-apis)
- [createUser](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createuser)
- [updateUserPassword](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#updateuserpassword)
- [dropUser](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropuser)
- [describeUser](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describeuser)
- [listUsers](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listusers)
- [grantRoleToUser](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#grantroletouser)
- [revokeRoleFromUser](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#revokerolefromuser)
- [createRole](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createrole)
- [alterRole](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#alterrole)
- [dropRole](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#droprole)
- [describeRole](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describerole)
- [listRoles](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listroles)
- [grantPrivilegeToRole](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#grantprivilegetorole)
- [revokePrivilegeFromRole](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#revokeprivilegefromrole)
- [Role privilege example](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#role-privilege-example)
- [grantPrivilegeV2](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#grantprivilegev2)
- [revokePrivilegeV2](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#revokeprivilegev2)
- [createPrivilegeGroup](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#createprivilegegroup)
- [addPrivilegesToGroup](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#addprivilegestogroup)
- [removePrivilegesFromGroup](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#removeprivilegesfromgroup)
- [listPrivilegeGroups](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listprivilegegroups)
- [dropPrivilegeGroup](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#dropprivilegegroup)
- [Analyzer and File Resource APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#analyzer-and-file-resource-apis)
- [runAnalyzer](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#runanalyzer)
- [addFileResource](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#addfileresource)
- [listFileResources](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#listfileresources)
- [removeFileResource](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#removefileresource)
- [Diagnostics APIs](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#diagnostics-apis)
- [getSegmentsInfo](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getsegmentsinfo)
- [getQuotaMetrics](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getquotametrics)
- [Errors](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#errors)
- [Related](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#related)

`HttpClient` is the REST client exported by `@zilliz/milvus2-sdk-node`. Use it when an environment prefers HTTP over gRPC, such as serverless platforms, HTTP-only runtimes, or proxy-restricted deployments.

HTTP request fields use the REST API’s camelCase naming convention, for example `collectionName`, `dbName`, `outputFields`, and `indexParams`. gRPC APIs on `MilvusClient` use snake_case fields such as `collection_name` and `output_fields`.

## Constructor

```text
new HttpClient(config: HttpClientConfig)
```

```typescript
type HttpClientConfig =
  | {
      endpoint: string;
      baseURL?: string;
      database?: string;
      token?: string;
      username?: string;
      password?: string;
      timeout?: number;
      fetch?: typeof fetch;
      acceptInt64?: boolean;
    }
  | {
      baseURL: string;
      endpoint?: string;
      database?: string;
      token?: string;
      username?: string;
      password?: string;
      timeout?: number;
      fetch?: typeof fetch;
      acceptInt64?: boolean;
    };
```

`endpoint` is the cluster origin, such as `https://your-cluster.example.com`. The SDK appends `/v2` automatically. If you set `baseURL` directly, include the full versioned base URL, such as `https://your-cluster.example.com/v2`. A base URL without `/v2` can produce 404 responses.

Example:

```typescript
import { HttpClient, HttpError } from '@zilliz/milvus2-sdk-node';

const client = new HttpClient({
  endpoint: 'https://your-cluster.example.com',
  token: process.env.MILVUS_TOKEN,
  database: 'default',
  timeout: 30_000,
  acceptInt64: true,
});
```

## Per-request options

Every HTTP method accepts an optional `FetchOptions` object.

```typescript
type FetchOptions = {
  abortController: AbortController;
  timeout: number;
};
```

Example:

```typescript
await client.search(
  {
    collectionName: 'books',
    data: [[0.1, 0.2, 0.3, 0.4]],
    outputFields: ['title'],
    limit: 10,
  },
  { abortController: new AbortController(), timeout: 10_000 }
);
```

## Collection APIs

### createCollection

`createCollection(data, options?)`

Create a collection by dimension shortcut or explicit schema.

### describeCollection

```text
describeCollection(data: HttpBaseReq, options?: FetchOptions): Promise<HttpCollectionDescribeResponse>
```

Pass `collectionName`. Optionally set `dbName`.

```ts
const { code, data } = await client.describeCollection({
  collectionName: 'books',
});
```

Returns a Milvus response envelope with collection metadata, including schema fields, indexes, and load state.

[Try the REST operation](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/describe/).

### dropCollection

`dropCollection(data, options?)`

Drop a collection.

### addCollectionField

`addCollectionField(data, options?)`

Add a field to an existing collection.

### alterCollectionProperties

`alterCollectionProperties(data, options?)`

Add or update collection properties.

### alterCollectionFieldProperties

`alterCollectionFieldProperties(data, options?)`

Alter field-level properties such as `max_length`, `max_capacity`, or `mmap_enabled`.

### dropCollectionProperties

`dropCollectionProperties(data, options?)`

Remove collection properties by key.

### listCollections

```text
listCollections(data?: HttpCollectionListReq, options?: FetchOptions): Promise<HttpCollectionListResponse>
```

All inputs are optional. Set `dbName` to choose the database.

```ts
const { code, data } = await client.listCollections({ dbName: 'default' });
```

Returns a Milvus response envelope with collection names as a string array.

[Try the REST operation](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/list/).

### hasCollection

`hasCollection(data, options?)`

Check whether a collection exists.

### renameCollection

`renameCollection(data, options?)`

Rename a collection, optionally into another database.

### getCollectionStatistics

`getCollectionStatistics(data, options?)`

Get collection statistics such as row count.

### flushCollection

`flushCollection(data, options?)`

Flush a collection.

### loadCollection

`loadCollection(data, options?)`

Load a collection into memory.

### releaseCollection

`releaseCollection(data, options?)`

Release a loaded collection.

### getCollectionLoadState

`getCollectionLoadState(data, options?)`

Get load progress and load state.

### compactCollection

`compactCollection(data, options?)`

Start collection compaction.

### getCompactionState

`getCompactionState(data, options?)`

Get compaction progress by compaction ID.

### refreshLoad

`refreshLoad(data, options?)`

Refresh an existing loaded collection.

### Collection maintenance example

```typescript
await client.flushCollection({ collectionName: 'books' });

const loadState = await client.getCollectionLoadState({
  collectionName: 'books',
});

const compaction = await client.compactCollection({
  collectionName: 'books',
});
```

## Data APIs

### insert

`insert(data, options?)`

Insert rows.

### upsert

`upsert(data, options?)`

Insert or update rows.

### get

`get(data, options?)`

Fetch rows by ID.

### query

```text
query(data: HttpVectorQueryReq, options?: FetchOptions): Promise<HttpVectorQueryResponse>
```

Pass `collectionName` and `outputFields`. Use `filter` to select rows or set a `limit` for an unfiltered query.

```ts
const { code, data } = await client.query({
  collectionName: 'books',
  outputFields: ['title'],
  limit: 5,
});
```

Returns a Milvus response envelope with matching rows.

[Try the REST operation](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/query/).

### search

```text
search(data: HttpVectorSearchReq | HttpVectorSearchByIdsReq, options?: FetchOptions): Promise<HttpVectorSearchResponse>
```

Pass `collectionName`, `outputFields`, and either a batch of search inputs in `data` or stored primary keys in `ids`. Specify `annsField` when the collection has multiple vector fields.

```ts
const { code, data } = await client.search({
  collectionName: 'books',
  data: [[0.1, 0.2, 0.3, 0.4]],
  annsField: 'vector',
  outputFields: ['title'],
  limit: 5,
});
```

Returns a Milvus response envelope with search hits with IDs, distances, and requested fields. The aggregation overload takes `HttpVectorSearchAggregationReq` and returns `HttpVectorSearchAggregationResponse` with buckets.

[Try the REST operation](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/search/).

### hybridSearch

`hybridSearch(data, options?)`

Hybrid search over multiple vector requests with reranking.

### delete

`delete(data, options?)`

Delete rows by filter.

### Filtering, ordering, and grouping

Use `exprParams` to bind filter placeholders such as `label in {labels}` in query, delete, search, or individual hybrid search requests. For query results, use `orderByFields` with keys such as `'price:desc'`. To group rows, pass scalar `groupByFields` and aggregation expressions such as `'count(*)'` in `outputFields`. These options were verified on Milvus 3.0.6.

REST `search()` accepts a batch of vectors or text in `data`, or searches using stored primary keys in `ids`. Pass large int64 primary keys as decimal strings. Use `orderByFields` for scalar ordering and `groupingField`, `groupSize`, and `strictGroupSize` for grouped search. Hybrid search also accepts the grouping options.

Use `functionChains` for REST search and hybrid reranking. A chain sends the protobuf stage name as a string such as `'FunctionChainStageL2Rerank'`, followed by its `ops`. In an expression argument, send a column as `{ column: '$score' }` or a JSON literal as `{ literal: 2 }`. Hybrid search accepts chains on the full request and on each sub-search. These options were verified on Milvus 3.0.6.

Pass `searchAggregation` to `search()` to return buckets for each query vector. Set `fields` and `size`, and use `metrics`, `order`, `topHits`, or `subAggregation` to customize the buckets. The response returns each query’s `buckets` in `data` and the corresponding counts in `aggTopks`. Int64 bucket values and counts are decimal strings with the default `acceptInt64: false`. Milvus 3.0.6 supports this option on vector search.

## Database APIs

### createDatabase

`createDatabase(data, options?)`

Create a database.

### dropDatabase

`dropDatabase(data, options?)`

Drop a database.

### describeDatabase

`describeDatabase(data, options?)`

Describe database metadata and properties.

### listDatabases

`listDatabases(options?)`

List databases.

### alterDatabaseProperties

`alterDatabaseProperties(data, options?)`

Add or update database properties.

### dropDatabaseProperties

`dropDatabaseProperties(data, options?)`

Remove database properties by key.

## Index APIs

### createIndex

`createIndex(data, options?)`

Create one or more indexes.

### dropIndex

`dropIndex(data, options?)`

Drop an index.

### describeIndex

`describeIndex(data, options?)`

Describe indexes.

### listIndexes

`listIndexes(data, options?)`

List index names.

### alterIndexProperties

`alterIndexProperties(data, options?)`

Add or update index properties.

### dropIndexProperties

`dropIndexProperties(data, options?)`

Remove index properties by key.

## Partition APIs

### listPartitions

`listPartitions(data, options?)`

List partitions.

### createPartition

`createPartition(data, options?)`

Create a partition.

### dropPartition

`dropPartition(data, options?)`

Drop a partition.

### loadPartitions

`loadPartitions(data, options?)`

Load partitions.

### releasePartitions

`releasePartitions(data, options?)`

Release partitions.

### hasPartition

`hasPartition(data, options?)`

Check whether a partition exists.

### getPartitionStatistics

`getPartitionStatistics(data, options?)`

Get partition statistics such as row count.

## Alias APIs

### listAliases

`listAliases(data, options?)`

List aliases in a database or collection.

### createAlias

`createAlias(data, options?)`

Create an alias for a collection.

### describeAlias

`describeAlias(data, options?)`

Describe an alias.

### alterAlias

`alterAlias(data, options?)`

Move an alias to another collection.

### dropAlias

`dropAlias(data, options?)`

Drop an alias.

## Import APIs

HTTP import APIs are separate from the gRPC `bulkInsert`, `getImportState`, and `listImportTasks` APIs.

### listImportJobs

`listImportJobs(data, options?)`

List REST import jobs for a collection.

### createImportJobs

`createImportJobs(data, options?)`

Create REST import jobs from staged files.

### getImportJobProgress

`getImportJobProgress(data, options?)`

Get progress for a REST import job.

### commitImportJob

`commitImportJob(data, options?)`

Commit an `Uncommitted` import job.

### abortImportJob

`abortImportJob(data, options?)`

Abort an import job before it commits.

### Import job example

```typescript
const job = await client.createImportJobs({
  collectionName: 'books',
  files: [['imports/books/part-0.parquet']],
});

const progress = await client.getImportJobProgress({
  jobId: job.data.jobId,
});
```

On Milvus 3.0.6, create a manual-commit job with `options: { auto_commit: 'false' }`. Poll `getImportJobProgress()` until the state is `Uncommitted`, then call `commitImportJob({ jobId })` to make the imported rows visible. To discard a staged import, call `abortImportJob({ jobId })` before committing. Poll the job again for its final state.

For Zilliz Cloud import workflows, include `projectId` and `regionId` when required by the cloud endpoint.

## Collection Schema Changes

These methods were verified on Milvus 3.0.6.

### addCollectionStructField

Add a nullable StructArray field using `schema`.

### dropCollectionField

Remove a field by `fieldName` or `fieldId`.

### addFunctionField

Add a function, its output field, and the bound index together.

### dropFunctionField

Remove a function together with its output field and index.

### alterCollectionFunction

Update supported settings for an existing function, such as a text embedding function’s description. Milvus 3.0.6 rejects BM25 function alterations.

### truncateCollection

Remove all rows while keeping the schema and indexes.

## External Collection Refresh

These methods were verified on Milvus 3.0.6.

### refreshExternalCollection

Submit a refresh for an external collection.

### getRefreshExternalCollectionProgress

Poll a refresh job. Pass the decimal job ID as returned by the SDK.

```typescript
const {
  data: { jobId },
} = await client.refreshExternalCollection({
  collectionName: 'external_books',
});
const { data } = await client.getRefreshExternalCollectionProgress({ jobId });
```

### listRefreshExternalCollectionJobs

List refresh jobs for a collection or database.

## Snapshot APIs

The SDK preserves snapshot job IDs, pin IDs, and int64 metadata as decimal strings. These methods were verified on Milvus 3.0.6.

### createSnapshot

Create a named snapshot of a collection.

### listSnapshots

List snapshot names and summary metadata for a collection.

### describeSnapshot

Read a named snapshot’s metadata and storage location.

### dropSnapshot

Delete a named collection snapshot.

### pinSnapshotData

Protect snapshot data for the requested lifetime and return a pin ID.

### unpinSnapshotData

Release protection using its pin ID.

### restoreSnapshot

Restore into a new collection. Omitted source and target database names default to the configured database.

### getRestoreSnapshotState

Get restore progress by job ID.

### listRestoreSnapshotJobs

List restore jobs for a collection or database.

### exportSnapshot

Copy a snapshot to an object storage destination and return a job ID.

```typescript
const {
  data: { jobId },
} = await client.exportSnapshot({
  collectionName: 'books',
  snapshotName: 'before_migration',
  targetS3Path: 'exports/books',
});
const { data } = await client.getExportSnapshotState({ jobId });
```

### getExportSnapshotState

Check export progress and retrieve `snapshotMetadataURI` when complete.

### restoreExternalSnapshot

Restore a portable snapshot using the exported `snapshotMetadataURI`.

## Resource Group APIs

These methods were verified on Milvus 3.0.6.

### createResourceGroup

Create a resource group with the requested node allocation.

### describeResourceGroup

Read the top-level `resource_group` object. The SDK returns query node IDs as decimal strings.

### listResourceGroups

List resource group names.

### dropResourceGroup

Drop a resource group.

### updateResourceGroups

Pass `{ resource_groups }` to update requests, limits, transfer preferences, and node labels.

### transferReplica

Transfer collection replicas in the default database with `sourceRgName`, `targetRgName`, `collectionName`, and `replicaNum`. The target group needs available query nodes.

## User and Role APIs

### createUser

`createUser(data, options?)`

Create a user.

### updateUserPassword

`updateUserPassword(data, options?)`

Update a user’s password.

### dropUser

`dropUser(data, options?)`

Drop a user.

### describeUser

`describeUser(data, options?)`

Describe user details.

### listUsers

`listUsers(options?)`

List users.

### grantRoleToUser

`grantRoleToUser(data, options?)`

Grant a role to a user.

### revokeRoleFromUser

`revokeRoleFromUser(data, options?)`

Revoke a role from a user.

### createRole

`createRole(data, options?)`

Create a role.

### alterRole

`alterRole(data, options?)`

Update the description of a role.

### dropRole

`dropRole(data, options?)`

Drop a role.

### describeRole

`describeRole(data, options?)`

Describe role privileges.

### listRoles

`listRoles(options?)`

List roles.

### grantPrivilegeToRole

`grantPrivilegeToRole(data, options?)`

Grant a privilege to a role.

### revokePrivilegeFromRole

`revokePrivilegeFromRole(data, options?)`

Revoke a privilege from a role.

### Role privilege example

```typescript
await client.grantPrivilegeToRole({
  roleName: 'reader',
  objectType: 'Collection',
  objectName: 'books',
  privilege: 'Search',
});
```

### grantPrivilegeV2

Grant a privilege or privilege group by `roleName`, `dbName`, `collectionName`, and `privilege`. Milvus requires authentication for v2 grants.

### revokePrivilegeV2

Revoke a v2 grant using the same scope and privilege fields.

### createPrivilegeGroup

Create a group by `privilegeGroupName`.

### addPrivilegesToGroup

Pass `privilegeGroupName` and a `privileges` array to add permissions.

### removePrivilegesFromGroup

Pass `privilegeGroupName` and a `privileges` array to remove permissions.

### listPrivilegeGroups

List privilege groups. The server returns each group’s privileges as a comma-separated string.

### dropPrivilegeGroup

Drop a group by `privilegeGroupName`.

## Analyzer and File Resource APIs

These methods were verified on Milvus 3.0.6.

### runAnalyzer

Use `{ text, analyzerParams }` to preview tokens for strings, or pass `collectionName` and `fieldName` to reuse a field’s analyzer. Set `withDetail` for offsets and positions or `withHash` for token hashes.

### addFileResource

Register `{ name, path }` for a file in the server’s storage.

### listFileResources

List file resource registrations. File resource IDs are returned as decimal strings.

### removeFileResource

Remove a registration by `name`.

## Diagnostics APIs

These methods were verified on Milvus 3.0.6.

### getSegmentsInfo

Pass `collectionID`, `segmentIDs`, or both to inspect segment state, row counts, and binlog IDs. Use decimal strings for large IDs. The SDK returns IDs and row counts as decimal strings.

### getQuotaMetrics

Inspect quota center metrics. The response’s `data` contains JSON text.

## Errors

Non-2xx responses throw `HttpError`. For HTTP success responses, inspect the Milvus response envelope. A `code` of `0` indicates success.

```typescript
try {
  await client.describeCollection({ collectionName: 'missing' });
} catch (error) {
  if (error instanceof HttpError) {
    console.error(error.status, error.statusText, error.url);
  }
}
```

Milvus 3.0.6 returns a top-level `resource_group` object on successful `describeResourceGroup()` calls. Handle that response shape directly.

## Related

- [HTTP Client guide](https://milvus-io.github.io/milvus-sdk-node/advanced/http-client/)
- [MilvusClient](https://milvus-io.github.io/milvus-sdk-node/api-reference/client/)
- [BulkWriter](https://milvus-io.github.io/milvus-sdk-node/api-reference/bulk-writer/)
