本記事では、obshellを使用してOBProxy（OceanBaseデータベースプロキシ、ODPとも呼ばれる）を破棄する方法について説明します。
説明
このAPIはobshell V4.2.6以降でサポートされています。
呼び出しの説明
インターフェース制約
- obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
- obshellで管理されているOBProxyサービスが必要です。
リクエストパス
DELETE /api/v1/obproxy
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| 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の詳細情報を取得するを参照してください。 |
例
リクエスト例
DELETE 10.10.10.1:2886/api/v1/obproxy
実行結果例
{
"successful": true,
"timestamp": "2025-03-20T16:49:01.506125154+08:00",
"duration": 2,
"status": 200,
"traceId": "cd41831d02399bc8",
"data": {
"id": "401949121070808812",
"dag_id": 12,
"name": "Delete obproxy",
"stage": 1,
"max_stage": 4,
"state": "READY",
"operator": "RUN",
"start_time": "2025-03-20T16:49:01.50428353+08:00",
"end_time": "2025-03-20T16:49:01.50428353+08:00",
"additional_data": null,
"nodes": null
}
}
関連ドキュメント
コマンドラインからAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の紹介については、OBProxyの終了を参照してください。