OBProxyサービスをデプロイする前に、obshellノードのパスワードを設定する必要があります。このドキュメントでは、obshellノードのパスワードを設定するAPIについて説明します。
説明
obshell V4.2.6からこのAPIをサポートしています。
呼び出しの説明
インターフェース制約
ノードにobshellノードのパスワードが既に設定されている場合、このAPIは既存のノードパスワードに対してセキュリティ検証を実行します。ノードにパスワードが設定されていない場合、現在のobshellノードが管理するOceanBaseクラスタがある場合、このAPIはroot@sysのパスワードを使用してセキュリティ検証を実行します。
リクエストパス
POST /api/v1/agent/password
リクエストパラメータ
パラメータ |
タイプ |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| password | string | はい | "****" | ノードのパスワード |
戻り結果
パラメータ |
タイプ |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうか。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）。 |
| status | int | HTTP Status仕様に準拠したエンコード。 |
| traceId | string | リクエストのTrace ID。 |
| error | ApiError | リクエストで発生したError。以下の情報を含みます：
|
例
リクエスト例
POST 10.10.10.1:2886/api/v1/agent/password
{
"password": "*****"
}
返却例
{
"successful": true,
"timestamp": "2025-03-24T16:58:38.543027516+08:00",
"duration": 1,
"status": 200,
"traceId": "a50243705b1f1997"
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを通じてAPIを呼び出すこともできます。obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法については、ノードパスワードの設定を参照してください。