Get Nodes Deprecated
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}
Path Parameters
Path 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
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": "VCSA_EMBEDDED"
}
}
value
Optional
vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See Nodes.Info.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if a node doesn’t exist for given node identifier.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/topology/nodes/{node}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: get
x-vmw-doc-new-path: /api/vcenter/topology/nodes/{node}
x-vmw-doc-operation: get
Availability
Added in 6.7.2
On This Page
Nodes Operations
get
get
