Developer Documentation
List Nodes
Released in v6.7.2Returns 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 |
|
NodesFilterSpec | 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. |
Response
Response
Response BodyResponse Body
200 OK returns
ListResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: 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 NodesSummary |
commonly used information for all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec. |
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : if the Nodes.FilterSpec.types field contains a value that is not supported. |
| 401 | Error | 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 | Error | Not available |
On This Page
Nodes Operations
get
get
