Vcenter Topology ReplicationStatus list

Vcenter Topology ReplicationStatus list

Returns the replication information of vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see Vcenter Topology Nodes Info.type) matching the Vcenter Topology ReplicationStatus 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/replication-status
COPY
Query Parameters
string of array
nodes
Optional

Identifier that a vCenter and Platform Services Controller node must have to match the filter. (see Vcenter Topology ReplicationStatus Summary.node).

This property was added in vSphere API 6.7.2.

If missing or null or empty, all vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.VCenter.name.

Authentication
This operation uses the following authentication methods.
Responses
200

Commonly used replication information about vCenter and Platform Services Controller nodes matching the Vcenter Topology ReplicationStatus FilterSpec.

[
    {
        "node": "string",
        "replication_partner": "string",
        "partner_available": false,
        "status_available": false,
        "replicating": false,
        "change_lag": 0
    }
]
array of Vcenter Topology ReplicationStatus Summary
Optional

400

if the Vcenter Topology ReplicationStatus FilterSpec.nodes property contains a invalid value.

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/replication-status
On This Page
Vcenter Operations
GET
Vcenter Topology ReplicationStatus list