本記事では、APIを使用してテナントシステム変数をあいまいクエリで検索する方法について説明します。
呼び出しの概要
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/tenant/:name/variables
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| filter | string | いいえ | max_connect% | クエリパラメータ。このパラメータはquery paramで指定します。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうか。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）。 |
| status | int | HTTP Status仕様に準拠したコード。 |
| 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/variables?filter=max_connect%
返却例
{
"successful": true,
"timestamp": "2024-10-14T15:14:01.277047628+08:00",
"duration": 36,
"status": 200,
"traceId": "e6f64ba7f54e7a47",
"data": {
"contents": [
{
"name": "max_connections",
"value": "1000",
"info": ""
}
]
}
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを通じてAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法については、テナントシステム変数のクエリ の テナントシステム変数のあいまい検索 を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法については、テナントシステム変数のクエリ の テナントシステム変数のあいまい検索 を参照してください。