跳到主要内容

list_volumes()

此操作以分页方式列出项目下的卷。

请求语法​

python
list_volumes(
project_id: str,
current_page: int = 1,
page_size: int = 10,
volume_type: Optional[str] = None,
) -> requests.Response

参数:

  • project_id (str) -
    [必需]
    要列出卷的Zilliz Cloud项目 ID。

  • current_page (int) -
    默认值:1
    要返回的页码(从 1 开始)。

  • page_size (int) -
    默认值:10
    每页返回的最大卷数量。

  • volume_type (Optional[str]) -
    默认值:None
    用于过滤结果的卷类型。支持的值为 MANAGED 和 EXTERNAL。

返回类型:

requests.Response

返回值:

包含该项目单页卷列表的 HTTP 响应。

异常:

  • MilvusException
    当服务器拒绝请求或 RPC 失败时抛出。请查看服务器错误消息以获取具体的失败详情。

示例​

以下示例演示了 list volumes 的用法。

python
from pymilvus.bulk_writer import VolumeFileManager, VolumeManager

manager = VolumeManager(cloud_endpoint="https://api.cloud.zilliz.com", api_key="YOUR_API_KEY")
manager.create_volume(project_id="proj-xxxx", region_id="aws-us-west-2", volume_name="book-volume", volume_type="EXTERNAL")
manager.describe_volume("book-volume")
manager.list_volumes(project_id="proj-xxxx", volume_type="EXTERNAL")

file_manager = VolumeFileManager(cloud_endpoint="https://api.cloud.zilliz.com", api_key="YOUR_API_KEY", volume_name="book-volume")
file_manager.upload_file_to_volume(source_file_path="./data/books.parquet", target_volume_path="datasets/books/books.parquet", upload_concurrency=4)