System Administration >
Configuration
>
NSX Managers
>
Clusters
>
Cluster Status
Read cluster node runtime status
Read aggregated runtime status of cluster node.
Request:
Method:
GET
URI Path(s):
/api/v1/cluster/nodes/<node-id>/status
Request Headers:
n/a
Query Parameters:
DataSourceParameters
+
DataSourceParameters
(
schema
)
Name
Description
Type
Notes
source
The data source, either realtime or cached. If not provided, cached data is returned.
DataSourceType
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/cluster/nodes/<node-id>/status
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterNodeStatus
+
ClusterNodeStatus
(
schema
)
Name
Description
Type
Notes
control_cluster_status
Clustering status for control plane functions on this node
ControlClusterNodeStatus
Readonly
mgmt_cluster_status
Clustering status for management plane functions on this node
ManagementClusterNodeStatus
Readonly
system_status
Node status properties
NodeStatusProperties
Readonly
version
Software version running on node
string
Readonly
Example Response:
{ "system_status": { "mem_used": 2498348, "system_time": 1445560337000, "file_systems": [ { "file_system": "/dev/sda2", "total": 4790588, "used": 1652564, "type": "ext4", "mount": "/" }, { "file_system": "none", "total": 4, "used": 0, "type": "tmpfs", "mount": "/sys/fs/cgroup" }, { "file_system": "udev", "total": 8206636, "used": 4, "type": "devtmpfs", "mount": "/dev" }, { "file_system": "tmpfs", "total": 1643052, "used": 716, "type": "tmpfs", "mount": "/run" }, { "file_system": "none", "total": 5120, "used": 0, "type": "tmpfs", "mount": "/run/lock" }, { "file_system": "none", "total": 8215252, "used": 0, "type": "tmpfs", "mount": "/run/shm" }, { "file_system": "none", "total": 102400, "used": 0, "type": "tmpfs", "mount": "/run/user" }, { "file_system": "/dev/sda1", "total": 967320, "used": 32672, "type": "ext4", "mount": "/boot" }, { "file_system": "/dev/sda3", "total": 4790588, "used": 9784, "type": "ext4", "mount": "/os_bak" }, { "file_system": "/dev/mapper/nsx-config", "total": 3869352, "used": 7808, "type": "ext4", "mount": "/config" }, { "file_system": "/dev/mapper/nsx-config__bak", "total": 3869352, "used": 7800, "type": "ext4", "mount": "/config_bak" }, { "file_system": "/dev/mapper/nsx-tmp", "total": 3869352, "used": 7944, "type": "ext4", "mount": "/tmp" }, { "file_system": "/dev/mapper/nsx-image", "total": 9710112, "used": 21988, "type": "ext4", "mount": "/image" }, { "file_system": "/dev/mapper/nsx-repository", "total": 24473988, "used": 180108, "type": "ext4", "mount": "/repository" }, { "file_system": "/dev/mapper/nsx-var", "total": 9710112, "used": 163268, "type": "ext4", "mount": "/var" } ], "load_average": [ 0.07000000029802322, 0.3700000047683716, 0.3499999940395355 ], "swap_total": 3997692, "mem_cache": 381336, "cpu_cores": 4, "source": "cached", "mem_total": 16430504, "swap_used": 0, "uptime": 91774000 }, "mgmt_cluster_status": { "mgmt_cluster_status": "CONNECTED" }, "version": "1.0.0.0.0.3154214" }
Required Permissions:
read
Feature:
cluster_management
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
412 Precondition Failed
500 Internal Server Error
503 Service Unavailable