Skip to main content

Export Backup Files

Export the backup files from a cluster to storage specified by an integration ID.

POST
/v2/clusters/{CLUSTER_ID}/backups/{BACKUP_ID}/export
Base URL

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

https://api.cloud.zilliz.com

📘Notes

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

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

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
CLUSTER_IDstringpathrequired

The ID of the cluster that needs to be backed up.

Example Value: inxx-xxxxxxxxxxxxxxx
BACKUP_IDstringpathrequired

The ID of the backup in concern.

Example Value: backup-xxxxxxxxxxxxxxx
Request Bodyapplication/json
integrationIdstring

The ID of the integrated external storage that the backup files will be exported to. For how to integrate an AWS S3 block storage service into Zilliz Cloud, refer to the documentation. For how to obtain the integration ID, refer to the documentation.

Example Value: integ-xxxxxxxxxxxxxxxxxxx
directorystring

The directory in the specified external storage where the backup files will be exported to.

Example Value: destdir/
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
export BACKUP_ID="backup-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/${BACKUP_ID}/export" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "integrationId": "integ-xxxxxxx",
    "directory": "destdir/"
}'
Responses200 - application/json
codeinteger

Response code.

dataobject

Response payload which is the ID of the export job created to export the backup files.

jobIdstring

The ID of the export job created to export the backup files.

Example Value: job_xxxxxxxxxxxxxxx

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "jobId": "job-0396450098cglufig6afm9"
    }
}