Skip to main content

Describe Backup (V2)

List the information about the specified backup in detail. Note that this API only applies to dedicated clusters.

GET/v2/clusters/{CLUSTER_ID}/backups/{BACKUP_ID}
Connection Endpoint

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
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
export BACKUP_ID="backup-xxxxxxxxxxxxxxx"

curl --request GET \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/${BACKUP_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
Responses200 - application/json
codeinteger

Response code.

dataobject

Response payload which is the information about the backup in detail.

clusterIdstring

The ID of the cluster that holds the backup.

Example Value: inxx-xxxxxxxxxxxxxxx
clusterNamestring

The name of the cluster that holds the backup.

projectIdstring

The ID of the project that holds the backed-up cluster.

backupIdstring

The ID of the backup.

Example Value: Dedicated-01_backup3
backupNamestring

The name of the backup.

backupTypestring

The type of resources backed up.

creationMethodstring

Whether the backup was created manually or automatically.

statusstring

The current status of the backup.

sizeinteger

The size of the backup in bytes.

regionIdstring

The ID of the cloud region where the backup is located. The region should be bound to the project to which the specified cluster belongs.

expireTimestring

The expiration time of the backup.

dbCollectionsarray

A list of databases and its collections that are included in the backup.

[]dbCollectionsobject

A database and its collections that are included in the backup.

dbNamestring

The name of the database.

collectionsarray

The collections that are included in the backup.

[]collectionsobject

The collection information.

collectionNamestring

The name of the collection.

descriptionstring

The description of the collection.

statusstring

The loading status of the collection.

createTimestring

The time at which the backup was created.

restoreNewInstancePoliciesarray

The policies for restoring a new cluster from the backup. This field is only applicable to backups of the type CLUSTER.

[]restoreNewInstancePoliciesstring

The policy for restoring a new cluster from the backup. Possible values are:

  • LATEST: Restores the cluster to the latest compatible GA Milvus version available.
  • ORIGINAL: Restores the cluster to its original compatible Milvus version.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "clusterName": "Dedicated-01",
        "projectId": "proj-xxxxxxxxxxxxxxxxxxxx",
        "backupId": "backupx-xxxxxxxxxxxxxx",
        "backupName": "Dedicated-01_backup1",
        "backupType": "CLUSTER",
        "creationMethod": "MANUAL",
        "status": "AVAILABLE",
        "size": 112,
        "regionId": "aws-us-west-2",
        "expireTime": "2024-08-30T16:49:50Z",
        "collections": [
            {
                "collectionName": "medium_articles",
                "description": "Sample collection",
                "status": "LOADED"
            }
        ],
        "createTime": "2024-07-30T16:49:50Z",
        "restoreNewInstancePolicies": [
            "LATEST",
            "ORIGINAL"
        ]
    }
}