メインコンテンツまでスキップ

スナップショットのエクスポート (V2)

コレクションのスナップショットを、設定済みのオブジェクトストレージにエクスポートします。

POST/v2/vectordb/jobs/snapshot/export
接続エンドポイント

https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

📘ノート
  • サービングクラスターを使用している場合は、クラスターエンドポイントを使用してください。

    • Free & Serverless

      https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

    • Dedicated

      https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

shell
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
パラメータ
Authorizationstringheader

認証トークンは、適切な権限を持つ API key である必要があります。

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
dbNamestring

コレクションを含むデータベースの名前。

collectionNamestring必要

スナップショットを作成するコレクションの名前。

snapshotNamestring必要

スナップショットの名前。

targetS3Pathstring必要

Milvus がエクスポートしたスナップショットデータとメタデータを書き込む、S3 互換オブジェクトストレージ内のルートパス。s3://bucket-name/export-root のような書き込み可能な URI である必要があります。Milvus はこのルートの下にスナップショット固有のメタデータパスを追加します。レスポンスでは、生成された snapshotMetadataURI が返されます。

externalSpecstring

外部オブジェクトストレージ用のオプションの JSON 設定。targetS3Path が Milvus 管理バケットの外部のストレージを指す場合は、extfs オブジェクトを渡して、Milvus がそのバケットにアクセスする方法を上書きします。サポートされている JSON フィールド:

  • format: "parquet"、"lance-table"、または "vortex"。省略時または値全体が空の場合は "parquet" がデフォルトです。
  • columns: 読み込むカラム名のオプションの配列。
  • extfs: オブジェクトストレージの上書き設定のオプションのマップ。許可されるキーは cloud_provider、region、use_iam、use_ssl、use_virtual_host、iam_endpoint、storage_type、ssl_ca_cert、access_key_id、access_key_value です。

要件:

  • 値は有効な JSON である必要があります。
  • format は上記のサポート対象の値のいずれかである必要があります。
  • extfs のキーは許可リスト方式です。サポートされていないキーは拒否されます。
  • use_iam、use_ssl、use_virtual_host は文字列の "true" または "false" である必要があります。
  • extfs は、ターゲットバケットが Milvus 管理バケットとは異なる資格情報または接続設定を必要とする場合にのみ使用してください。externalSpec を省略するか空文字列を渡すと、デフォルトの Milvus 管理ストレージが使用されます。

例: {"format":"parquet","extfs":{"cloud_provider":"aws","region":"us-west-2","use_iam":"true"}}。

bash
export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/jobs/snapshot/export" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "default",
    "collectionName": "my_collection",
    "snapshotName": "snapshot_2026_01",
    "targetS3Path": "s3://bucket-name/export-root",
    "externalSpec": ""
}'
レスポンス200 OK - application/json

コレクションのスナップショットを、設定済みのオブジェクトストレージにエクスポートします。

codeinteger必要

レスポンスコード。

dataobject必要
snapshotMetadataURIstring必要

エクスポートされたスナップショットメタデータのオブジェクトストレージ URI。

codeinteger必要

レスポンスコード。

messagestring必要

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "snapshotMetadataURI": "s3://bucket/snapshots/snapshot_2026_01"
    }
}
Ctrl I