1.6. http://localhost:7080/rest/group : グループおよび DynaGroups を使用したデバッグ
リソースグループおよびグループ定義に対応する API
定義クラス： org.rhq.enterprise.server.rest.GroupHandlerBean
生成される - application/json、application/xml、text/html、application/vnd.rhq.wrapped+json
メソッド
GET /group
description
すべてのグループを一覧表示します。gzip ed Content-Encoding の返信をサポートします。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 q クエリー グループ名で検索する文字列 false string all ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ番号、0 ベース false 整数 all 戻りタイプ： GroupRest(multi)
GET /group/{id}
description
渡された ID でグループを取得します。パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 id path グループの ID true int all return type: javax.ws.rs.core.Response
エラーコード： code reason 404 渡された ID のグループが見つからない POST /group
description
新規グループの作成パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 -body- グループの名前が少なくとも含まれる GroupRest オブジェクト true GroupRest all return type: javax.ws.rs.core.Response
エラーコード： code reason 404 指定されたタイプ id のリソースタイプが存在しません。 406 指定されていない 406 指定グループの名前がない PUT /group/{id}
description
渡されたグループを更新します。現時点では、名前の変更のみがサポートされます。パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 id path 更新するグループの ID true int all -body- グループの新バージョン true GroupRest all return type: javax.ws.rs.core.Response
エラーコード： code reason 404 渡された ID を持つグループは存在しません。 406 名前の更新に失敗しました。 /group/{id} の削除
description
渡された ID のグループを削除します。注記
この操作はデフォルトでべきべき等で、204. グループが存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 id path 削除するグループの ID true int all Validate クエリー グループが存在するかどうかを検証します。 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード： code reason 204 検証が設定されていないグループが削除されるか、または存在しない 404 グループが存在しておらず、検証が設定されている GET /group/{id}/resources
description
グループのリソースを取得します。gzip ed Content-Encoding の返信をサポートします。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 id path リソースを取得するグループの ID true int all return type: ResourceWithType(multi)
エラーコード： code reason 404 渡された ID を持つグループは存在しません。 PUT /group/{id}/resource/{resourceId}
description
既存グループにリソースを追加する注記
グループを互換性のあるグループとして作成し、リソースタイプが作成時に提供されている場合は、このタイプを持つリソースのみを追加できます。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 id path 既存グループの ID true int all resourceId path 追加するリソースの ID true int all return type: javax.ws.rs.core.Response
エラーコード： code reason 404 渡された ID のリソースまたはグループがない場合 409 リソースタイプがグループタイプと一致しません。 DELETE /group/{id}/resource/{resourceId}
description
渡された id を持つリソースをグループから削除します。注記
この操作はデフォルトでべき等で、リソースがグループのメンバーでない場合は 204 even を返します。リソースが全く存在しないかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 id path 既存グループの ID true int all resourceId path 削除するリソースの ID true int all Validate クエリー リソースがグループに存在するかどうかを検証します。 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード： code reason 404 渡された ID を持つグループは存在しません。 404 渡された ID のリソースが存在しない 204 リソースがグループから削除されているか、メンバーもありませんでした。検証は設定されませんでした。 404 リソースはグループのメンバーではなく、検証に設定されました。 GET /group/{id}/metricDefinitions
description
渡された ID と互換性のあるグループのメトリクス定義を取得します。gzip ed Content-Encoding の返信をサポートします。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 id path グループの ID true int all return type: javax.ws.rs.core.Response
エラーコード： code reason 404 渡された ID を持つグループは存在しません。 GET /group/definitions
description
既存の GroupDefinition の一覧表示gzip ed Content-Encoding の返信をサポートします。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 q クエリー グループ定義名で検索する文字列 false string all 戻りタイプ： GroupDefinitionRest(multi)
GET /group/definition/{id}
description
id 別に単一の GroupDefinition の取得gzip ed Content-Encoding の返信をサポートします。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得する定義の ID true int all 戻りタイプ： GroupDefinitionRest
エラーコード： code reason 404 渡された ID のグループ定義は存在しません。 /group/definition/{id} の削除
description
渡された ID で GroupDefinition を削除します。注記
この操作はデフォルトでべき等で、204. 定義が存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 id path 削除する定義の ID true int all Validate クエリー 定義が存在するかどうかの検証 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード： code reason 204 検証が設定されていないため、定義が削除されているか、または存在しない 404 定義は存在せず、検証が設定された。 /group/definitions
description
新規 GroupDefinition を作成します。注記
グループの名前は、渡された定義と空でない式で必要です。recalcInterval が 0 の場合は、再計算しないことを意味します。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 -body- 新規グループに使用するグループ定義。 true GroupDefinitionRest -all- -none- return type: javax.ws.rs.core.Response
エラーコード： code reason 406 渡されたグループ定義の名前がない 406 渡された式が空である 406 再計算の間隔は < 0 です。 409 この名前の定義がすでに存在します。 406 グループの作成に失敗する PUT /group/definition/{id}
description
既存の GroupDefinition を更新または再計算する注記
クエリー param 'recalculate' が true に設定されている場合、渡された ID のグループは再計算されます。それ以外の場合は、既存のグループが渡された定義で更新されます。定義の式は空である必要があります。名前が emtpy の場合、古い名前は保持されます。recalcInterval が 0 の場合は再計算しないことを意味します。
パラメーター： Name P.Type description 必須 type 許可される値 デフォルト値 id path 更新する定義の ID true int all 再計算 クエリー true の場合、再計算をトリガーします。 false ブール値 all false -body- 更新に使用するグループ定義。これは、再計算が false の場合に必要です。 GroupDefinitionRest -all- -none- return type: javax.ws.rs.core.Response
エラーコード： code reason 404 渡された ID を持つグループは存在しません。 406 渡された式が空である 406 再計算の間隔は < 0 です。 406 グループメンバーシップの計算に失敗しました。
