本記事では、APIを使用してクラスタ内のすべてのリソースプール情報を取得する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/resource-pools
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠するエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| data | []DbaObResourcePool | リソースプール情報。詳細については、DbaObResourcePoolのデータ構造を参照してください。 |
| error | ApiError | リクエストによって生成されたエラー。以下の情報が含まれます：
|
DbaObResourcePoolのデータ構造：
| パラメータ | タイプ | 説明 |
|---|---|---|
| id | int | リソースプールのID。 |
| name | string | リソースプールの名前。 |
| zone_list | string | リソースプールが配置されるゾーンのリスト。 |
| unit_num | int | リソースプールのユニット数。 |
| unit_config_id | int | リソースプールで使用されるリソース仕様のID。 |
| tenant_id | int | リソースプールが属するテナントID。 |
| replica_type | string | リソースプール上のレプリカタイプ。 |
| create_time | time.Time | リソースプールの作成時間。 |
| modify_time | time.Time | リソースプールの変更時間。 |
例
リクエスト例
GET 10.10.10.1:2886/api/v1/resource-pools
レスポンス例
{
"successful": true,
"timestamp": "2024-10-14T15:49:07.354211125+08:00",
"duration": 4,
"status": 200,
"traceId": "b1cebf73debb0d68",
"data": {
"contents": [
{
"id": 1,
"name": "sys_pool",
"zone_list": "zone1;zone2;zone3",
"unit_num": 1,
"UnitCount": 0,
"unit_config_id": 1,
"tenant_id": 1,
"replica_type": "FULL",
"CreateTime": "2024-10-14T10:24:57.972281+08:00",
"ModifyTime": "2024-10-14T10:24:57.982035+08:00"
},
{
"id": 1002,
"name": "t1_zone2_1728872814",
"zone_list": "zone2",
"unit_num": 1,
"UnitCount": 0,
"unit_config_id": 1001,
"tenant_id": 1002,
"replica_type": "FULL",
"CreateTime": "2024-10-14T10:26:55.045879+08:00",
"ModifyTime": "2024-10-14T10:26:55.562399+08:00"
},
{
"id": 1003,
"name": "t1_zone3_1728872814",
"zone_list": "zone3",
"unit_num": 1,
"UnitCount": 0,
"unit_config_id": 1001,
"tenant_id": 1002,
"replica_type": "FULL",
"CreateTime": "2024-10-14T10:26:55.057419+08:00",
"ModifyTime": "2024-10-14T10:26:55.562399+08:00"
}
]
}
}
関連ドキュメント
コマンドラインでAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の詳細については、すべてのリソースプール情報の取得を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の詳細については、すべてのリソースプール情報の取得を参照してください。