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

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 が属するワークスペースのすべてのリソースをエクスポートします。

SLO リソースパッケージをエクスポートする場合は、POST /api/v1/slo/export/task/create を呼び出してください。このインターフェースはワークスペースの全リソースをエクスポートするためのみに使用します。

3. レスポンスの説明

成功時のレスポンス例：

{
  "taskId": "task_xxx"
}

説明：

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

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

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

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

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

特定のリソース内の個別オブジェクトのエクスポートに失敗しても、エクスポートタスク全体は中断されません。

タスクステータスインターフェースの import_info.exportInfo.resourceFailureInfo は、重複排除後のリソースレベルの失敗詳細を返します。これにはリソースタイプ、リソース UUID、リソース名、安定した失敗理由、影響を受ける SLO が含まれます。リソース設定、権限メンバー、例外スタックトレース、機密フィールドは返されません。

従来の 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"
}