查看备份详情

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}

Base URL

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com

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

参数

Authorizationstringheaderrequired

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

示例值：Bearer {{TOKEN}}

CLUSTER_IDstringpathrequired

The ID of the cluster whose backup is in concern.

示例值：inxx-xxxxxxxxxxxxxxx

BACKUP_IDstringpathrequired

The ID of the backup in concern.

示例值：Dedicated-01_backup3

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
export BACKUP_ID="Dedicated-01_backup3"

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

响应200 - application/json

SUCCESS

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.

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

示例值：Dedicated-01_backup3

backupNamestring

The name of the backup.

backupTypestring

The type of resources backed up.

枚举值：

CLUSTERCOLLECTION

creationMethodstring

Whether the backup was created manually or automatically.

枚举值：

MANUALAUTO

statusstring

The current status of the backup.

枚举值：

CREATINGAVAILABLEDELETED

sizeinteger

The size of the backup in bytes.

regionIdstring

The ID of the cloud region where the backup is located.

expireTimestring

The expiration time of the backup.

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.

枚举值：

LOADEDUNLOADED

createTimestring

The time at which the backup was created.

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "clusterId": "in01-31a6b840e50b72d",
        "clusterName": "Dediacted-01",
        "projectId": "proj-b44a39b0c51cf21791a841",
        "backupId": "backup0_1e3c0988ecb7f0d",
        "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"
    }
}