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

外部ボリューム

外部ボリュームは、ご自身のクラウドオブジェクトストレージ内のバケットまたはパス(AWS S3 など)への読み取り専用参照であり、Zilliz Cloud がデータをコピーまたは移動せずにその場でアクセスできるようにします。

このページでは、Web コンソールと SDK を使用して外部ボリュームを作成および削除する方法について説明します。

考慮事項​

  • ボリュームは、プロジェクトのクラウドプロバイダーとリージョンに制限されます。たとえば、プロジェクトが AWS us-west-2 にある場合、ボリュームは AWS us-west-2 にのみ作成できます。

  • ボリュームをクラスターで使用するには、クラスターがボリュームと同じクラウドプロバイダーおよびリージョンにある必要があります。

  • ボリュームを作成および管理するには、Project Admin である必要があります。

  • 作成後にボリュームの構成を編集することはできません。ボリューム設定を変更する場合は、希望する設定で新しいボリュームを作成してください。

  • 外部ボリュームの場合、データはバケットに保持されます。そのため、データファイルは外部ボリューム上ではなく、クラウドオブジェクトストレージで管理する必要があります。

  • 各組織は最大 100 個の外部ボリューム を作成できます。

事前準備​

外部ボリュームを作成する前に、Amazon S3 バケット を統合する必要があります。ストレージ統合は、作成する外部ボリュームと同じクラウドプロバイダーおよびリージョンにある必要があることに注意してください。

外部ボリュームを作成する​

  • SDK を使用する

    python
    from pymilvus.bulk_writer.volume_manager import VolumeManager

    # Initiate a volume manager

    volume_manager = VolumeManager(
    cloud_endpoint="https://api.cloud.zilliz.com",
    api_key="YOUR_API_KEY"
    )

    volume_name = "external_volume"

    # Create an EXTERNAL volume
    volume_manager.create_volume(
    project_id="proj-xxxxxxxxxxxxxxxxxxxxxxx",
    region_id="aws-us-west-2",
    volume_name=volume_name,
    volume_type="EXTERNAL",
    storage_integration_id="integ-xxxx",
    path="data/"
    )

    print(f"\nVolume {volume_name} created")

    # Note: description is not supported by VolumeManager.create_volume as of pymilvus v3.0.2.

    次の表に、パラメーターの説明を示します。

    パラメーター説明
    projectIdボリュームを作成するプロジェクトの ID です。
    regionId作成するボリュームのリージョンは、データのインポートまたは移行先となるターゲットクラスターのクラウドプロバイダーおよびリージョンと一致する必要があります。
    volumeName作成するボリュームの名前は組織全体で一意である必要があり、64 文字以下で、英字またはアンダースコアで始まり、英字、数字、ハイフン、アンダースコアのみを含む必要があります。
    type外部ボリュームを作成するには、このパラメーターを EXTERNAL に設定します。デフォルトは MANAGED です。
    storageIntegrationId参照するストレージ統合の ID です。type=EXTERNAL の場合に必須です。選択するストレージ統合は、作成する外部ボリュームと同じ組織およびリージョンに属している必要があります。
    pathストレージパスです。type=EXTERNAL の場合に必須です。
    description(オプション)作成するボリュームの説明です。最大 255 文字です。
  • Web コンソールを使用する

    1

    左側のナビゲーションで Volumes をクリックします。

    2

    ボリュームページで + Volume をクリックします。

    3

    ボリュームの構成を設定します。

    次の表に、外部ボリュームを作成するときに使用する各パラメーターの説明を示します。

    パラメーター説明
    名前ボリューム名は組織全体で一意である必要があり、64 文字以下で、英字またはアンダースコアで始まり、英字、数字、ハイフン、アンダースコアのみを含む必要があります。
    説明このパラメーターはオプションです。最大 255 文字です。
    ボリュームタイプボリュームタイプとして「External」を選択します。
    クラウドプロバイダーとリージョンボリュームのクラウドプロバイダーおよびリージョンは、データのインポートまたは移行先となるターゲットクラスターのクラウドプロバイダーおよびリージョンと一致する必要があります。
    ストレージ統合とパスストレージ統合(Amazon S3 バケット)は、クラウドストレージのアクセス構成をカプセル化する認証情報オブジェクトです。
    パスは、データが配置されている場所を指すポインターです(例: folder/)。
    4

    Create をクリックします。

ボリュームを一覧表示する​

