このドキュメントでは、クラスタ内のすべての完了していないタスクを照会する方法について説明します。
呼び出しの注意事項
インターフェースの制約
obshell ServerはこのAPIに対してセキュリティ検証を行います。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/task/dag/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情報の一連の内容。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内のすべてのNode情報。詳細については、Nodeの詳細情報を取得するを参照してください。 |
例
リクエストの例
GET 10.10.10.1:2886/api/v1/task/dag/unfinish
返却例
例では、クラスタが拡張中の状態を示しており、クラスタ内には完了していない拡張タスクが1つのみ存在し、各ノードには完了していないローカルタスクは存在しないことを表しています。
{
"successful": true,
"timestamp": "2024-01-10T11:34:32.520371417+08:00",
"duration": 43,
"status": 200,
"traceId": "925c315c8fcf142d",
"data": {
"contents": [
{
"id": "11",
"dag_id": 1,
"name": "Cluster scale out",
"stage": 4,
"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": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-10T11:34:26.66493+08:00",
"end_time": "2024-01-10T11:34:27.687962+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "13",
"task_id": 3,
"name": "Wait scale out ready",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-10T11:34:26.680745+08:00",
"end_time": "2024-01-10T11:34:26.695433+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": [
"local scale out dag task Be scaling agent is succeed"
]
}
]
},
{
"id": "14",
"node_id": 4,
"name": "Wait remote deploy finish",
"state": "RUNNING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:28.708662+08:00",
"end_time": "2024-01-10T11:34:28.708662+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "14",
"task_id": 4,
"name": "Wait remote deploy finish",
"state": "RUNNING",
"operator": "RUN",
"start_time": "2024-01-10T11:34:28.725462+08:00",
"end_time": "2024-01-10T11:34:22.514056+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": [
"retry stage: 2 successfully"
]
}
]
},
{
"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リクエスト方法の紹介については、すべての完了していないタスクを照会するを参照してください。
obshell-sdk-goを使用したAPIリクエスト方法の紹介については、すべての完了していないタスクを照会するを参照してください。