本記事では、APIを使用してテナント構成パラメータをあいまいに検索する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/tenant/:name/parameters
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| filter | string | いいえ | max_partition% | クエリパラメータ。このパラメータはquery paramで指定します。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTPステータスコードに準拠したエンコードです。 |
| 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メソッドの呼び出しについては、テナント構成パラメータの検索のテナント構成パラメータのあいまい検索を参照してください。