API情報
API種別 |
メソッド |
URI |
対象 |
名称 |
実行 |
契約 |
POST |
/:GisServiceCode/storage-archive.json |
ストレージアーカイブ |
ストレージアーカイブ追加申込 |
同期 |
- ストレージアーカイブを新規に申し込みます
- ストレージアーカイブを利用すると、ArchiveSizeに指定した容量までシステムストレージから作成したバックアップイメージを保存することができます
リクエストパラメータ
|
パラメータ |
必須 |
意味 |
値 |
URL |
GisServiceCode |
○ |
P2契約のサービスコード |
gis######## |
ボディ |
ArchiveSize |
○ |
ストレージアーカイブの容量(GB) |
数値(10~1000)。10GB単位のみ指定可能 |
レスポンス
フィールド |
タイプ |
意味 |
値 |
ServiceCode |
String |
ストレージアーカイブのサービスコード |
iar######## |
ContractStatus |
String |
契約状態
|
|
StartDate |
String |
利用開始日 |
YYYYMMDD |
StopDate |
String |
解約予定日 |
YYYYMMDD。未設定ならば空文字列 |
ArchiveSize |
String |
ストレージアーカイブの容量(GB) |
数値 |
Stat.Total |
String |
ストレージアーカイブの容量(MB) |
文字列 |
Stat.Used |
String |
ストレージアーカイブの使用量(MB) |
文字列 |
Stat.Free |
String |
ストレージアーカイブの空き容量(MB) |
文字列 |
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照して下さい
サンプル
リクエストボディ
{
"ArchiveSize": "20"
}
レスポンス (JSON)
Json
{
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"ServiceCode": "iar#######1",
"ContractStatus": "InService",
"StartDate": "YYYYMMDD",
"StopDate": "",
"ArchiveSize": "20",
"Stat": {
"Total": "20480MB",
"Used": "0MB",
"Free": "20480MB"
}
}