このドキュメントでは、CLUSTER AGENTとして認識されているノードの未完了クラスタタスクを照会する方法について説明します。
呼び出しの説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細についてはAPI混合暗号化を参照してください。
リクエストオブジェクトの身元はCLUSTER AGENTでなければなりません。
リクエストパス
GET /api/v1/task/dag/ob/unfinish
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| show_detail | bool | いいえ | true | subTaskの詳細情報を表示するかどうかを制御します。デフォルトはtrue、つまり表示する必要があります。 |
戻り結果
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうか。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | int | サーバーがリクエストを処理した時間(ミリ秒)。 |
| status | int | HTTP Status仕様に準拠したエンコード。 |
| traceId | string | リクエストのTrace ID。 |
| data | DagDetailDTO | 詳細は以下のDagDetailDTO情報のデータ構造を参照してください。 |
| error | ApiError | リクエストによって生成されたError。以下の情報を含みます：
|
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/ob/unfinish
レスポンス例
この例では、拡張中のクラスタが示されており、この時点でクラスタ内の未完了クラスタタスクは拡張タスクが1つだけです。
{
"successful": true,
"timestamp": "2024-01-10T11:34:26.004688655+08:00",
"duration": 46,
"status": 200,
"traceId": "4da76cbedcd36098",
"data": {
"contents": [
{
"id": "11",
"dag_id": 1,
"name": "Cluster scale out",
"stage": 3,
"max_stage": 9,
"state": "RUNNING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.556477+08:00",
"end_time": "2024-01-10T11:34:22.47652+08:00",
"additional_data": {},
"nodes": [
{
"id": "11",
"node_id": 1,
"name": "Integrate server config",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.567766+08:00",
"end_time": "2024-01-10T11:34:23.595834+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "11",
"task_id": 1,
"name": "Integrate server config",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.59098+08:00",
"end_time": "2024-01-10T11:34:22.611066+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": []
}
]
},
{
"id": "12",
"node_id": 2,
"name": "Create local scale out dag",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-10T11:34:24.621206+08:00",
"end_time": "2024-01-10T11:34:25.644996+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "12",
"task_id": 2,
"name": "Create local scale out dag",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-10T11:34:24.635881+08:00",
"end_time": "2024-01-10T11:34:24.670586+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": [
"create local scale out dag success, genericID:22130706433028869"
]
}
]
},
{
"id": "13",
"node_id": 3,
"name": "Wait scale out ready",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.513+08:00",
"end_time": "2024-01-10T11:34:22.513+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "13",
"task_id": 3,
"name": "Wait scale out ready",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.513+08:00",
"end_time": "2024-01-10T11:34:22.513+08:00",
"additional_data": null,
"execute_times": 0,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": null
}
]
},
{
"id": "14",
"node_id": 4,
"name": "Wait remote deploy finish",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.514056+08:00",
"end_time": "2024-01-10T11:34:22.514056+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "14",
"task_id": 4,
"name": "Wait remote deploy finish",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.514056+08:00",
"end_time": "2024-01-10T11:34:22.514056+08:00",
"additional_data": null,
"execute_times": 0,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": null
}
]
},
{
"id": "15",
"node_id": 5,
"name": "Wait remote start finish",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.514056+08:00",
"end_time": "2024-01-10T11:34:22.514056+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "15",
"task_id": 5,
"name": "Wait remote start finish",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.515112+08:00",
"end_time": "2024-01-10T11:34:22.515112+08:00",
"additional_data": null,
"execute_times": 0,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": null
}
]
},
{
"id": "16",
"node_id": 6,
"name": "Prev check for scale_out",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.515112+08:00",
"end_time": "2024-01-10T11:34:22.515112+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "16",
"task_id": 6,
"name": "Prev check for scale_out",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.51617+08:00",
"end_time": "2024-01-10T11:34:22.51617+08:00",
"additional_data": null,
"execute_times": 0,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": null
}
]
},
{
"id": "17",
"node_id": 7,
"name": "Add server for scale_out",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.51617+08:00",
"end_time": "2024-01-10T11:34:22.51617+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "17",
"task_id": 7,
"name": "Add server for scale_out",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.51617+08:00",
"end_time": "2024-01-10T11:34:22.51617+08:00",
"additional_data": null,
"execute_times": 0,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": null
}
]
},
{
"id": "18",
"node_id": 8,
"name": "Add agent for scale_out",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.517232+08:00",
"end_time": "2024-01-10T11:34:22.517232+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "18",
"task_id": 8,
"name": "Add agent for scale_out",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.517232+08:00",
"end_time": "2024-01-10T11:34:22.517232+08:00",
"additional_data": null,
"execute_times": 0,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": null
}
]
},
{
"id": "19",
"node_id": 9,
"name": "Check cluster scale_out whether finished",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.517232+08:00",
"end_time": "2024-01-10T11:34:22.517232+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "19",
"task_id": 9,
"name": "Check cluster scale_out whether finished",
"state": "PENDING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:22.518288+08:00",
"end_time": "2024-01-10T11:34:22.518288+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メソッドのリクエスト方法については、OceanBaseクラスタの未完了タスクを照会するを参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法については、OceanBaseクラスタの未完了タスクを照会するを参照してください。