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

List Volumes (V2)

This operation lists all volumes in the specified project. You need to be

GET

/v2/volumes

Cluster Endpoint

The base URL for this API is in the following format:

https://${CLUSTER_ENDPOINT}

📘Notes

• You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
• To get the endpoint, use the Describe Cluster V2 API to extract the values from the responses.

export CLUSTER_ENDPOINT=""

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}

projectIdstringqueryrequired

The target project of this operation.

Example Value: proj-xxxxxxxxxxxxxxxxx

pageSizeintegerquery

The number of records to include in each response.

Example Value: 10

currentPageintegerquery

The current page number.

Example Value: 1

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request GET \
--url "${CLUSTER_ENDPOINT}/v2/volumes?projectId=proj-xxxxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

Responses200 - application/json

SUCCESS

Returns a list of volumes.

codeinteger

Response code.

dataobject

countinteger

The total number of volumes.

currentPageinteger

The current page number.

pageSizeinteger

The number of records in each response.

volumesarray

The list of volumes.

[]volumesobject

volumeNamestring

The name of the volume.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 200,
    "data": {
        "count": 3,
        "currentPage": 1,
        "pageSize": 10,
        "volumes": [
            {
                "volumeName": "my_volume_1"
            },
            {
                "volumeName": "my_volume_2"
            },
            {
                "volumeName": "my_volume_3"
            }
        ]
    }
}