このドキュメントでは、subTaskの詳細情報を取得する方法について説明します。
呼び出しの説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/task/sub_task/{id}
ここでのidは、subTaskの汎用的なIDとして設定する必要があります。
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠したエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| data | TaskDetailDTO | 詳細については、以下のTaskDetailDTO情報のデータ構造を参照してください。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます：
|
TaskDetailDTO情報のデータ構造は以下のとおりです：
| パラメータ | タイプ | 説明 |
|---|---|---|
| id | string | subTask共通のID。 |
| task_id | int | subTask idは、OceanBaseデータベースに記録される主キーです。 |
| name | string | subTask名。 |
| state | string | subTaskの実行状態。 |
| operator | string | subTaskの実行操作タイプ。 |
| start_time | time.Time | subTaskの実行開始時間。 |
| end_time | time.Time | subTaskの実行終了時間。 |
| additional_data | map[string]any | subTaskのその他のデータ。 |
| execute_times | int | 実行回数。 |
| execute_agent | AgentInfo | 実行ノードのAgentInfoで、以下の情報が含まれます：
|
| task_logs | []string | 実行ログ。 |
例
リクエスト例
GET 10.10.10.1:2886/api/v1/task/sub_task/12
レスポンス例
例では、Create local scale out dag という名前のサブタスクの情報が示されており、実行操作は RUN、実行結果は SUCCEED です。
{
"successful": true,
"timestamp": "2024-01-09T21:29:37.372338686+08:00",
"duration": 6,
"status": 200,
"traceId": "638aa02fc5b50051",
"data": {
"id": "12",
"task_id": 2,
"name": "Create local scale out dag",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:03.796683+08:00",
"end_time": "2024-01-09T20:40:03.836712+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"
]
}
}
関連ドキュメント
コマンドラインからAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の詳細については、SubTaskの詳細情報を取得するを参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の詳細については、SubTaskの詳細情報を取得するを参照してください。