前のトピック: info メソッド(group オブジェクト)

次のトピック: modify メソッド(group オブジェクト)


put メソッド(group オブジェクト)
説明

ローカル グループの説明とメンバシップ全体を置換します。

構文
/api/v1/group/put?group=group&description=description&principal=principal&vdc=controller-name 
引数
group

グループの名前

説明

グループの URL エンコードされた所有者の説明

プリンシパル

プリンシパルの 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」に置換し、メンバシップを mygroup の単一のプリンシパル local:user:api@3tera.com に置換します。


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

説明全体を「API GROUP」に置換し、メンバシップを mygroup のプリンシパル local:user:api@3tera.com および local:user:test@3tera.com に置換します。


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

サンプル出力
JSON:

{
   "message" : ""
} 

XML:

<message></message>

HTTP エラー コード
400

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

400.4

必要な引数(group)がありません。

- 引数 group=group がありません

必要な引数(description)がありません

- 引数 description=description

必要な引数(principal)がありません

- 引数 principal=principal がありません

404.1

エンティティが見つかりません - グループ mygroup は存在しません。

- mygrid に存在しないグループが指定されました。

エンティティが見つかりません - アプリケーション ACL の配置に失敗しました - プリンシパルのデータが無効です - プリンシパルのローカル ユーザ「test@3tera.com」が存在しません。

- 無効なプリンシパルが指定されました

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