zilliz

Zilliz Cloud CLI スキル

zilliz-cli を使用して Zilliz Cloud を操作します。すべての操作はシェルコマンドで実行します。

前提条件の確認（必ず最初に実行）

操作を行う前に、次の順に確認します。

# 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 は対話形式の入力が必要です。非対話型シェルでは絶対に実行しないでください。ユーザーには自分のターミナルで実行するよう案内してください。チャットで API キーを尋ねることは絶対にしないでください。

コマンドの形式

zilliz <resource> <action> --flag <value> [--optional-flag <value>]

すべてのコマンドは --output json|table|text（デフォルト：text）に対応しています。プログラムで解析する場合は --output json を使用してください。

クラスタタイプごとの機能

機能	Free	Serverless	Dedicated
コレクションの CRUD とベクトル操作	Yes	Yes	Yes
データベースの作成／削除	No	No	Yes
ユーザー／ロール管理	No	Limited	Yes
バックアップ管理	No	Yes	Yes
クラスタの変更（CU／レプリカ）	No	No	Yes

コマンドで権限エラーが発生した場合は、まずクラスタタイプを確認してください。

リファレンスファイル

各リファレンスでは、1 つのリソースドメインに関するコマンド構文、オプション、ガイダンスを網羅しています。そのドメインを扱う際は、該当するリファレンスを参照してください。

ドメイン	リファレンス	参照するタイミング
セットアップと認証	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. 各 DB について：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
• チャットやコマンド出力に認証情報を決して表示しない