List Nodes
Released in v6.7.2 DescriptionReturns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Request
URLURL
https://{api_host}/rest/vcenter/topology/nodes
Query Parameters
Query Parameters
filter
Optional
Specification of matching vCenter and Platform Services Controller nodes for which information should be returned.
If unset, the behavior is equivalent to a Nodes.FilterSpec with all fields unset which means all nodes match the filter.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
TopologyNodesListResponseBody
of type application/json
commonly used information for all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec.
{
"value": [
{
"client_affinity": "string",
"node": "string",
"replication_partners": [
"string"
],
"type": "enum"
}
]
}
array of
TopologyNodesSummary
value
Optional
commonly used information for all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/topology/nodes
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the Nodes.FilterSpec.types field contains a value that is not supported.
401
com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
Nodes Operations
get
get