本記事では、初期化済みのクラスタから指定されたZoneを削除する方法について説明します。Zoneを削除すると、そのZone上のobserverプロセスもクラスタから削除されます。
注意事項
指定したZoneを削除する際、削除対象のZoneにUnitが存在してはなりません。
呼び出し説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
DELETE /api/v1/zone/{zoneName}
リクエストパラメータ
なし
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| 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内のすべてのノード情報。ノードの詳細情報を取得するを参照してください。 |
例
リクエスト例
10.10.10.1:2886ノードに対して、クラスタからzone3を削除するリクエストを送信します。例：
POST 10.10.10.1:2886/api/v1/zone/zone3
レスポンス例
{
"successful": true,
"timestamp": "2024-12-23T19:46:19.33899863+08:00",
"duration": 99,
"status": 200,
"traceId": "8651d2dd3e17280e",
"data": {
"id": "13",
"dag_id": 3,
"name": "Delete zone",
"stage": 1,
"max_stage": 7,
"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を呼び出すこともできます。