List Nodes
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Returns 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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
TopologyNodesFilterSpec | 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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
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"
}
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of TopologyNodesSummary |
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
| Code | Returns | Description |
|---|---|---|
| 401 | ErrorRest | 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 | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if the Nodes.FilterSpec.types field contains a value that is not supported. |
Nodes Operations
get
get
