创建 Volume (V2)

This operation creates a new volume in the specified project.

POST/v2/volumes/create

连接端点

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com.cn

📘说明

控制面接口速率限制为单用户单接口每秒最多 20 个请求。

export BASE_URL="https://api.cloud.zilliz.com.cn"

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥。

示例值：Bearer {{TOKEN}}

请求体application/json

projectIdstring必填项

所属项目的 ID。

示例值：proj-xxxxxxxxxxxxxxxxxxxxxxx

regionIdstring必填项

Volume 所属区域的 ID。您可以使用 查看云服务区域 接口列出可用区域。该区域应与指定项目绑定。

volumeNamestring必填项

Volume 名称。

typestring

Volume 的类别。有效值为 MANAGED 和 EXTERNAL。默认值为 MANAGED。

storageIntegrationIdstring

存储集成 ID。当 type 为 EXTERNAL 时必填。

pathstring

存储卷内的路径前缀。当 type 为 EXTERNAL 时必填。

MANAGED VOLUME

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/volumes/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxxx",
    "regionId": "ali-cn-hangzhou",
    "volumeName": "my_volume"
}'

EXTERNAL VOLUME

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/volumes/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxxx",
    "regionId": "ali-cn-hangzhou",
    "volumeName": "my_external_volume",
    "type": "EXTERNAL",
    "storageIntegrationId": "integ-xxxxxxxxxxxxxxxxxxx",
    "path": "data/"
}'

响应200 - application/json

SUCCESS

返回已创建的 Volume 名称。

codeinteger

响应码。

dataobject

volumeNamestring

已创建的 Volume 名称。

FAILURE

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "volumeName": "my_volume"
    }
}