本記事では、APIを使用してユニットリソース仕様を作成する方法について説明します。
呼び出しの説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
POST /api/v1/unit/config
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| name | string | はい | s1 | 作成するリソースの仕様名。 |
| memory_size | string | はい | 5G | メモリの仕様を指定します。最小値は、隠れた構成パラメータ__min_full_resource_pool_memoryによって制御されます(デフォルトは5G)。システムの安定性を確保するため、メモリの仕様の最小値は4Gに設定することを推奨します。 |
| max_cpu | float64 | はい | 2 | CPU仕様の上限を指定します。最小値は1で、1コアを表します。 |
| min_cpu | float64 | いいえ | 2 | CPU仕様の下限を指定します。最小値は1で、1コアを表します。指定されていない場合、デフォルトではmax_cpuの値と同じになります。 |
| max_iops | int | いいえ | 1024 | IOPSの上限を指定します。最小値は1024で、設定する値はmin_iopsの値以上である必要があります。指定されていない場合、システムは次のルールに基づいてmax_iopsの値を自動的に計算します：
|
| min_iops | int | いいえ | 1024 | IOPSの下限を指定します。最小値は1024です。指定されていない場合、システムは次のルールに基づいてmin_iopsの値を自動的に計算します：
|
| log_disk_size | string | いいえ | 15G | テナントログディスク容量のサイズを指定します。指定されていない場合、デフォルトではメモリ仕様の3倍のサイズになり、最小値は2Gです。 |
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠したエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます：
|
例
リクエスト例
{
"name":"s1",
"memory_size": "5GB",
"max_cpu": 3,
}
実行結果例
{
"successful": true,
"timestamp": "2024-09-24T19:59:04.310305176+08:00",
"duration": 10,
"status": 200,
"traceId": "7d9bd52cc65cd449"
}
関連ドキュメント
コマンドラインからAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。