本記事では、APIを使用してテナント構成パラメータをあいまい検索する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/tenant/:name/parameters
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| filter | string | いいえ | max_partition% | 検索パラメータ。このパラメータはquery paramで指定します。 |
戻り結果
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうか。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）。 |
| status | int | HTTP Status仕様に準拠したエンコード。 |
| traceId | string | リクエストのTrace ID。 |
| data | GvObParameter | 返された構成パラメータ情報。詳細については、以下のGvObParameterのデータ構造を参照してください。 |
| error | ApiError | リクエストによって生成されたError。以下の情報を含みます：
|
GvObParameterのデータ構造：
パラメータ |
型 |
説明 |
|---|---|---|
| name | string | 構成パラメータ名。 |
| value | string | 構成パラメータの値。 |
| data_type | string | 構成パラメータのデータ型。 |
| info | string | 構成パラメータの情報。 |
| edit_level | string | 構成パラメータの変更レベル。 |
例
リクエスト例
GET 10.10.10.1:2886/api/v1/tenant/t1/parameters?filter=max_partition%
戻り値の例
{
"successful": true,
"timestamp": "2024-10-14T15:00:19.769142288+08:00",
"duration": 22,
"status": 200,
"traceId": "e0bad793ea31b95a",
"data": {
"contents": [
{
"name": "max_partition_num",
"value": "8192",
"data_type": "",
"info": "set max partition num in mysql mode",
"edit_level": "DYNAMIC_EFFECTIVE"
}
]
}
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法については、テナント構成パラメータのクエリ の テナント構成パラメータのあいまい検索 を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法については、テナント構成パラメータのクエリ の テナント構成パラメータのあいまい検索 を参照してください。