スナップショットの一覧を取得します。
リクエストパラメーター
パラメーター名 | 項目 | 項目説明 |
|---|---|---|
Version | 説明 | CFMG APIのバージョンID |
型 | string ASCII | |
設定内容 | 固定。「1.0」を指定してください。 | |
Locale | 説明 | CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。 |
型 | string ASCII | |
設定内容 | 以下から選択します。 | |
Action | 説明 | 実行するCFMG APIの名称 |
型 | string ASCII | |
設定内容 | 固定。「ListSnapshot」を指定してください。 | |
userId | 説明 | CFMG APIを実行するユーザーID |
型 | string ASCII | |
設定内容 | 31文字以内 | |
orgId | 説明 | CFMG APIを実行するユーザーの組織ID |
型 | string ASCII | |
設定内容 | 8文字以内 | |
vsysId | 説明 | システムID |
型 | string ASCII | |
設定内容 | 32文字以内 | |
vserverId | 説明 | スナップショットの一覧を取得する仮想マシンID |
型 | string ASCII | |
設定内容 | 32文字以内 |
レスポンス
《ステータスコード》
正常に終了した場合に「200 OK」を返します。
《XML》
<?xml version="1.0" encoding="UTF-8"?>
<ListSnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
<responseMessage>[メッセージ]</responseMessage>
<responseStatus>[ステータス]</responseStatus>
<snapshots>
<snapshot>
<snapshotId>[スナップショットID]</snapshotId>
<comment>[スナップショットのコメント]</comment>
<snapshotTime>[スナップショットの作成日時]</snapshotTime>
</snapshot>
</snapshots>
</ListSnapshotResponse>《要素》
要素名 | 項目 | 項目説明 |
|---|---|---|
ListSnapshotResponse | 説明 | レスポンスの情報を持つ要素 |
型 | なし | |
出現回数 | 1 | |
responseMessage | 説明 | メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「付録A メッセージ」を参照してください。 |
型 | string UTF-8 | |
出現回数 | 1 | |
responseStatus | 説明 | ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。 |
型 | string ASCII | |
出現回数 | 1 | |
snapshots | 説明 | スナップショット情報のレスポンス情報を持つ要素 |
型 | なし | |
出現回数 | 0または1 | |
snapshot | 説明 | スナップショット情報の一式 |
型 | なし | |
出現回数 | 0以上 | |
snapshotId | 説明 | スナップショットID |
型 | string ASCII | |
出現回数 | snapshotの数分(それぞれに対して0または1) | |
comment | 説明 | スナップショットのコメント |
型 | string UTF-8 | |
出現回数 | snapshotの数分(それぞれに対して0または1) | |
snapshotTime | 説明 | スナップショットの作成日時 |
型 | string UTF-8 | |
出現回数 | snapshotの数分(それぞれに対して0または1) |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8"?>
<ListSnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
<responseMessage>PAPI00000 Processing was completed.</responseMessage>
<responseStatus>SUCCESS</responseStatus>
<snapshots>
<snapshot>
<comment>コメント</comment>
<snapshotId>image000001</snapshotId>
<snapshotTime>2010-11-12 10:00:11±09:00</snapshotTime>
</snapshot>
<snapshot>
<comment>コメント</comment>
<snapshotId>image000002</snapshotId>
<snapshotTime>2010-11-12 10:00:11±09:00</snapshotTime>
</snapshot>
</snapshots>
</ListSnapshotResponse>