GET /resourceGroups

Use this method to return information about all resource groups.

Note: This API requires Lenovo XClarity Administrator v2.0.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/resourceGroups

Query parameters

None

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
409 Conflict There is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
groupList Array of objects List of all resource groups
  See GET /resourceGroups/{UUID} Object Detailed information about each resource group
The following example is returned if the request is successful.
{
   "groupList": [{
      "criteria": null,
      "description": "Business application VMware clusters",
      "healthStatus": "Normal",
      "members": [
         "nodes/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", 
         "nodes/BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB" 
      ],
      "memberUuids": [
         "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", 
         "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB"
      ],
      "name": "e-Commerce Servers",
   "query": null
   "rsql": null,
      "type": "static",
      "uuid": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"
   },
   {
      "criteria": {
         "criteria": [{
            "id": "1000",
            "operator": "equals",
            "parent": "root",
            "property": "overallHealthState",
            "value": "Critical"
         },
         {
            "id": "1002",
            "operator": "contains",
            "parent": "root",
            "property": "location.location",
            "value": "Lab10"
         },
         {
            "id": "1002",
            "operator": "contains",
            "parent": "root",
            "property": "location.rack",
            "value": "rack1"
         },
         {
            "criteria": [{
               "id": "1004",
               "operator": "contains",
               "parent": "1003",
               "property": "machineType",
               "value": "7X07"
            },
            {
               "id": "1005",
               "operator": "contains",
               "parent": "1003",
               "property": "machineType",
               "value": "7X08"
            }],
            "id": "1003",
            "operator": "OR",
            "parent": "root"
         }],
         "id": "root",
         "operator": "AND",
         "parent": "root"
     },
      "description": "All ThinkSystem SR530 servers in room 1 in Lab10 that have critical errors",
      "healthStatus": "Normal",
      "members": [
         "nodes/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", 
         "nodes/BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", 
         "nodes/CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC"
      ],
      "memberUuids": [
         "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", 
         "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", 
         "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC"
      ],
      "name": "Critical SR530 servers",
   "query": null
   "rsql": null,
      "type": "dynamic",
      "uuid": "GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG"
   }]
{