統合ガイド › Web サービス API リファレンス ガイド › 有効なオブジェクト › group オブジェクト › list メソッド（group オブジェクト）

list メソッド（group オブジェクト）

説明

グリッド コントローラのローカル ディレクトリ サービス データベース内のグループと、グローバル ディレクトリ サービス データベース内のグループを一覧表示します（グリッドで該当するサービスを使用するよう設定されている場合）。

構文

/api/v2/group/list?vdc=controller-name 

引数

vdc （オプション）

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

トランザクション タイプ

同期

リクエスト タイプ

GET

例

グループを一覧表示します

GET
http://192.168.123.200/api/v2/group/list?vdc=mygrid

ローカル グループの一覧表示

GET
http://192.168.123.200/api/v2/group/list?local&vdc=mygrid

グローバル グループを一覧表示します

GET
http://192.168.123.200/api/v2/group/list?global&vdc=mygrid

サンプル出力

JSON：

{
   "group" : [
      {
         "can_own" : "0",
         "name" : "local:admin",
         "description" : "",
         "scope" : "local"
      },
      {
         "can_own" : "0",
         "name" : "local:all",
         "description" : "implicitly contains all users as members",
         "scope" : "local"
      }
   ]
}

XML：

<groups>
  <group>
    <can_own>0</can_own>
    <description></description>
    <name>local:admin</name>
    <scope>local</scope>
  </group>
  <group>
    <can_own>0</can_own>
    <description>implicitly contains all users as members</description>
    <name>local:all</name>
    <scope>local</scope>
  </group>
</groups>

HTTP エラー コード

400

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

注： この API は WS_API_r6-1.0.6-1 以降で使用できます。