メインコンテンツまでスキップ

バックアップを一覧表示 (V2)

List all AVAILABLE or CREATING backups. Note that this API only applies to dedicated clusters.

GET/v2/backups
接続エンドポイント

https://api.cloud.zilliz.com

shell
export BASE_URL="https://api.cloud.zilliz.com"
パラメータ
Authorizationstringheader必要

認証トークンには、適切な権限を持つ API key を使用する必要があります。

値の例： Bearer {{TOKEN}}
projectIdstringquery

バックアップが属するプロジェクトの ID。

clusterIdstringquery

バックアップが属するクラスターの ID。

creationMethodstringquery

バックアップが手動で作成されたものか、自動で作成されたものかを指定します。

backupTypestringquery

バックアップファイルに含まれるリソースの種類。

startstringquery

Zilliz Cloud がこのバックアップの作成を開始する時刻。

endstringquery

Zilliz Cloud がこのバックアップの作成を完了する時刻。

pageSizeintegerquery

1 ページあたりに表示するレコード数。

currentPageintegerquery

表示するページ番号。

bash
export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/backups" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json

レスポンス

codeinteger

レスポンスコード。

dataobject

バックアップのリストを含むレスポンスペイロード。

countinteger

返されるバックアップの総数。

currentPageinteger

現在のページ番号。

pageSizeinteger

1 ページあたりのレコード数。

backupsarray

バックアップのリスト。

[]backupsobject

バックアップの詳細情報。

projectIdstring

バックアップを保持するプロジェクトの ID。

backupIdstring

バックアップの ID。

backupNamestring

バックアップの名前。

backupTypestring

バックアップに含まれるリソースの種類。

creationMethodstring

バックアップが手動で作成されたものか、自動で作成されたものかを示します。

sizeinteger

バックアップのサイズ（バイト単位）。

expireTimestring

バックアップが自動的に削除される時刻。

clusterIdstring

データがバックアップされたクラスターの ID。

clusterNamestring

データがバックアップされたクラスターの名前。

createTimestring

クラスターが作成された時刻。

statusstring

バックアップのステータス。

restoreNewInstancePoliciesarray

バックアップから新しいクラスターを復元するためのポリシー。このフィールドは、タイプが CLUSTER のバックアップにのみ適用されます。

[]restoreNewInstancePoliciesstring

バックアップから新しいクラスターを復元するためのポリシー。指定可能な値は次のとおりです:

  • LATEST: クラスターを、利用可能な最新の互換性のある GA Milvus version に復元します。
  • ORIGINAL: クラスターを元の互換性のある Milvus version に復元します。

エラーメッセージを返します。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "count": 1,
        "currentPage": 1,
        "pageSize": 10,
        "backups": [
            {
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxx",
                "backupId": "backupx_xxxxxxxxxxxxxxxx",
                "backupName": "Dedicated-01_backup1",
                "backupType": "CLUSTER",
                "creationMethod": "AUTO",
                "size": 112,
                "expireTime": "2024-08-30T16:49:50Z",
                "clusterId": "inxx-xxxxxxxxxxxxxx",
                "clusterName": "Dedicated-01",
                "createTime": "2024-07-30T16:49:50Z",
                "status": "AVAILABLE",
                "restoreNewInstancePolicies": [
                    "LATEST",
                    "ORIGINAL"
                ]
            }
        ]
    }
}
Ctrl I