ワークスペースリソースエクスポート¶

POST /api/v1/workspace/resource/export/task/create

概要¶

ワークスペースリソースのエクスポートタスクを開始します。

パラメータ補足説明¶

1. インターフェースの用途

現在のワークスペースのリソースエクスポートタスクを開始します。

このインターフェースは非同期タスクインターフェースであり、呼び出し成功後は taskId のみが返され、圧縮パッケージの内容はすぐには返されません。

呼び出しフローの推奨手順は以下のとおりです。

1. 対象のインターフェースを呼び出し、taskId を取得します
2. GET /api/v1/workspace/resource/query_action_status を呼び出してタスクステータスをポーリングします
3. ステータスが ok になったら、ステータスインターフェースの返却結果からエクスポートファイル情報を取得します

2. リクエスト説明

対象のインターフェースはリクエストボディが不要で、デフォルトで DF-API-KEY が属するワークスペースのデータをエクスポートします。

3. 返却説明

成功時の返却例：

{
  "taskId": "task_xxx"
}

説明：

• タスクの作成に成功すれば、taskId が返されます
• 後続のエクスポート実行が失敗した場合や、一部のリソースのエクスポートが失敗した場合は、タスクステータスインターフェースで確認する必要があります

4. 現在のリソース境界説明

現在のワークスペースのリソースインポート・エクスポートには以下の境界があります：

1. 環境変数に scope=rum は含まれません
2. ログインデックスには外部インデックスと default は含まれません
3. フィールド管理はワークスペースのカスタムフィールドのみを処理します
4. データアクセスは現在、ワークスペースのインポート・エクスポートをサポートしていません

5. エクスポート結果補足説明

リソース内の個別オブジェクトのエクスポートに失敗しても、エクスポートタスク全体は中断されません。 関連する失敗の詳細は、タスクステータスインターフェースから返される import_info.exportFailedInfo に記録されます。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/resource/export/task/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "taskId": "task_xxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}