集成指南 › Web 服务 API 参考指南 › CA AppLogic API 的有效对象 › group 对象 › get 方法（group 对象）

get 方法（group 对象）

说明

显示组信息。 显示的信息包括：组名称、ID、范围、说明以及主要组成员。

语法

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

参数

group

组名称

vdc

目标虚拟数据中心的名称

事务类型

同步

请求类型

GET

示例

创建名为 mygroup 的本地组

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

获取组 mygroup 的组信息

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

样例输出

JSON：

{
   "group" : {
      "members" : {
         "members[2]" : {
            "name" : "*",
            "id" : "f29c1426-10c1-4715-a763-b0bcc4b8b9d5",
            "type" : "user",
            "scope" : "local"
         },
         "members[0]" : {
            "name" : "apimig@3tera.com",
            "id" : "e1a5357f-204b-4cd3-9ca8-9e09f45b21c6",
            "type" : "user",
            "scope" : "local"
         },
         "members[1]" : {
            "name" : "api@3tera.com",
            "id" : "4f865f5b-e63a-410a-9d9a-96427c3ecfc7",
            "type" : "user",
            "scope" : "local"
         },
         "members[3]" : {
            "name" : "apoorva@3tera.com",
            "id" : "b543eff7-db88-4d79-a11c-4de22d5e6d3b",
            "type" : "user",
            "scope" : "local"
         }
      },
      "name" : "mygroup",
      "id" : "a5cb10bc-7291-4a86-84f8-74419fc9ae63",
      "description" : "us",
      "scope" : "local"
   }
}

XML：

<group>
  <name>mygroup</name>
  <description>us</description>
  <id>a5cb10bc-7291-4a86-84f8-74419fc9ae63</id>
  <members>
    <name>apimig@3tera.com</name>
    <id>e1a5357f-204b-4cd3-9ca8-9e09f45b21c6</id>
    <scope>local</scope>
    <type>user</type>
  </members>
  <members>
    <name>api@3tera.com</name>
    <id>4f865f5b-e63a-410a-9d9a-96427c3ecfc7</id>
    <scope>local</scope>
    <type>user</type>
  </members>
  <members>
    <name>*</name>
    <id>f29c1426-10c1-4715-a763-b0bcc4b8b9d5</id>
    <scope>local</scope>
    <type>user</type>
  </members>
  <scope>local</scope>
</group>

HTTP 错误代码

400

未找到实体 vdc mygrid
－WS_API 应用中没有配置指定的 VDC 名称。

400.4

缺少必需参数 (app)。
－缺少参数 group=group。

注意：此 API 可用于 WS_API_r6-1.0.6-1 及更高版本。