Zilliz 是一个用于操作 Zilliz Cloud 向量数据库的 CLI 技能,所有操作均通过 zilliz-cli 以 shell 命令方式执行。
用途 该技能面向需要通过命令行管理 Zilliz Cloud 的场景,包括集群、集合、向量、索引、数据库、分区、用户与角色、访问控制、备份、导入、计费、监控、项目与区域、PrivateLink 以及异步任务等资源域的管理。
前置检查 在任何操作之前,需按顺序完成以下检查:
- 安装或更新 CLI:curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash
- 检查登录状态:zilliz auth status;若未登录,引导用户在终端中登录
- 检查上下文(仅数据面操作需要):zilliz context current
注意:zilliz login、zilliz configure 和 zilliz auth switch 需要交互式输入,绝不能在非交互式 shell 中运行,应让用户在自己的终端中执行;绝不在聊天中索取 API 密钥。
命令模式 zilliz <resource> <action> --flag <value> [--optional-flag <value>] 所有命令支持 --output json|table|text(默认 text)。需要程序化解析时使用 --output json。
集群类型能力 不同集群类型支持的功能不同:
- 集合 CRUD 与向量操作:Free、Serverless、Dedicated 均支持
- 数据库创建/删除:仅 Dedicated 支持
- 用户/角色管理:Serverless 有限支持,Dedicated 支持
- 备份管理:Serverless、Dedicated 支持
- 集群修改(CU/副本):仅 Dedicated 支持 当命令因权限错误失败时,应先检查集群类型。
参考文件 每个参考文件覆盖一个资源域的完整命令语法、选项与指导,处理对应域时应阅读相关参考:
- 安装与认证:references/setup.md
- 集群:references/cluster.md
- 按需集群:references/on-demand-cluster.md
- 集合:references/collection.md
- 外部集合:references/external-collection.md
- 向量:references/vector.md
- 索引:references/index.md
- 数据库:references/database.md
- 分区:references/partition.md
- 用户与角色:references/user-role.md
- 访问控制:references/acl.md
- 备份:references/backup.md
- 导入:references/import.md
- 计费:references/billing.md
- 监控:references/monitoring.md
- 项目与区域:references/project-region.md
- PrivateLink:references/privatelink.md
- 任务:references/job.md
- 诊断:references/diagnose.md
快速开始工作流
- 安装 CLI:curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash
- 认证:用户在自己的终端运行 zilliz login
- 验证:zilliz auth status
- 列出集群:zilliz cluster list
- 设置上下文:zilliz context set --cluster-id <id>
- 验证:zilliz context current && zilliz collection list
常见工作流 创建集合并准备搜索:
- zilliz collection create --name <name> --dimension <dim>
- zilliz index create --collection <name>(推荐 AUTOINDEX)
- zilliz collection load --name <name>
- zilliz vector search --collection <name> --data '[[...]]'
状态概览:
- zilliz context current --output json
- zilliz cluster describe --cluster-id <id> --output json
- zilliz database list --output json
- 对每个数据库执行 collection list、get-stats、get-load-state、index list,并以格式化表格呈现。
异步操作 以下操作会立即返回 jobId,需通过 job describe 跟踪:
- cluster create:轮询 cluster describe --cluster-id <id> 直到 RUNNING
- backup create/export/restore-*:job describe --job-id <jid> 或 backup describe
- import start:job describe --job-id <jid>
- 任何带 jobId 的异步操作:job describe --job-id <jid> --wait
安全规则
- 破坏性操作前需确认:删除集合/数据库、删除集群/备份、删除用户/角色
- 敏感命令在用户终端执行:zilliz login、zilliz configure、zilliz billing bind-card
- 绝不在聊天或命令输出中暴露凭据
适用场景 适用于需要通过命令行管理 Zilliz Cloud 向量数据库的开发、运维与数据管理场景,包括集群生命周期管理、向量数据操作、索引与集合管理、备份与导入、监控与诊断等。
限制 部分功能受集群类型限制(如数据库创建/删除、集群修改仅 Dedicated 支持;用户/角色管理在 Serverless 上有限支持)。交互式命令不能在非交互式 shell 中运行。具体命令语法与选项需参考对应参考文件。