呼び出しの説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
POST /api/v1/agent/upgrade
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| 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 | リクエストのトレースIDです。 |
| data | 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の詳細情報を取得するを参照してください。 |
例
リクエスト例
"{
"version":"4.2.0.0",
"release": "20240109191841.el7"
}"
実行結果例
{
"successful": true,
"timestamp": "2024-01-09T19:26:25.96275587+08:00",
"duration": 30,
"status": 200,
"traceId": "149cd6425a9d256f",
"data": {
"id": "12",
"dag_id": 2,
"name": "Upgrade obshell 4.2.0.0-20240109191841.el7",
"stage": 1,
"max_stage": 9,
"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のアップグレードを参照してください。