このドキュメントでは、指定されたノードの未完了なローカルタスクを照会する方法について説明します。
呼び出しの説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/task/dag/agent/unfinish
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| show_detail | bool | いいえ | true | subTaskの詳細情報を表示するかどうかを制御します。デフォルトはtrueで、表示されます。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTPステータスコードに準拠したエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| data | []DagDetailDTO | 一連のDagDetailDTO情報です。DagDetailDTOの内容については、後述のDagDetailDTO情報のデータ構造を参照してください。 |
| error | ApiError | リクエストで発生したエラーです。以下の情報が含まれます：
|
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内のすべてのノード情報。ノードの詳細情報を取得するを参照してください。 |
例
リクエスト例
GET 10.10.10.1:2886/api/v1/task/dag/agent/unfinish
戻り値の例
この例では、指定したノードで完了していない Update observer config タスクを示しています。
{
"successful": true,
"timestamp": "2024-01-10T11:42:16.770290833+08:00",
"duration": 0,
"status": 200,
"traceId": "6f10ba950d302e27",
"data": {
"contents": [
{
"id": "22130706433028869",
"dag_id": 5,
"name": "Update observer config",
"stage": 1,
"max_stage": 1,
"state": "READY",
"operator": "RUN",
"start_time": "2024-01-10T11:42:16.568658722+08:00",
"end_time": "2024-01-10T11:42:16.568658722+08:00",
"additional_data": null,
"nodes": [
{
"id": "22130706433028869",
"node_id": 5,
"name": "Update observer config",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:42:16.568940443+08:00",
"end_time": "2024-01-10T11:42:16.568940443+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "22130706433028869",
"task_id": 5,
"name": "Update observer config",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:42:16.569166163+08:00",
"end_time": "2024-01-10T11:42:16.569166163+08:00",
"additional_data": null,
"execute_times": 0,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": null
}
]
}
]
}
]
}
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKのメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の詳細は、Agentが完了していないタスクの確認を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の詳細は、Agentが完了していないタスクの確認を参照してください。