2.15.1 Obtaining Cluster List
The API acquires a list of clusters.
Execution permission
Admin, Modify
API version
v1
Request format
GET http[s]://host:port/Analytics/version/objects/Clusters
Request body
Not applicable.
Response body
The structure of the response body and the object attributes are as follows:{ "data":[{ "name":"...", "status":"...", "componentType":"...", "thresholdProfileID":"...", "thresholdProfileName":"...", "originalThresholdProfileID":"...", "pluginId":"...", "description":"...", "collectorID":"...", "collectorName":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
Attribute |
Type |
Description |
---|---|---|
data |
Cluster[] |
A list of Cluster objects. For details about Cluster, see the table below. |
pagination |
Pagination |
Page information. This parameter is displayed only when the relevant resource exists. |
count |
int |
Number of data items that meet the conditions. |
data (Type: Cluster)
Attribute |
Type |
Description |
---|---|---|
name |
string |
Name of the cluater |
status |
enum |
Status of cluster (For details about the specifiable values, see the table NodeStatusType in List of enumerators.) The specifiable values are as follows:
|
componentType |
enum |
Type of the cluster (For details about the specifiable values, see the table ComponentType in List of enumerators.) The specifiable values are as follows:
|
thresholdProfileID |
long |
ID of the threshold profile assigned to the cluster |
thresholdProfileName |
string |
Name of the threshold profile assigned to the cluster |
originalThresholdProfileID |
string |
Original threshold profile ID of the threshold profile assigned to the cluster |
pluginId |
string |
ID for the plug-in applied to the cluster. |
description |
string |
Description |
collectorID |
long |
ID for identifying a collector used for detection. |
collectorName |
string |
Name of a collector used for detection. |
pagination (Type: Pagination)
Attribute |
Type |
Description |
---|---|---|
page |
integer |
page |
pageSize |
integer |
Size of the pages |
numPages |
integer |
Number of the pages |
totalCount |
integer |
Number of the objects |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
401 |
Unauthorized |
No login privilege. |
403 |
Forbidden |
No reference privilege. |
412 |
Precondition Failed |
The server is not available. |
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header] GET /Analytics/v1/objects/Clusters/ HTTP/1.1 Authorization: HSSO e1ae4524b8ff0eb6560dda6af26e6a258ac92f6_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810 User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; rv:11.0) like Gecko Host: localhost:22015 Accept: application/json Accept-Language: ja [Response Header] HTTP/1.1 200 OK Date: Fri, 04 Sep 2020 09:27:26 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO e1ae4524b8ff0eb6560dda6af26e6a258ac92f6_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810 X-Frame-Options: SAMEORIGIN Connection: Keep-Alive Content-Type: application/json Content-Length: 633 [Response Body] { "data" : [ { "instanceID" : 1000001, "name" : "nutanix_cluster", "status" : "Normal", "componentType" : "GENERIC_HYPERVISOR_CLUSTER", "thresholdProfileID" : 27, "thresholdProfileName" : "Default Profile for Nutanix Cluster", "originalThresholdProfileID" : "26", "pluginId" : "com.hitachi.software.ias.NutanixPlugin" } ], "count" : 1 }