本記事では、APIを使用して指定したテナントのパラメータを照会する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/tenant/:name/parameter/:parameter
実行結果
パラメータ |
型 |
説明 |
|---|---|---|
| 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/parameter/max_partition_num
実行結果例
{
"successful": true,
"timestamp": "2024-10-14T15:19:46.214458368+08:00",
"duration": 25,
"status": 200,
"traceId": "7fed9977fe59a58f",
"data": {
"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メソッドのリクエスト方法については、テナント構成パラメータの確認 の 指定されたテナント構成パラメータの確認 を参照してください。