obshellの最後の運用タスクを照会する

最終更新:2026-09-02 09:33:03

このドキュメントでは、obshellの最後の運用タスクを照会する方法について説明します。

呼び出しの注意点

インターフェース制約

obshell ServerはこのAPIに対してセキュリティ検証を行います。詳細については、APIハイブリッド暗号化を参照してください。

リクエストパス

GET /api/v1/task/dag/maintain/agent

結果の返却

パラメータ	タイプ	説明
successful	bool	リクエストが成功したかどうか。
timestamp	time.Time	サーバーがリクエストを完了したタイムスタンプ。
duration	int	サーバーがリクエストを処理に要した時間（ミリ秒）。
status	int	HTTP Status 標準に準拠するエンコード。
traceId	string	リクエストのTrace ID。
data	DagDetailDTO	詳細については、以下の DagDetailDTO情報のデータ構造を参照してください。
error	ApiError	リクエストで発生したエラー。含まれる情報は次のとおりです： `code`：エラーコード。 `message`：エラーの詳細情報。 `subErrors`：サブエラー情報。

DagDetailDTO情報のデータ構造は以下のとおりです：

パラメータ	タイプ	説明
id	string	DAGの汎用IDです。
dag_id	int	DAGのIDで、OceanBaseデータベースに記録される主キーです。
name	string	DAGの名前です。
stage	int	DAGの現在の実行段階です。
max_stage	int	DAGの実行プロセスにおける合計段階数です。
state	string	DAGの実行状態です。
operator	string	DAGの実行操作タイプです。
start_time	time.Time	DAGの実行開始時刻です。
end_time	time.Time	DAGの実行終了時刻です。
additional_data	map[string]any	DAGのその他のデータです。
nodes	[]NodeDetailDTO	DAG内のすべてのNode情報です。詳細はNodeの詳細情報を取得するを参照してください。

例

要求例

GET 10.10.10.1:2886/api/v1/task/dag/maintain/agent

返却例

返却例では、Synchronize agent from clusterという名前のタスクの詳細が返され、実行操作はRUN、実行結果はSUCCEEDです。

{
    "successful": true,
    "timestamp": "2024-01-09T21:45:27.340233605+08:00",
    "duration": 0,
    "status": 200,
    "traceId": "4ceda0238c6e5298",
    "data": {
        "id": "22130706433028869",
        "dag_id": 4,
        "name": "Synchronize agent from cluster",
        "stage": 1,
        "max_stage": 1,
        "state": "SUCCEED",
        "operator": "RUN",
        "start_time": "2024-01-09T20:01:31.650764119+08:00",
        "end_time": "2024-01-09T20:01:32.655874093+08:00",
        "additional_data": null,
        "nodes": [
            {
                "id": "22130706433028869",
                "node_id": 5,
                "name": "Synchronize agent from cluster",
                "state": "SUCCEED",
                "operator": "RUN",
                "start_time": "2024-01-09T20:01:31.651926606+08:00",
                "end_time": "2024-01-09T20:01:32.655194254+08:00",
                "additional_data": null,
                "sub_tasks": [
                    {
                        "id": "22130706433028869",
                        "task_id": 5,
                        "name": "Synchronize agent from cluster",
                        "state": "SUCCEED",
                        "operator": "RUN",
                        "start_time": "2024-01-09T20:01:31.653629561+08:00",
                        "end_time": "2024-01-09T20:01:31.795492693+08:00",
                        "additional_data": null,
                        "execute_times": 1,
                        "execute_agent": {
                            "ip": "10.10.10.1",
                            "port": 2886
                        },
                        "task_logs": [
                            "try to connect",
                            "connect succeed, dump password",
                            "synchronize agent from oceanbase",
                            "sync agent data"
                        ]
                    }
                ]
            }
        ]
    }
}

呼び出しの注意点

インターフェース制約

リクエストパス

結果の返却

例

要求例

返却例

関連ドキュメント