API情報
API種別 |
メソッド |
URI |
対象 |
名称 |
実行 |
契約 |
POST |
/:GisServiceCode/system-storages.json |
システムストレージ |
システムストレージ追加申込 |
非同期 |
- システムストレージを新規に申し込みます
- システムストレージはOSがインストールされたストレージであり、仮想サーバのブートデバイスとして接続して利用します
- ストレージグループを省略すると、自動的にXまたはYのグループにアサインされます。通常は指定する必要はありませんが、ストレージグループを指定することで収容設備を分けることができるため、複数のサーバを冗長化のために組み合わせて利用したい場合には一方のサーバに接続するストレージをX、他方をYに指定してください。それにより、障害時やメンテナンス時の影響範囲をコントロールできるようになります
- このAPIのレスポンスはシステムストレージの準備を待つことなく戻ります。準備中は契約状態(ContractStatus)がInPreparetionとなり、準備が整うとInServiceとなります
- InServiceとなったときのステータス(ResourceStatus)は、NotAttachedとなります
- InPreparationの間にステータスを取得することはできません(空文字になる)
- ストレージアーカイブに保存されているイメージを利用する場合は ImageId を指定してください
- インスタントクローニングを利用する場合は SourceServiceCode にクローン元のシステムストレージを指定してください
- ImageId と SourceServiceCode は両方を同時に指定することができません
- Windows品目では ImageId もしくは SourceServiceCode を指定しての追加はできません
リクエストパラメータ
|
パラメータ |
必須 |
意味 |
値 |
URL |
GisServiceCode |
○ |
P2契約のサービスコード |
gis######## |
ボディ |
Type |
○ |
ストレージ品目
|
|
|
Encryption |
○ |
暗号化 |
"Yes", "No" |
|
StorageGroup |
|
ストレージグループ。省略時はどちらかのグループへ自動的に割り当てられます |
"Y", "Z" |
|
ImageId |
|
利用するイメージのイメージID |
数値 |
|
SourceServiceCode |
|
インスタントクローニングのクローン元とするストレージのサービスコード |
ica######## |
レスポンス
フィールド |
タイプ |
意味 |
値 |
ServiceCode |
String |
システムストレージのサービスコード |
iba########, ica######## |
Label |
String |
ラベル |
文字列 |
ContractStatus |
String |
契約状態
|
|
StartDate |
String |
利用開始日 |
YYYYMMDD |
StopDate |
String |
解約予定日 |
YYYYMMDD |
Type |
String |
システムストレージ品目
|
|
OSType |
String |
OS種別 |
Linux", Windows" |
StorageSize |
String |
ストレージ容量 |
数値 |
ResourceStatus |
String |
ストレージステータス
|
|
StorageGroup |
String |
ストレージグループ |
"Y", "Z" |
Mode |
String |
ストレージのモード |
"Basic", "Clone" |
Encryption |
String |
暗号化 |
"Yes", "No" |
SourceServiceCode |
String |
インスタントクローニングのクローン元ストレージのサービスコード |
ica######## |
DestinationServiceCodes |
Array |
インスタントクローニングのクローン先ストレージのサービスコード |
契約直後のシステムストレージはインスタントクローニングのクローン元となっていないため、空になります |
AttachedVirtualServer |
Object |
接続された仮想サーバ |
契約直後のシステムストレージは仮想サーバに接続されていないため、空になります |
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照して下さい
サンプル
リクエストボディ
# 通常
{
"Type": "SX30GB_CENTOS7_64",
"Encryption": "Yes",
"StorageGroup": "Y"
}
# イメージ指定追加
{
"Type": "SX30GB_CENTOS7_64",
"Encryption": "Yes",
"StorageGroup": "Y",
"ImageId": "1"
}
# インスタントクローニング
{
"Type": "SX30GB_CENTOS7_64",
"Encryption": "Yes",
"StorageGroup": "Y",
"SourceServiceCode": "ica########"
}
レスポンス (JSON)
Json
{
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"ServiceCode": "iba#######1",
"Label": "",
"ContractStatus": "InPreparation",
"StartDate": "",
"StopDate": "",
"Type": "S30GB_CENTOS7_64",
"OSType": "Linux",
"StorageSize": "30",
"ResourceStatus": "",
"StorageGroup": "Y",
"SourceServiceCode": "",
"DestinationServiceCodes": [
],
"AttachedVirtualServer": {
}
}