本記事では、APIを使用して指定された既存のリソース仕様情報を照会する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/unit/config/:name
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠したエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| data | DbaObUnitConfig | リソース仕様の詳細情報です。詳細については、以下のDbaObUnitConfigのデータ構造を参照してください。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます：
|
DbaObUnitConfigのデータ構造：
| パラメータ | タイプ | 説明 |
|---|---|---|
| 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の下限。 |
| create_time | time.Time | リソース仕様の作成時間。 |
| modify_time | time.Time | リソース仕様の変更時間。 |
例
リクエスト例
GET 10.10.10.1:2886/api/v1/unit/config/s1
実行結果例
{
"successful": true,
"timestamp": "2024-10-14T15:38:47.840091518+08:00",
"duration": 5,
"status": 200,
"traceId": "93050d8f34a63e06",
"data": {
"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,
"create_time": "2024-10-14T10:26:41.286401+08:00",
"modify_time": "2024-10-14T10:26:41.286401+08:00"
}
}
関連ドキュメント
コマンドラインからAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の詳細については、指定されたリソース仕様情報の照会を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の詳細については、指定されたリソース仕様情報の照会を参照してください。