本記事では、APIを使用して指定したテナントの詳細情報をクエリする方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/tenant/:name
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | in | HTTPステータスコードに準拠したエンコードです。 |
| traceId | string | リクエストのTrace IDです。 |
| data | TenantInfo | 指定されたテナントの詳細情報です。詳細については、TenantInfoのデータ構造を参照してください。 |
| error | ApiError | リクエストで発生したErrorで、以下の情報が含まれます。
|
TenantInfoのデータ構造：
パラメータ |
型 |
説明 |
|---|---|---|
| name | string | テナント名。 |
| id | int | テナントID。 |
| created_time | time.Time | テナントの作成日時。 |
| mode | string | テナントモード。 |
| status | string | テナントステータス。 |
| locked | string | テナントがロックされているかどうか。 |
| primary_zone | string | テナントのプライマリゾーン。 |
| locality | string | テナントのローカリティ情報。 |
| in_recyclebin | string | テナントがごみ箱にあるかどうか。 |
| charset | string | テナントで使用される文字セット。 |
| collation | string | テナントで使用される照合順序。 |
| whitelist | string | テナントのアクセスホワイトリスト。 |
| pool | []ResourcePoolWithUnit | テナントが使用するリソースプール情報。詳細は、ResourcePoolWithUnitのデータ構造を参照してください。 |
ResourcePoolWithUnitのデータ構造：
パラメータ |
型 |
説明 |
|---|---|---|
| pool_name | string | リソースプール名。 |
| pool_id | int | リソースプールID。 |
| zone_list | string | リソースプールが配置されるZoneのリスト。 |
| unit_num | int | リソースプールのユニット数。 |
| 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メソッドのリクエスト方法については、テナント情報のクエリを参照してください。