本記事では、初期化済みのクラスタから指定されたノードを削除する方法について説明します。
呼び出しの説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を行います。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
DELETE /api/v1/observer POST /api/v1/ob/scale_in
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| agent_info | AgentInfo | はい | { "ip": "10.10.10.3", "port": 2886 } |
クラスタから削除するノードの情報を設定します。以下の情報が含まれます：
|
| force_kill | map[string]string | いいえ | true | true の場合、ノードをクラスタから削除する前に対応するobserverプロセスをkillします。
注意
|
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| 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/ob/scale_in
{
"agent_info": {
"ip": "10.10.10.4",
"port": 2886
},
"force_kill": false
}
この例では、10.10.10.4:2886ノードをクラスタから削除するリクエストを10.10.10.1:2886ノードに送信する方法を示しています。
レスポンス例
{
"successful": true,
"timestamp": "2024-12-23T19:38:38.10769991+08:00",
"duration": 101,
"status": 200,
"traceId": "50c6e85c24a30919",
"data": {
"id": "11",
"dag_id": 1,
"name": "Cluster scale in",
"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メソッドのリクエスト方法については、クラスタのスケールインを参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法については、クラスタのスケールインを参照してください。