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

バックアップファイルをエクスポート (V2)

クラスタから、integration ID で指定されたストレージへバックアップファイルをエクスポートします。

POST/v2/clusters/{CLUSTER_ID}/backups/{BACKUP_ID}/export
接続エンドポイント

https://api.cloud.zilliz.com

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

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

値の例： Bearer {{TOKEN}}
CLUSTER_IDstringpath必要

バックアップ対象のクラスタの ID。

値の例： inxx-xxxxxxxxxxxxxxx
BACKUP_IDstringpath必要

対象のバックアップの ID。

値の例： backup-xxxxxxxxxxxxxxx
リクエスト・ボディapplication/json
integrationIdstring

バックアップファイルのエクスポート先となる、連携済み外部ストレージの ID。AWS S3 ブロックストレージサービスを Zilliz Cloud に統合する方法については、documentation を参照してください。integration ID の取得方法については、documentation を参照してください。

値の例： integ-xxxxxxxxxxxxxxxxxxx
directorystring

指定した外部ストレージ内で、バックアップファイルのエクスポート先となるディレクトリ。

値の例： destdir/
bash
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 "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "integrationId": "integ-xxxxxxx",
    "directory": "destdir/"
}'
レスポンス200 OK - application/json

レスポンス

codeinteger

レスポンスコード。

dataobject

バックアップファイルをエクスポートするために作成されたエクスポートジョブの ID を含むレスポンスペイロード。

jobIdstring

バックアップファイルをエクスポートするために作成されたエクスポートジョブの ID。

値の例： job_xxxxxxxxxxxxxxx

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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