zilliz

Zilliz Cloud CLI 技能

通过 zilliz-cli 操作 Zilliz Cloud。所有操作都通过 shell 命令执行。

前置条件检查（始终先运行）

执行任何操作前，请按顺序验证：

# 1. Install or update the CLI
curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash

# 2. Logged in? If not: guide user to login in their terminal
zilliz auth status

# 3. Context set? (only for data-plane ops)
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。

集群类型功能

功能	Free	Serverless	Dedicated
Collection CRUD 和向量操作	是	是	是
创建/删除数据库	否	否	是
用户/角色管理	否	有限	是
备份管理	否	是	是
修改集群（CU/副本）	否	否	是

命令因权限错误而失败时，请先检查集群类型。

参考文件

每份参考文件都涵盖一个资源领域，包含完整的命令语法、选项和指南。处理相应领域时，请阅读相关参考文件：

领域	参考文件	阅读时机
设置与身份验证	references/setup.md	安装、登录、上下文、配置、故障排查
集群	references/cluster.md	创建、列出、描述、修改、暂停、恢复、删除集群；创建 Vector Lake
按需集群	references/on-demand-cluster.md	创建、列出、描述、删除带自动暂停 TTL 的按需（Vector Lake）集群
集合	references/collection.md	创建、列出、描述、删除、重命名、加载、释放集合；别名、单集合指标
外部集合	references/external-collection.md	触发、描述、列出由 Vector Lake 支持的集合的刷新作业
向量	references/vector.md	搜索、查询、插入、更新或插入、获取、删除向量；混合搜索、筛选器
索引	references/index.md	创建、列出、描述、删除索引
数据库	references/database.md	创建、列出、描述、删除数据库
分区	references/partition.md	创建、列出、加载、释放、删除分区
用户与角色	references/user-role.md	RBAC：用户、角色、权限（仅 Dedicated）
访问控制	references/acl.md	云级 RBAC：自定义组织/项目角色、策略、成员和 SCIM 群组授权
备份	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	对集群和集合进行只读健康诊断（运行缓慢、卡住、错误、配额）

快速入门工作流

对于新用户，请按顺序引导完成设置：

1. 安装 CLI：curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash
2. 身份验证：用户在终端中运行 zilliz login
3. 验证：zilliz auth status
4. 列出集群：zilliz cluster list
5. 设置上下文：zilliz context set --cluster-id <id>
6. 验证：zilliz context current && zilliz collection list

常见工作流

创建集合并为搜索做好准备：

1. zilliz collection create --name <name> --dimension <dim> — 创建
2. zilliz index create --collection <name> — 创建索引（建议使用 AUTOINDEX）
3. zilliz collection load --name <name> — 加载到内存
4. zilliz vector search --collection <name> --data '[[...]]' — 搜索

状态概览（请阅读 references/monitoring.md）：

1. zilliz context current --output json
2. zilliz cluster describe --cluster-id <id> --output json
3. zilliz database list --output json
4. 对每个数据库：collection list、get-stats、get-load-state、index list
5. 以格式化表格呈现

异步操作

这些操作会立即返回 jobId；使用 job describe 跟踪（请参阅 references/job.md）：

操作	轮询命令
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
• 绝不在聊天或命令输出中泄露凭据