本記事では、APIを使用して指定したテナントのパラメータを設定する方法について説明します。一度に複数のパラメータを設定することも可能です。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
PUT /api/v1/tenant/:name/parameters
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| parameters | map[string]interface{} | はい | { "backup_data_file_size": "2G", "arbitration_timeout": "10s" } |
テナントの構成パラメータを指定します。 |
レスポンス結果
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTPステータスコードに準拠したエンコードです。 |
| traceId | string | リクエストのTrace IDです。 |
| error | ApiError | リクエストで発生したErrorで、以下の情報が含まれます。
|
例
リクエスト例
PUT 10.10.10.1:2886/api/v1/tenant/t1/parameters
{
"parameters": {
"backup_data_file_size": "2G",
"arbitration_timeout": "10s"
}
}
レスポンス例
{
"successful": true,
"timestamp": "2024-10-14T11:27:13.084193081+08:00",
"duration": 67,
"status": 200,
"traceId": "5932e4b9b304ad3d"
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドの呼び出しについては、テナント構成パラメータの変更を参照してください。
obshell-sdk-goを使用したAPIメソッドの呼び出しについては、テナント構成パラメータの変更を参照してください。