本記事では、APIを使用してすべてのテナントの概要を取得する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/tenants/overview
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠したエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| data | []DbaObTenant | 取得したすべてのテナントの概要情報です。詳細については、DbaObTenantのデータ構造を参照してください。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます：
|
DbaObTenantのデータ構造：
| パラメータ | タイプ | 説明 |
|---|---|---|
| tenant_id | int | テナントID。 |
| tenant_name | string | テナント名。 |
| mode | string | テナントモード。 |
| status | string | テナントのステータス。 |
| locked | string | テナントがロックされているかどうか。 |
| primary_zone | string | テナントのPrimary Zone。 |
| locality | string | テナントのレプリカ情報。 |
| in_recyclebin | string | テナントがごみ箱にあるかどうか。 |
| created_time | time.Time | テナントが作成された時間。 |
例
リクエスト例
GET 10.10.10.1:2886/api/v1/tenants/overview
レスポンス例
{
"successful": true,
"timestamp": "2024-10-14T11:53:10.9102776+08:00",
"duration": 16,
"status": 200,
"traceId": "73e93b51e1600be9",
"data": {
"contents": [
{
"tenant_id": 1,
"tenant_name": "sys",
"mode": "MYSQL",
"status": "NORMAL",
"locked": "NO",
"primary_zone": "RANDOM",
"locality": "FULL{1}@zone1, FULL{1}@zone2, FULL{1}@zone3",
"in_recyclebin": "NO",
"created_time": "2024-10-14T10:24:57.999108+08:00"
},
{
"tenant_id": 1002,
"tenant_name": "t1",
"mode": "MYSQL",
"status": "NORMAL",
"locked": "NO",
"primary_zone": "RANDOM",
"locality": "FULL{1}@zone2, FULL{1}@zone3",
"in_recyclebin": "NO",
"created_time": "2024-10-14T10:26:55.086821+08:00"
}
]
}
}
関連ドキュメント
APIインターフェースをコマンドラインで呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の詳細については、すべてのテナントの概要を取得するを参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の詳細については、すべてのテナントの概要を取得するを参照してください。