CA 3Tera AppLogic API の有効なオブジェクト › group オブジェクト › list メソッド（group オブジェクト）

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

説明

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

構文

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

引数

なし

トランザクション タイプ

同期

リクエスト タイプ

GET

例

mygroup という名前のローカル グループを作成します

GET
http://192.168.123.200/api/v1/group/create?group=mygroup&vdc=mygrid
 

例

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

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

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

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

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

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

サンプル出力

JSON

{
   "group[0]" : {
      "name" : "admin",
      "description" : "us",
      "scope" : "local"
   },
   "group[1]" : {
      "name" : "mygroup",
      "description" : "",
      "scope" : "local"
   }
}

XML

<opt>
  <group[0]>
    <name>admin</name>
    <description>us</description>
    <scope>local</scope>
  </group[0]>
  <group[1]>
    <name>mygroup</name>
    <description></description>
    <scope>local</scope>
  </group[1]>
</opt>

HTTP エラー コード

400

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

注

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