Skip to main content

GET /api/v1/managers-management/managers

Use this method to return a list of all resource managers.

Note
This REST API requires Lenovo XClarity Orchestrator v2.0.0 or later.

Authentication​

Authentication with user name and password is required.

Resource URI​

GET https://{orchestrator_server_IP}/api/v1/managers-management/managers

Query parameters​

This REST API supports query parameters for paginating, filtering, sorting, including data, and excluding data in the response. For more information about these common query parameters, see Paginating, scoping, filtering, sorting, including data, and excluding data in responses. For a list of supported attributes, see GET /api/v1/managers-management/managers/{id}.

The following example returns a list of all resource managers.
GET https://192.0.2.0/api/v1/managers-management/managers
The following example returns a list of all unhealthy resource managers.
GET https://192.0.2.0/api/v1/managers-management/managers
?filterNotEquals[][attributes]=healthState&filterNotEquals[][values]=Normal

Request body​

None

Response codes​

CodeDescriptionComments
200OK The request completed successfully. If a single query parameter is specified and the value of that parameter has no matches, the response body returns default values. If a list of query parameters is specified and the value of at least one parameter has no matches, the response body returns only what matches.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).

AttributesTypeDescription
resultsArray of objectsInformation about each resource manager
 idStringManager ID
 connectTimestampStringTimestamp when the resource manager was registered with the orchestrator server

This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage.

 healthStateStringHealth state (translated). This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
 nameStringResource manager name
 typeStringType of resource manager. This can be the following value.
  • XClarity Management Hub
  • XClarity Administrator
  • XClarity Orchestrator
  • Schneider EcoStruxure IT
  • VMware vRealize Operations Manager
 _linksObjectResource URI (see Links)
 _uiObjectInformation about UI-specific attributes
  healthStateKeyStringHealth state key. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
_metadataObjectRequest metadata (see Metadata)
The following example is returned if the request is successful.
{
   "results": [{
      "id": "53788A673607458DA14766162020FDAD",
      "connectTimestamp": "2022-08-02T03:21:20.079Z",
      "healthState": "Normal",
      "name": "10.241.54.10",
      "type": "XClarity Administrator",
      "_links": {
         "rel": "self",
         "uri": "/api/v1/managers-management/managers/53788A673607458DA14766162020FDAD"
      },
      "_ui": {
         "healthStateKey": "Normal"
      }
   },
   ...,
   {
      "type": "XClarity Orchestrator",
      "healthState": "Normal",
      "id": "00000000000000000000000000000000",
      "name": "XClarity Orchestrator",
      "_links": {
         "rel": "self",
         "uri": "/api/v1/managers-management/managers/00000000000000000000000000000000"
      },
      "_ui": {
         "healthStateKey": "Normal"
      }
   }],
   "_metadata": {...}
}