本記事では、APIを使用して指定されたテナントの詳細情報を照会する方法について説明します。
呼び出しの注意事項
パスワードが設定されている場合は、認証が必要です。詳細については、API混合暗号化を参照してください。
リクエストパス
GET /api/v1/tenant/:name
返却結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうか。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | int | サーバーがリクエストを処理に要した時間（ミリ秒）。 |
| status | in | HTTP Status 標準に準拠したエンコード。 |
| traceId | string | リクエストのTrace ID。 |
| data | TenantInfo | 指定されたテナントの詳細情報。詳細については、TenantInfo のデータ構造を参照してください。 |
| error | ApiError | リクエストで発生したエラー。以下の情報が含まれます：
|
TenantInfoのデータ構造：
| パラメータ | タイプ | 説明 |
|---|---|---|
| name | string | テナントの名前。 |
| id | int | テナントID。 |
| created_time | time.Time | テナントが作成された時間。 |
| mode | string | テナントモード。 |
| status | string | テナントの状態。 |
| locked | string | テナントがロックされているかどうか。 |
| primary_zone | string | テナントのPrimaryZone。 |
| locality | string | テナントのLocality情報。 |
| in_recyclebin | string | テナントがリサイクルボックスに存在するかどうか。 |
| charset | string | テナントが使用する文字セット。 |
| collation | string | テナントが使用する照合順序。 |
| whitelist | string | テナントのアクセス許可リスト。 |
| pool | []ResourcePoolWithUnit | テナントが使用するリソースプール情報。詳細については、ResourcePoolWithUnitのデータ構造を参照してください。 |
ResourcePoolWithUnitのデータ構造：
| パラメータ | 型 | 説明 |
|---|---|---|
| pool_name | string | リソースプールの名前です。 |
| pool_id | int | リソースプールIDです。 |
| zone_list | string | リソースプールが配置されているゾーンの一覧です。 |
| unit_num | int | リソースプールのunit数です。 |
| unit_config | ObUnitConfig | リソースプールで使用されるすべてのリソース仕様の情報です。詳細については、ObUnitConfigのデータ構造を参照してください。 |
ObUnitConfigのデータ構造：
| パラメータ | タイプ | 説明 |
|---|---|---|
| create_time | time.Time | リソース仕様の作成日時。 |
| modify_time | time.Time | リソース仕様の更新日時。 |
| unit_config_id | int | リソース仕様ID。 |
| name | string | リソース仕様の名前。 |
| max_cpu | float64 | CPU仕様の上限。 |
| min_cpu | float64 | CPU仕様の下限。 |
| memory_size | int | メモリ仕様。 |
| log_disk_size | int | ログディスク容量。 |
| max_iops | uint | IOPSの上限。 |
| min_iops | uint | IOPSの下限。 |
例
リクエスト例
GET 10.10.10.1:2886/api/v1/tenant/t1
返却例
{
"successful": true,
"timestamp": "2024-10-14T14:27:47.6484216+08:00",
"duration": 69,
"status": 200,
"traceId": "7f571f5a59e89ffa",
"data": {
"tenant_name": "t1",
"tenant_id": 1002,
"created_time": "2024-10-14T10:26:55.086821+08:00",
"mode": "MYSQL",
"status": "NORMAL",
"locked": "NO",
"primary_zone": "RANDOM",
"locality": "FULL{1}@zone2, FULL{1}@zone3",
"in_recyclebin": "NO",
"charset": "",
"collation": "",
"whitelist": "%,127.0.0.1",
"pools": [
{
"pool_name": "t1_zone2_1728872814",
"pool_id": 1002,
"zone_list": "zone2",
"unit_num": 1,
"unit_config": {
"create_time": "2024-10-14T10:26:41.286401+08:00",
"modify_time": "2024-10-14T10:26:41.286401+08:00",
"unit_config_id": 1001,
"name": "s1",
"max_cpu": 2,
"min_cpu": 2,
"memory_size": 2147483648,
"log_disk_size": 6442450944,
"max_iops": 9223372036854775807,
"min_iops": 9223372036854775807
}
},
{
"pool_name": "t1_zone3_1728872814",
"pool_id": 1003,
"zone_list": "zone3",
"unit_num": 1,
"unit_config": {
"create_time": "2024-10-14T10:26:41.286401+08:00",
"modify_time": "2024-10-14T10:26:41.286401+08:00",
"unit_config_id": 1001,
"name": "s1",
"max_cpu": 2,
"min_cpu": 2,
"memory_size": 2147483648,
"log_disk_size": 6442450944,
"max_iops": 9223372036854775807,
"min_iops": 9223372036854775807
}
}
]
}
}
関連ドキュメント
コマンドラインからAPIインターフェースを呼び出す他に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIリクエスト方法の詳細については、テナント情報を照会するを参照してください。
obshell-sdk-goを使用したAPIリクエスト方法の詳細については、テナント情報を照会するを参照してください。