本記事では、APIを使用してテナントのシステム変数を指定してクエリする方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/tenant/:name/variable/:variable
実行結果
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTPステータスコードに準拠したエンコードです。 |
| traceId | string | リクエストのTrace IDです。 |
| data | CdbObSysVariable | 戻されたシステム変数情報です。詳細は、以下のCdbObSysVariableのデータ構造を参照してください。 |
| error | ApiError | リクエストによって生成されたErrorで、以下の情報が含まれます。
|
CdbObSysVariableのデータ構造：
パラメータ |
型 |
説明 |
|---|---|---|
| name | string | システム変数名。 |
| value | string | システム変数の値。 |
| info | string | システム変数の情報。 |
例
リクエスト例
GET 10.10.10.1:2886/api/v1/tenant/t1/variable/max_connections
実行結果例
{
"successful": true,
"timestamp": "2024-10-14T15:16:28.044579876+08:00",
"duration": 20,
"status": 200,
"traceId": "3702684711dd0e7b",
"data": {
"name": "max_connections",
"value": "1000",
"info": ""
}
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドの呼び出しについては、テナントシステム変数のクエリの指定したテナントのシステム変数のクエリを参照してください。
obshell-sdk-goを使用したAPIメソッドの呼び出しについては、テナントシステム変数のクエリの指定したテナントのシステム変数のクエリを参照してください。