API情報
API種別 |
メソッド |
URI |
対象 |
名称 |
実行 |
設定 |
PUT |
/:GisServiceCode/system-storages/:StorageServiceCode/action.json |
システムストレージ |
OS初期化 |
非同期 |
- 指定したシステムストレージを指定したバージョンのOSで初期化します
- Versionに指定できる値は、システムストレージの品目(OS)によって異なります。コントロールパネルのOS初期化画面でご確認ください
- Versionを省略した場合、選択できる最新のバージョンとなります
- システムストレージを新規に契約する場合、常に最新のバージョンが選択されるため、明示的に古いバージョンのシステムストレージを利用するには、契約後にあらためてOS初期化を行うか、ストレージアーカイブを利用してください
- APIのレスポンスは初期化が終わるのを待つことなく戻ります
- 初期化が始まるとシステムストレージのステータスはInitializingとなり、完了するとAttached、またはNotAttachedに戻ります
- このAPIでOS種別を変更することはできません
- このAPIを利用するには、接続された仮想サーバを停止しておくか、システムストレージを切り離しておく必要があります
- インスタントクローニングのクローン元もしくはクローン先となっているシステムストレージのOS初期化はできません
リクエストパラメータ
|
パラメータ |
必須 |
意味 |
値 |
URL |
GisServiceCode |
○ |
P2契約のサービスコード |
gis######## |
|
StorageServiceCode |
○ |
システムストレージのサービスコード |
iba########, ica######## |
ボディ |
Image |
○ |
操作内容 |
"Initialize" |
|
Version |
|
OSのバージョン。省略時は最新バージョンが選択される |
文字列。指定可能な値はコントロールパネルでOS初期化を実行するときに、ドロップダウンボックスに表示されるものと同じ |
レスポンス
フィールド |
タイプ |
意味 |
値 |
Current.ResourceStatus |
String |
設定後のストレージステータス
|
|
Previous.ResourceStatus |
String |
設定前のストレージステータス
|
|
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照して下さい
サンプル
リクエストボディ
{
"Image": "Initialize",
"Version": "XXXX"
}
レスポンス (JSON)
Json
{
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"Current": {
"ResourceStatus": "Initializing"
},
"Previous": {
"ResourceStatus": "NotAttached"
}
}