前のトピック: vol オブジェクト

次のトピック: info メソッド(vol オブジェクト)

list メソッド(vol オブジェクト)

説明

アプリケーション内のボリュームを一覧表示します。

構文
/api/v1/vol/list?app=application&vdc=controller-name 
引数
application

アプリケーションの名前

controller-name

ターゲットの仮想データ センターの名前

トランザクション タイプ

同期

リクエスト タイプ

GET

テストのボリュームを一覧表示します。

GET http://192.168.123.200/api/v1/vol/list?app=test&vdc=mygrid 
サンプル出力

XML

<volume> 
   <name>vol1</name> 
   <comment></comment> 
   <filesystem>ext3</filesystem> 
   <mount_state>available</mount_state> 
   <n_mirrors>1</n_mirrors> 
   <scope_name>test</scope_name> 
   <scope_type>application</scope_type> 
    <server>srv1</server>
   <size>1073741824</size> 
   <state>ok</state> 
   <uuid>cf432100-63fc-450d-8eb7- 2da6deca8627</uuid> 
</volume> 



JSON

{ 
   "scope_type" : "application", 
   "name" : "vol1", 
   "scope_name" : "test", 
   "mount_state" : "available", 
   "uuid" : "cf432100-63fc-450d-8eb7-2da6deca8627", 
   "size" : "1073741824", 
   "state" : "ok", 
   "comment" : "", 
   "filesystem" : "ext3", 
   "n_mirrors" : "1", 
   "server" : "srv1" 
} 

メモ

JSON の出力はすべて UTF8 にエンコードされています。 UTF8 デコードを使用して UTF8 にエンコードされた出力をデコードします。

UTF8 にエンコードされた JSON 出力をデコードするシンプルな PHP スクリプトの例を以下に示します。

<? 
$json = '{"a": "¥u00e3¥u0081¥u0082" }'; 
$j = json_decode($json); 
echo utf8_decode($j->{'a'}); 
?>

HTTP エラー コード
404

エンティティ vdc mygrid が見つかりません。WS_API アプリケーションに設定されていない VDC 名が指定されました。

400.4

必要な引数(app)がありません。 リクエストに引数 app=app がありません。

404

アプリケーション test がありません。 リクエストに無効なアプリケーションが指定されています。