APIを呼び出すことで、クラスタID(clusterId)、クラスタ名(clusterName)、Root Serviceリスト(rsList)、root@sysユーザーのパスワード(rootPwd)などのクラスタレベル構成を設定できます。
説明
クラスタレベル構成を設定する際は、既存の設定が新しい設定によって完全に上書きされるフルオーバーライド方式が採用されます。
呼び出しの説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
POST /api/v1/obcluster/config
PUT /api/v1/obcluster/config
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| clusterId | string | いいえ | 1 | クラスタIDを設定します。 |
| clusterName | string | いいえ | ob-test | クラスタ名を設定します。 |
| rootPwd | string | いいえ | なし | クラスタのsysテナントのrootユーザーパスワードを設定します。 |
説明
obshell V4.2.4.0以降では、rootPwdパラメータの設定において暗号化は不要です。それ以前のバージョンのobshellでこのAPIを呼び出す場合は、rootPwdパラメータを暗号化する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| 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内のすべてのノード情報。ノードの詳細情報を取得するを参照してください。 |
例
リクエスト例
"{
"clusterId":1,
"clusterName":"upgrade",
"rootPwd":"********"
}"
レスポンス例
{
"successful": true,
"timestamp": "2024-01-09T15:14:26.299401393+08:00",
"duration": 1,
"status": 200,
"traceId": "6328313e8d9fd63b",
"data": {
"id": "22130706433028869",
"dag_id": 2,
"name": "Update cluster config",
"stage": 1,
"max_stage": 1,
"state": "READY",
"operator": "RUN",
"start_time": "2024-01-09T15:14:26.29828992+08:00",
"end_time": "2024-01-09T15:14:26.29828992+08:00",
"additional_data": null,
"nodes": null
}
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法については、クラスタレベル設定の設定を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法については、クラスタレベル設定の設定を参照してください。