ワークスペースリソースタスクステータスクエリ¶

GET /api/v1/workspace/resource/query_action_status

概要¶

ワークスペースリソースのインポート/エクスポートタスクのステータスをクエリします。

Query リクエストパラメータ¶

パラメータ補足説明¶

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

ワークスペースリソースのインポートまたはエクスポートタスクの実行ステータスをクエリします。

レスポンス構造はフロントエンドと同一であり、以下の用途に適しています： - エクスポートタスクの結果クエリ - インポートタスクの結果クエリ - エラーコードと失敗情報のクエリ

2. よくあるステータス値

3. よくあるレスポンスフィールドの説明

4. エクスポートタスククエリの説明

エクスポートタスクが成功すると、ステータスは通常 ok となり、レスポンス結果からエクスポートファイルに関する情報を取得できます。

エクスポート中に一部のオブジェクトが失敗した場合、以下を確認できます：

import_info.exportFailedInfo

5. インポートタスククエリの説明

インポートタスクが成功すると、通常 import_info に以下の情報が表示されます：

• successCount
• failCount

一部のリソースの詳細な失敗理由は、errorCode またはインポートタスク内部のエラー統計に含まれます。

6. ポーリングの推奨

2～5秒ごとにポーリングし、ステータスが以下のいずれかになるまで実行することを推奨します： - ok - error - cancel

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/resource/query_action_status?taskId=task_xxx' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "status": "ok",
        "action": "import",
        "message": "",
        "errorCode": "",
        "import_info": {
            "failCount": 0,
            "successCount": 12
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}