本記事では、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ステータスコード仕様に準拠したエンコードです。 |
| traceId | string | リクエストのTrace IDです。 |
| error | ApiError | リクエストで発生したErrorで、以下の情報が含まれます：
|
例
リクエスト例
{
"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を呼び出すこともできます。