API Availability
Zilliz Cloud operates slightly differently from Milvus in order to provide a better user experience. This article aims to clarify the differences between the two platforms in terms of APIs.
If you are planning to migrate from Milvus to Zilliz Cloud, you may need to make some necessary changes to your legacy code.
Scenario-specific privileges
The table below provides a comparison of API availability across various service tiers. Note that the availability of the API for the Bring Your Own Cloud (BYOC) solution is consistent with that of the Standard and Enterprise tiers.
| Category | API | Console | Free | Serverless | Dedicated |
|---|---|---|---|---|---|
| Alias | alterAlias() | ✘ | ✔︎ | ✔︎ | ✔︎ |
| createAlias() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| dropAlias() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| describeAlias() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| listAliases() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| Authentication | createCredential() | ✔︎ | ✘ | ✘ | ✔︎ |
| deleteCredential() | ✔︎ | ✘ | ✘ | ✔︎ | |
| listCredUsers() | ✔︎ | ✘ | ✘ | ✔︎ | |
| updateCredential() | ✔︎ | ✘ | ✘ | ✔︎ | |
| BulkInsert | bulkInsert() | ✔︎ | ✘ | ✘ | ✘ |
| getBulkInsertState() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| listBulkInsertTasks() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| Collection | getCollectionStatistics() | ✘ | ✔︎ | ✔︎ | ✔︎ |
| createCollection() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| describeCollection() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| dropCollection() | ✔︎ | ✔︎ | ✔︎ | ✔ ︎ | |
| alterCollection() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| getLoadingProgress() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| getPersistentSgementInfo() | ✘ | ✘ | ✘ | ✘ | |
| getQuerySegmentInfo() | ✘ | ✘ | ✘ | ✘ | |
| getReplicas() | ✘ | ✘ | ✘ | ✘ | |
| insert() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| loadCollection() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| releaseCollection() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| showCollections() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| getLoadState() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| renameCollection() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| upsert() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| Database | ListDatabases | ✘ | ✘ | ✘ | ✘ |
| DropDatabase | ✘ | ✘ | ✘ | ✘ | |
| CreateDatabase | ✘ | ✘ | ✘ | ✘ | |
| Index | createIndex() | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
| describeIndex() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| dropIndex() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| getIndexBuildProgress() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| getIndexState() | ✔︎ | ✔︎ | ✔︎ | ✔︎ | |
| Management | getCompactionState() | ✘ | ✔︎ | ✔︎ | ✔︎ |
| getCompactionStateWithPlan() | ✘ | ✔ ︎ | ✔︎ | ✔︎ | |
| getFlushState() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| getMetrics() | ✘ | ✘ | ✘ | ✘ | |
| loadBalance() | ✘ | ✘ | ✘ | ✘ | |
| manualCompact() | ✘ | ✘ | ✘ | ✔︎ | |
| Partition | createPartition() | ✘ | ✔︎ | ✔︎ | ✔︎ |
| dropPartition() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| getPartitionStatistics() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| hasPartiotion() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| loadPartitions() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| releasePartitions() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| showPartitions() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| Search & Query | search() | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
| query() | ✘ | ✔︎ | ✔︎ | ✔︎ | |
| Role-based access control (RBAC) | addUserToRole() | ✔︎ | ✘ | ✘ | ✔︎ |
| createRole() | ✘ | ✘ | ✘ | ✘ | |
| dropRole() | ✘ | ✘ | ✘ | ✘ | |
| grantRolePrivilege() | ✘ | ✘ | ✘ | ✘ | |
| removeUserFromRole() | ✔︎ | ✘ | ✘ | ✔︎ | |
| revokeRolePrivilege() | ✘ | ✘ | ✘ | ✘ | |
| selectGrantForRole() | ✘ | ✘ | ✘ | ✔︎ | |
| selectGrantForRoleAndObject() | ✘ | ✘ | ✘ | ✔︎ | |
| selectRole() | ✘ | ✘ | ✘ | ✔︎ | |
| selectUser() | ✘ | ✘ | ✘ | ✔︎ | |
| System | getVersion() | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
| checkHealth() | ✘ | ✔︎ | ✔︎ | ✔︎ |