NSX-T Data Center REST API

List Cluster Node Configurations

Returns information about all NSX cluster nodes.

Request:

Method:
GET
URI Path(s):
/api/v1/cluster/nodes
Request Headers:
n/a
Query Parameters:
ListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/cluster/nodes

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterNodeConfigListResult+

Example Response:

{ "result_count": 3, "results": [ { "resource_type": "ClusterNodeConfig", "id": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "display_name": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "manager_role": { "type": "ManagementClusterRoleConfig", "mgmt_cluster_listen_addr": { "port": 9090, "certificate_sha256_thumbprint": "64b99fac51f5b8996b158fc8c18af8d9379f6faa9b127a933446c701df809d24", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" }, "mpa_msg_client_info": { "account_name": "cvn-mp-mpa-5d1212b4-6e1e-47d4-b9e7-2e38e018b8f2" }, "api_listen_addr": { "port": 443, "certificate_sha256_thumbprint": "e4c359bfb8f7ca827173effe52a726cf1df0209b7035a98a773a827a5b3365bd", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" }, "mgmt_plane_listen_addr": { "port": 5671, "certificate_sha256_thumbprint": "7eda54d0dcee4463573f40b1869552f0e248dd47b9d6b47b727459b0ab0c40ba", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" }, "appliance_connection_info" : { "ip_address" : "192.168.110.48", "port" : 1234, "certificate" : "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "certificate_sha256_thumbprint" : "b53e8e59ea8832d3afdc75a9baa68e73c29c199258c390474afe4fb11f821eeb", "service_endpoint_uuid" : "4ed8b446-260a-44ad-9cb7-76b07350ac43", "entities_hosted" : [ { "entity_type" : "MP", "entity_uuid" : "b46041ce-4c34-4639-891a-24b68c33c8db" } ] }, }, "appliance_mgmt_listen_addr": "192.168.110.48", "external_id": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "_create_time": 1445540755333, "_last_modified_user": "node-mgmt", "_system_owned": false, "_last_modified_time": 1445540868201, "_create_user": "admin", "_revision": 5 }, { "resource_type": "ClusterNodeConfig", "id": "4206A8C8-36D0-F37E-54F0-76D206541B9C", "display_name": "4206A8C8-36D0-F37E-54F0-76D206541B9C", "manager_role": { "type": "ManagementClusterRoleConfig", "mgmt_cluster_listen_addr": { "port": 9090, "certificate_sha256_thumbprint": "f082b28c306c045f8663f9cf759fc047410e465c3403c05682f4fb2cafb961f8", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.49" }, "mpa_msg_client_info": { "account_name": "cvn-mp-mpa-318813d1-e23f-4906-b5e3-ebb30f6f93ea" }, "api_listen_addr": { "port": 443, "certificate_sha256_thumbprint": "8fda7907ed769628887ccc55d4fc9391febad9ce8556ca78dc7abe0025e5571a", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.49" }, "mgmt_plane_listen_addr": { "port": 5671, "certificate_sha256_thumbprint": "e93e093fe7e25d11eb4b5b0799d90e1285f7d87f333b2bcac3a32b65cd9ae6c8", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.49" } "appliance_connection_info" : { "ip_address" : "192.168.110.49", "port" : 1234, "certificate" : "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "certificate_sha256_thumbprint" : "b53e8e59ea8832d3afdc75a9baa68e73c29c199258c390474afe4fb11f821eec", "service_endpoint_uuid" : "4ed8b446-260a-44ad-9cb7-76b07350ac44", "entities_hosted" : [ { "entity_type" : "MP", "entity_uuid" : "b46041ce-4c34-4639-891a-24b68c33c8dc" } ] }, }, "appliance_mgmt_listen_addr": "192.168.110.49", "external_id": "4206A8C8-36D0-F37E-54F0-76D206541B9C", "_create_time": 1445473397114, "_last_modified_user": "node-mgmt", "_system_owned": false, "_last_modified_time": 1445473423066, "_create_user": "system", "_revision": 1 }, { "resource_type": "ClusterNodeConfig", "id": "4206D639-8620-96DB-2A5A-F3DFEB4C03C0", "display_name": "4206D639-8620-96DB-2A5A-F3DFEB4C03C0", "manager_role": { "type": "ManagementClusterRoleConfig", "mgmt_cluster_listen_addr": { "port": 9090, "certificate_sha256_thumbprint": "923314e232c29ba15aef12c8e9df44a5ddfb206479d66ac13f9a47f78b7fcc02", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.50" }, "mpa_msg_client_info": { "account_name": "cvn-mp-mpa-7deeae7c-b52c-49ce-b9da-4b05e46ba0d7" }, "api_listen_addr": { "port": 443, "certificate_sha256_thumbprint": "a5778682201f1256f385372fd803ceef1913b54617d442d311d17559bd13620e", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.50" }, "mgmt_plane_listen_addr": { "port": 5671, "certificate_sha256_thumbprint": "f99a8263bae620ca0f4bd0e97398ddeb0456412d491a6f5c204fa01cd81febf6", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.50" } "appliance_connection_info" : { "ip_address" : "192.168.110.50", "port" : 1234, "certificate" : "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "certificate_sha256_thumbprint" : "b53e8e59ea8832d3afdc75a9baa68e73c29c199258c390474afe4fb11f821eed", "service_endpoint_uuid" : "4ed8b446-260a-44ad-9cb7-76b07350ac45", "entities_hosted" : [ { "entity_type" : "MP", "entity_uuid" : "b46041ce-4c34-4639-891a-24b68c33c8dd" } ] }, }, "appliance_mgmt_listen_addr": "192.168.110.50", "external_id": "4206D639-8620-96DB-2A5A-F3DFEB4C03C0", "_create_time": 1445540972020, "_last_modified_user": "node-mgmt", "_system_owned": false, "_last_modified_time": 1445541093369, "_create_user": "admin", "_revision": 3 } ] }

Required Permissions:

read

Feature:

cluster_management

Additional Errors: