本記事では、obshellを使用してOBProxy（OceanBaseデータベースプロキシ、ODPとも呼ばれる）を起動する方法について説明します。
説明
obshell V4.2.6からこのAPIをサポートしています。
呼び出しの概要
インターフェース制約
- obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細についてはAPI混合暗号化を参照してください。
- このobshellで管理されているOBProxyサービスが必要です。
リクエストパス
POST /api/v1/obproxy/start
レスポンス結果
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）。 |
| status | int | HTTPステータスコード規格に準拠したエンコードです。 |
| 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内のすべてのノード情報。詳細については、ノードの詳細情報を取得するを参照してください。 |
例
リクエスト例
POST 10.10.10.1:2886/api/v1/obproxy/start
レスポンス例
{
"successful": true,
"timestamp": "2025-03-20T15:20:02.190100104+08:00",
"duration": 2,
"status": 200,
"traceId": "762914cd0eda6120",
"data": {
"id": "40194912107080888",
"dag_id": 8,
"name": "Start obproxy",
"stage": 1,
"max_stage": 2,
"state": "READY",
"operator": "RUN",
"start_time": "2025-03-20T15:20:02.188472711+08:00",
"end_time": "2025-03-20T15:20:02.188472711+08:00",
"additional_data": null,
"nodes": null
}
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法については、OBProxyの起動を参照してください。