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

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

説明

グループ情報を表示します。 表示される情報には次のものがあります： グループ名、ID、スコープ、説明、プリンシパル グループ メンバなど。

構文

/api/v2/group/get?group=group&vdc=controller-name 

引数

group

グループの名前

vdc

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

トランザクション タイプ

同期

リクエスト タイプ

GET

例

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

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

グループ mygroup のグループ情報を取得します

GET
http://192.168.123.200/api/v2/group/get?group=mygroup&vdc=mygrid

サンプル出力

JSON：

{
   "group" : {
      "can_own" : "0",
      "name" : "mygroup",
      "id" : "1c534f9d-e26d-41e8-922f-4649743b9e98",
      "description" : "",
      "scope" : "local"
   }
}

XML：

<group>
  <can_own>0</can_own>
  <description></description>
  <id>1c534f9d-e26d-41e8-922f-4649743b9e98</id>
  <name>mygroup</name>
  <scope>local</scope>
</group>

HTTP エラー コード

400

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

400.4

必要な引数（app）がありません。
- 引数 group=group がありません。

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