Agentアップグレードの条件が満たされているかどうかを確認します。アップグレードパッケージがアップロードされているか、アップグレードに必要な製品が揃っているかを含みます。
呼び出し説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を行います。詳細については、API混合暗号化を参照してください。
リクエストパス
POST /api/v1/agent/upgrade/check
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| version | string | はい | 4.2.1.1 | アップグレードの対象バージョンを指定します |
| release | string | はい | 101000062023110109.el7 | アップグレードの対象リリースビルド番号を指定します |
| upgradeDir | string | いいえ | /data/upgrade | アップグレードチェックタスクで使用するディレクトリを指定します |
戻り結果
パラメータ |
型 |
説明 |
|---|---|---|
| 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内のすべてのノード情報。詳細については、ノードの詳細情報を取得するを参照してください。 |
例
リクエスト例
"{
"version":"4.2.0.0",
"release": "20240109191841.el7"
}"
レスポンス例
{
"successful": true,
"timestamp": "2024-01-09T19:24:47.119397966+08:00",
"duration": 57,
"status": 200,
"traceId": "7fc743b925442f69",
"data": {
"id": "11",
"dag_id": 1,
"name": "Upgrade check obshell 4.2.0.0-20240109191841.el7",
"stage": 1,
"max_stage": 5,
"state": "READY",
"operator": "RUN",
"start_time": "0001-01-01T00:00:00Z",
"end_time": "0001-01-01T00:00:00Z",
"additional_data": null,
"nodes": null
}
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法については、Agentアップグレードチェックを参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法については、Agentアップグレードチェックを参照してください。