Get Nodes
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Retrieve details for a given identifier of the vCenter or Platform Services Controller node. 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/{node}
Parameters
Parameters
string
node
Required
Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node.
The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
TopologyNodesGetResponseBody
of type application/json
vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See Nodes.Info.
{
"value": {
"client_affinity": "string",
"domain": "string",
"replication_partners": [
"string"
],
"type": "enum"
}
}
value
Optional
vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See Nodes.Info.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/topology/nodes/{node}
Errors
404
com.vmware.vapi.std.errors.not_found : if a node doesn't exist for given node identifier.
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.
Nodes Operations
get
get
