OBProxyサービスをデプロイする前に、obshellノードのパスワードを設定する必要があります。本記事では、obshellノードのパスワードを設定するためのAPIについて説明します。
説明
このAPIはobshell V4.2.6以降でサポートされています。
呼び出しの概要
インターフェース制約
ノードに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 | リクエストのトレースIDです。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます:
|
例
リクエスト例
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メソッドのリクエスト方法の詳細については、ノードパスワードの設定を参照してください。