[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

describe_volume()

This function retrieves detailed metadata for a specific volume.

Request Syntax

volume_manager.describe_volume(
    volume_name: str,
)

PARAMETERS:

• volume_name (str) -

  The name of the volume to describe.

RETURN TYPE: requests.Response

Returns volume details, including status and storage configuration.

EXCEPTIONS:

An object with the following data structure:

{
    "count": 1,
    "currentPage": 1,
    "pageSize": 10,
    "volumes": [
        {
            "volumeName": "my_volume",
            "type": "EXTERNAL",
            "regionId": "aws-us-west-2",
            "storageIntegrationId": "integ-xxx",
            "path": "data/",
            "status": "RUNNING",
            "createTime": "2024-04-15T12:00:00Z"
        }        
    ]
}

PARAMETERS

• MilvusException

  The total number of volumes found.

• currentPage (int) -

  The current page.

• pageSize (int) -

  The maximum number of volumes per page.

• volumes (list) -

  A volume list.

  • volumeName (str) -

    The name of a volume.

  • type (str) -

    The type of a volume. Possible values are EXTERNAL and MANAGED.

  • regionId (str) -

    The region to which the volume belongs.

  • storageIntegrationId (str) -

    The ID of the integrated storage from which the volume is created. This is available only when the volume is external.

  • path (str) -

    The path in the integrated storage from which the volume is created. This is available only when the volume is external.

  • status (str) -

    The name of a volume.

    The status of the current volume.

  • createTime (str) -

    The time at which the volume is created.

Examples

from pymilvus.bulk_writer import VolumeManager

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

resp = volume_manager.describe_volume(volume_name="books-volume")
print(resp.json())