Create Volume (V2)

This operation creates a new volume in the specified project.

POST

/v2/volumes/create

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}}

Request Bodyapplication/json

projectIdstringrequired

The ID of the project to which the volume belongs.

Example Value: proj-xxxxxxxxxxxxxxxxxxxxxxx

regionIdstringrequired

The ID of the region where the volume will be created. You can use List Cloud Regions to list available regions.

volumeNamestringrequired

The name of the volume to create.

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/volumes/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxxx",
    "regionId": "aws-us-west-2",
    "volumeName": "my_volume"
}'

Responses200 - application/json

SUCCESS

Returns a list of volumes.

codeinteger

Response code.

dataobject

volumeNamestring

The name of the created volume.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

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