サーバー級の設定を設定する際は、完全な上書きポリシーが採用されます。つまり、既存の設定は新しい設定によって完全に置き換えられます。
呼び出しの説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
POST /api/v1/observer/config
PUT /api/v1/observer/config
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| observerConfig | map[string]string | はい | { "mysql_port": "2881", "rpc_port": "2882", "memory_limit": "16G", "system_memory": "8G" } |
OBServerノードの構成パラメータを設定します。 |
| scope | スコープ | はい | 詳細については、以下のリクエスト例を参照してください | この構成を適用するOBServerノードの範囲を設定します。詳細については、以下のスコープ情報のデータ構造を参照してください。 |
Scope情報のデータ構造は以下のとおりです：
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| type | string | はい | "SERVER" | 設定の有効レベルを設定します。値は GLOBAL、ZONE、SERVER です。 |
| target | []string | いいえ | サンプル値：["10.10.10.1:2886", "10.10.10.2:2886"] または ["zone1","zone2"] | type が SERVER の場合、OBServerノードのリストを設定します。type が ZONE の場合、ゾーンのリストを設定します。type が GLOBAL の場合、設定する必要はありません。 |
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| 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/observer/config
{
"observerConfig": {
"redoDir":"/data/workspace/redo",
"dataDir":"/data/workspace/data",
"mysql_port": "2881",
"rpc_port": "2882",
"datafile_size":"24G",
"cpu_count":"16",
"memory_limit": "16G",
"system_memory": "8G",
"log_disk_size":"40G"
},
"scope": {
"target": [
"10.10.10.1:2886",
"10.10.10.2:2886"
],
"type": "SERVER"
}
}
レスポンス例
{
"successful": true,
"timestamp": "2024-01-09T17:11:43.385889278+08:00",
"duration": 1,
"status": 200,
"traceId": "877fe32b83634153",
"data": {
"id": "22130706433028869",
"dag_id": 4,
"name": "Update observer config",
"stage": 1,
"max_stage": 1,
"state": "READY",
"operator": "RUN",
"start_time": "2024-01-09T17:11:43.384630643+08:00",
"end_time": "2024-01-09T17:11:43.384630643+08:00",
"additional_data": null,
"nodes": null
}
}
関連ドキュメント
コマンドラインからAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の詳細については、Serverレベルの構成の設定を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の詳細については、Serverレベルの構成の設定を参照してください。