本記事では、初期化済みのクラスタに指定されたノードを追加する方法について説明します。
呼び出しの説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
POST /api/v1/ob/scale_out
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| agentInfo | AgentInfo | はい | { "ip": "10.10.10.4", "port": 2886 } |
クラスタに拡張して追加したいノードの情報を設定します。以下の情報が含まれます：
|
| obConfigs | map[string]string | はい | { "mysql_port": "2881", "rpc_port": "2882", "memory_limit": "16G", "system_memory": "8G" } |
クラスタに拡張して追加したいOBServerノードの構成情報。 |
| zone | string | はい | "zone1" | ノードが属するゾーン。 |
| targetAgentPassword | string | いいえ | ***** | 新しいノードにノードパスワードが設定されている場合、このパラメータでノードパスワードを指定する必要があります。
説明obshell V4.2.6以降でこのパラメータの設定がサポートされています。 |
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| 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の詳細情報を取得するを参照してください。 |
例
リクエスト例
POST 10.10.10.1:2886/api/v1/ob/scale_out
{
"agentInfo": {
"ip": "10.10.10.4",
"port": 2886
},
"obConfigs": {
"mysqlPort": "2881",
"rpcPort": "2882",
"memory_limit": "16G",
"system_memory": "8G",
"log_disk_size": "24G",
"datafile_size": "24G"
},
"zone": "zone2"
}
この例では、10.10.10.4:2886ノードをクラスタにスケールアウトするリクエストを10.10.10.1:2886ノードに送信する方法を示しています。
レスポンス例
{
"successful": true,
"timestamp": "2024-01-09T20:40:00.86290666+08:00",
"duration": 51,
"status": 200,
"traceId": "29b9c2717c65d7bc",
"data": {
"id": "11",
"dag_id": 1,
"name": "Cluster scale out",
"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メソッドのリクエスト方法の紹介については、クラスタのスケールアウトを参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の紹介については、クラスタのスケールアウトを参照してください。