Skip to main content

GET /api/v1/connector/managers

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

Attention
This REST API will be deprecated in a future release. Use GET /api/v1/managers-management/managers instead.

Authentication

Authentication with user name and password is required.

Resource URI

GET https://{orchestrator_server_IP}/api/v1/connector/managers

Query parameters

This REST API supports query parameters for paginating, scoping, 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/connector/managers/{id}.

The following example returns a list of all resource managers.
GET https://192.0.2.0/api/v1/connector/managers
The following example returns a list of all unhealthy resource managers.
GET https://192.0.2.0/api/v1/connector/managers
?filterNotEquals[][attributes]=healthState&filterNotEquals[][values]=Normal
The following example returns a list of all resource managers running version 1.0.
GET https://192.0.2.0/api/v1/connector/managers
?filterEquals[][attributes]=updateMetadata.components.version.number&filterEquals[][values]=1.0

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.
206Partial ContentPartial content was returned for a multi-part response. The response header includes a content-range header field indicating the range that is included in the response body for each part.
408Request TimeoutThe orchestrator server did not receive a required request in a specific amount of time. A descriptive error message is returned in the response body.
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
 idStringResource manager ID
 connectTimestampStringTimestamp when the resource manager was registered with XClarity Orchestrator

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
 healthStateKeyStringHealth state key. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
 nameStringResource manager name
Note
For Lenovo XClarity Administrator, this is the IP address of the management server.
 typeStringType of resource manager. This can be one of the following values.
  • XClarity Management Hub
  • XClarity Administrator
  • XClarity Orchestrator
  • Schneider EcoStruxure IT
  • VMware vRealize Operations Manager
 _linksStringResource manager URI (see Links)
_metadataObjectRequest metadata (see Metadata)
The following example is returned if the request is successful.
{
"results": [{
"id": "00000000000000000000000000000000",
"healthState": "Normal",
"healthStateKey": "Normal",
"name": "XClarity Orchestrator",
"type": "XClarity Orchestrator",
"_links": {
"rel": "self",
"uri": "/api/v1/connector/managers/00000000000000000000000000000000"
}
},
{
"id": "23C87F0A2CB6491097489193447A655C",
"connectTimestamp": "2022-04-25T15:13:43.833Z",
"healthState": "Normal",
"healthStateKey": "Normal",
"name": "xhmc194.labs.lenovo.com",
"type": "XClarity Administrator",
"_links": {
"rel": "self",
"uri": "/api/v1/connector/managers/23C87F0A2CB6491097489193447A655C"
}
}],
"_metadata": {...}
}