红帽全球峰会此内容没有您所选择的语言版本。
1.6. http://localhost:7080/rest/group : Deal with groups and DynaGroups
Defining class: org.rhq.enterprise.server.rest.GroupHandlerBean
Produces: application/json, application/xml, text/html, application/vnd.rhq.wrapped+json
Methods
GET /group
Description
List all groupsSupports returning a gzip'ed Content-Encoding
Expand Parameters: Name P.Type Description Required Type Allowed values Default value q Query String to search in the group name false String all ps Query Page size for paging false int all 20 page Query Page number for paging, 0-based false Integer all Return type: GroupRest (multi)
GET /group/{id}
Description
Get the group with the passed idExpand Parameters: Name P.Type Description Required Type Allowed values Default value id Path Id of the group true int all Return type: javax.ws.rs.core.Response
Expand Error codes: Code Reason 404 Group with passed id not found POST /group
Description
Create a new groupExpand Parameters: Name P.Type Description Required Type Allowed values Default value -body- A GroupRest object containing at least a name for the group true GroupRest all Return type: javax.ws.rs.core.Response
Expand Error codes: Code Reason 404 Resource type for provided type id does not exist 406 No group provided 406 Provided group has no name PUT /group/{id}
Description
Update the passed group. Currently only name change is supportedExpand Parameters: Name P.Type Description Required Type Allowed values Default value id Path Id of the group to update true int all -body- New version of the group true GroupRest all Return type: javax.ws.rs.core.Response
Expand Error codes: Code Reason 404 Group with the passed id does not exist 406 Updating the name failed DELETE /group/{id}
Description
Delete the group with the passed idNotes
This operation is by default idempotent, returning 204.If you want to check if the group existed at all, you need to pass the 'validate' query parameter.
Expand Parameters: Name P.Type Description Required Type Allowed values Default value id Path Id of the group to delete true int all validate Query Validate if the group exists false boolean all false Return type: javax.ws.rs.core.Response
Expand Error codes: Code Reason 204 Group was deleted or did not exist with validation not set 404 Group did not exist and validate was set GET /group/{id}/resources
Description
Get the resources of the groupSupports returning a gzip'ed Content-Encoding
Expand Parameters: Name P.Type Description Required Type Allowed values Default value id Path Id of the group to retrieve the resources for true int all Return type: ResourceWithType (multi)
Expand Error codes: Code Reason 404 Group with passed id does not exist PUT /group/{id}/resource/{resourceId}
Description
Add a resource to an existing groupNotes
If you have created the group as a compatible group and a resource type was provided on creation, only resources with this type may be added.
Expand Parameters: Name P.Type Description Required Type Allowed values Default value id Path Id of the existing group true int all resourceId Path Id of the resource to add true int all Return type: javax.ws.rs.core.Response
Expand Error codes: Code Reason 404 If there is no resource or group with the passed id 409 Resource type does not match the group one DELETE /group/{id}/resource/{resourceId}
Description
Remove the resource with the passed id from the groupNotes
This operation is by default idempotent, returning 204even if the resource was not member of the group.If you want to check if the resource existed at all, you need to pass the 'validate' query parameter.
Expand Parameters: Name P.Type Description Required Type Allowed values Default value id Path Id of the existing group true int all resourceId Path Id of the resource to remove true int all validate Query Validate if the resource exists in the group false boolean all false Return type: javax.ws.rs.core.Response
Expand Error codes: Code Reason 404 Group with the passed id does not exist 404 Resource with the passed id does not exist 204 Resource was removed from the group or was no member and validation was not set 404 Resource was no member of the group and validate was set GET /group/{id}/metricDefinitions
Description
Get the metric definitions for the compatible group with the passed idSupports returning a gzip'ed Content-Encoding
Expand Parameters: Name P.Type Description Required Type Allowed values Default value id Path Id of the group true int all Return type: javax.ws.rs.core.Response
Expand Error codes: Code Reason 404 Group with the passed id does not exist GET /group/definitions
Description
List all existing GroupDefinitionsSupports returning a gzip'ed Content-Encoding
Expand Parameters: Name P.Type Description Required Type Allowed values Default value q Query String to search in the group definition name false String all Return type: GroupDefinitionRest (multi)
GET /group/definition/{id}
Description
Retrieve a single GroupDefinition by idSupports returning a gzip'ed Content-Encoding
Expand Parameters: Name P.Type Description Required Type Allowed values Default value id Path The id of the definition to retrieve true int all Return type: GroupDefinitionRest
Expand Error codes: Code Reason 404 Group definition with the passed id does not exist. DELETE /group/definition/{id}
Description
Delete the GroupDefinition with the passed idNotes
This operation is by default idempotent, returning 204.If you want to check if the definition existed at all, you need to pass the 'validate' query parameter.
Expand Parameters: Name P.Type Description Required Type Allowed values Default value id Path The id of the definition to delete true int all validate Query Validate if the definition exists false boolean all false Return type: javax.ws.rs.core.Response
Expand Error codes: Code Reason 204 Definition was deleted or did not exist with validation not set 404 Definition did not exist and validate was set POST /group/definitions
Description
Create a new GroupDefinition.Notes
The name of the group is required in the passed definition, as well as a non-empty expression. A recalcInterval of 0 means to never recalculate.
Expand Parameters: Name P.Type Description Required Type Allowed values Default value -body- The group definition to use for the new group. true GroupDefinitionRest -all- -none- Return type: javax.ws.rs.core.Response
Expand Error codes: Code Reason 406 Passed group definition has no name 406 Passed expression was empty 406 Recalculation interval is < 0 409 There already exists a definition by this name 406 Group creation failed PUT /group/definition/{id}
Description
Update or recalculate an existing GroupDefinitionNotes
If the query param 'recalculate' is set to true, the group with the passed id is recalculated. Otherwise the existing group will be updated with the passed definition. The expression in the definition must be empty. If the name is emtpy, the old name is kept. A recalcInterval of 0 means no recalculation.
Expand Parameters: Name P.Type Description Required Type Allowed values Default value id Path Id for the definition to update true int all recalculate Query If true, trigger a re-calculation false boolean all false -body- The group definition to use for the update. This is required if recalculate is false. GroupDefinitionRest -all- -none- Return type: javax.ws.rs.core.Response
Expand Error codes: Code Reason 404 Group with the passed id does not exist 406 Passed expression was empty 406 Recalculation interval is < 0 406 Group membership calculation failed
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}