プロジェクト内の既存のボリュームをすべて表示できます。

  • SDK を使用する

    python
    # Initiate a volume manager

    volume_manager = VolumeManager(
    cloud_endpoint="https://api.cloud.zilliz.com",
    api_key="YOUR_API_KEY"
    )

    # List volumes
    volume_list = volume_manager.list_volumes(
    project_id="proj-xxxxxxxxxxxxxxxxxxxxxxx",
    current_page=1,
    page_size=10
    )

    print("\nlistVolumes results:\n", volume_list.json()["data"])
  • Web コンソールを使用する

    PeL0wrKF1hTHvwbNAZBctTQonZf

    1

    左側のナビゲーションペインで Volumes をクリックします。

    2

    プロジェクト内の既存のボリュームをすべて表示します。

外部ボリュームを詳細表示する​

特定のボリュームの詳細を確認できます。

  • SDK を使用する

    python
    # Initiate a volume manager

    volume_manager = VolumeManager(
    cloud_endpoint="https://api.cloud.zilliz.com",
    api_key="YOUR_API_KEY"
    )

    volume_name = "external_volume"

    # Describe an external volume
    volume_info = volume_manager.describe_volume(
    volume_name=volume_name
    )

    print("\ndescribeVolume result:\n", volume_info.json()["data"])
  • Web コンソールを使用する

    NrgXwPhxGhq78NbBfDYcWc6Ened

    1

    左側のナビゲーションペインで Volumes をクリックします。

    2

    対象のボリュームをクリックし、Overview タブに切り替えます。

    3

    ボリュームの詳細を表示します。

外部ボリュームを削除する​

外部ボリュームが不要になった場合は、いつでも削除できます。

外部ボリュームを削除すると、Zilliz Cloud からボリュームのメタデータのみが削除されます。データはクラウドオブジェクトストレージ内にそのまま保持されます。

  • SDK を使用する

    python
    # Initiate a volume manager

    volume_manager = VolumeManager(
    cloud_endpoint="https://api.cloud.zilliz.com",
    api_key="YOUR_API_KEY"
    )

    volume_name = "external_volume"

    # Delete an external volume
    volume_manager.delete_volume(
    volume_name=volume_name
    )

    print(f"\nVolume {volume_name} deleted")
  • Web コンソールを使用する

    1

    左側のナビゲーションで Volumes をクリックします。

    2

    Actions 列の ... をクリックし、Delete を選択します。

    3

    ボリューム名を入力し、Delete をクリックします。

FAQ​

請求書の支払い遅延により組織が凍結された場合、ボリュームはどうなりますか?

組織が凍結されると、すべてのマネージドボリューム(無料トライアルおよび従量課金)と、それらに保存されているすべてのファイルが削除され、復元できなくなります。外部ボリュームも凍結され、新しい操作には使用できませんが、ご自身のバケット内のデータは影響を受けません。

ボリュームを引き続き使用するには、まず未払いの請求書をすべて決済してください。

外部ボリュームと外部ストレージからの直接インポートの違いは何ですか?

どちらも、ご自身の S3 または GCS バケットからデータをインポートできます。主な違いは次のとおりです。

  • 外部ボリュームでは、認証情報管理のために Amazon S3 バケット を Zilliz Cloud と統合する必要があります。認証情報は一度設定すると、複数のボリュームや操作で再利用されます。データエンジニアは、クラウドストレージのキーに直接アクセスする必要はありません。

  • 直接の 外部ストレージインポート では、インポートリクエストごとに認証情報(アクセスキーとシークレットキー)を指定する必要があります。これは 1 回限りのインポートには簡単ですが、認証情報の分離や再利用はできません。

外部ボリュームの作成後に、ストレージ統合またはパスを変更できますか?

いいえ。外部ボリュームの作成後に、ストレージ統合とパスを変更することはできません。別のストレージ統合またはパスを使用するには、新しい外部ボリュームを作成してください。

アクティブなジョブまたは外部コレクションから参照されている外部ボリュームを削除できますか?

いいえ。ダウンストリームの外部コレクションまたはアクティブなジョブがボリュームを参照している場合、削除はブロックされます。

外部ボリュームを使用すると、データ転送料金が発生しますか?

いいえ。外部ボリュームは、クラスターと同じクラウドプロバイダーおよびリージョンにある必要があります。すべてのデータアクセスは同じリージョン内で行われるため、Zilliz Cloud ではリージョン間のデータ転送料金は発生しません。

ボリュームのステータスにはどのような意味がありますか?

次の表に、考えられるボリュームのステータスを示します。

ステータス

説明

Available

ボリュームはアクティブで、使用可能です。

Frozen

請求書の支払い遅延により組織が凍結されています。ボリュームは新しい操作には使用できません。ボリュームを引き続き使用するには、請求書をお支払いください。

Error

ストレージ統合の検証に失敗しました。構成を確認して、再試行してください。

適用可能なストレージ統合は次のとおりです。