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

modify 方法（group 对象）

说明

替换本地组的说明或成员资格。

语法

/api/v2/group/modify?group=group&add_principal=add_principal&remove_principal=remove_principal&vdc=controller-name 

参数

group

组名称

add_principal

要添加到组的经过 URL 编码的主体列表（以 / 分隔）。

例如：local:user:api@3tera.com 应以 local%3Auser%3Aapi%403tera.com 的形式传递

例如：local:user:api@3tera.com /local:user:test@3tera.com 应以 local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com 的形式传递

remove_principal

要从组中删除的经过 URL 编码的主体列表（以 / 分隔）。

例如：local:user:api@3tera.com 应以 local%3Auser%3Aapi%403tera.com 的形式传递

例如：local:user:api@3tera.com /local:user:test@3tera.com 应以 local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com 的形式传递

vdc

目标虚拟数据中心的名称

事务类型

同步

请求类型

GET

示例

将整个说明替换为“API GROUP”，但不更改成员身份

                                                                                                                                   
GET
http://192.168.123.200/api/v2/group/modify?group=mygroup&description=API%20Group&add_principal=&remove_principal=&vdc=mygrid

将整个说明替换为“API GROUP”并将 local:user:api@3tera.com 添加到成员身份中，并从 mygroup 中删除 local:user:test@3tera.com。

GET
http://192.168.123.200/api/v2/group/put?group=mygroup&description=API%20Group&add_principal=local%3Auser%3Aapi%403tera.com&remove_principal=local%3Auser%3Atest%403tera.com&vdc=mygrid

将整个说明替换为“API GROUP”并将 local:user:api@3tera.com 和 local:user:test@3tera.com 从 mygroup 中删除。

GET
http://192.168.123.200/api/v2/group/put?group=mygroup&description=API%20Group&remove_principal=local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com&add_principal=&vdc=mygrid

样例输出

JSON：

{
   "message" : ""
} 

XML：

<message></message>

HTTP 错误代码

400

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

400.4

缺少必要的参数（add_principal、remove_principal、can_own 或 description）。

404.1

未找到实体－组 mygroup 不存在。

－指定的组在 mygrid 上不存在。

未找到实体－无法放置应用 ACL－主体数据无效－主体本地用户“test@3tera.com”不存在。

－指定的主体无效

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