Vcenter Topology Nodes list

Vcenter Topology Nodes list

Returns information about all vCenter and Platform Services Controller nodes matching the Vcenter Topology Nodes FilterSpec.

This operation was added in vSphere API 6.7.2.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires System.Read.
Request
URI
GET
https://{api_host}/api/vcenter/topology/nodes
COPY
Query Parameters
string of array
types
Optional

Types of the appliance that a vCenter and Platform Services Controller node must be to match the filter (see Vcenter Topology Nodes ApplianceType.

For more information see: Vcenter Topology Nodes ApplianceType.

This property was added in vSphere API 6.7.2.

If missing or null or empty, node of any ApplianceType match the filter.

Authentication
This operation uses the following authentication methods.
Responses
200

commonly used information for all vCenter and Platform Services Controller nodes matching the Vcenter Topology Nodes FilterSpec.

[
    {
        "node": "string",
        "type": "string",
        "replication_partners": [
            "string"
        ],
        "client_affinity": "string"
    }
]
array of Vcenter Topology Nodes Summary
Optional

400

if the Vcenter Topology Nodes FilterSpec.types property contains a value that is not supported.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/topology/nodes
On This Page
Vcenter Operations
GET
Vcenter Topology Nodes list
GET
Vcenter Topology Nodes get