Developer Documentation
Get Nodes
Released in v6.7.2Retrieve 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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | 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. |
Response
Response
Response BodyResponse Body
200 OK returns
TopologyNodesGetResponseBody
This structure was autogenerated to hold a response body. It contains: 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"
}
}| Property Name | Type | Description |
|---|---|---|
| value | TopologyNodesInfo |
vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See Nodes.Info. |
Errors
| Code | Returns | Description |
|---|---|---|
| 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. |
| 404 | Error | com.vmware.vapi.std.errors.not_found : if a node doesn't exist for given node identifier. |
| default | Error | Not available |
On This Page
Nodes Operations
get
get
