本記事では、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 Status規格に準拠するエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます:
|
例
リクエスト例
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メソッドのリクエスト方法については、テナントのシステム変数を変更するを参照してください。