查看 Volume 列表 (V2)

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

GET

/v2/volumes

集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

📘说明

• 你需要填入您的 Zilliz Cloud 集群的 ${CLUSTER_ENDPOINT}。
• 您可以使用 查看集群详情 V2 来获取集群的 Endpoint.

export CLUSTER_ENDPOINT=""

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。

示例值：Bearer {{TOKEN}}

projectIdstringqueryrequired

当前操作的目标项目。

示例值：proj-xxxxxxxxxxxxxxxxx

pageSizeintegerquery

每次返回的记录数。

示例值：10

currentPageintegerquery

当前页码。

示例值：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"

响应200 - application/json

SUCCESS

返回 Volume 列表。

codeinteger

响应码。

dataobject

countinteger

Volume 总数。

currentPageinteger

当前页码。

pageSizeinteger

每页记录数。

volumesarray

Volume 列表。

[]volumesobject

volumeNamestring

Volume 名称。

FAILURE

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

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