本記事では、APIを使用して指定したテナントのシステム変数を設定する方法について説明します。一度に複数のシステム変数を設定することも可能です。
呼び出しの概要
パスワードが設定されている場合は、認証が必要です。詳細については、APIのハイブリッド暗号化を参照してください。
リクエストパス
PUT /api/v1/tenant/:name/variables
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| variables | map[string]interface{} | はい | { "max_connections": 1000, "recyclebin": true } |
テナントのシステム変数を指定します。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| 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/variables
{
"variables": {
"max_connections": 1000,
"recyclebin": true
}
}
返却例
{
"successful": true,
"timestamp": "2024-10-14T11:13:36.467293708+08:00",
"duration": 74,
"status": 200,
"traceId": "39ff86cca62a9ec0"
}
関連ドキュメント
コマンドラインでAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドの呼び出しについては、テナントのシステム変数を変更するを参照してください。
obshell-sdk-goを使用したAPIメソッドの呼び出しについては、テナントのシステム変数を変更するを参照してください。