ClusterQueryResponse

ClusterQueryResponse
ClusterQueryResponse

Represents a cluster query response.

JSON Example
{
    "queryInfo": {
        "status": "string",
        "queryId": "string",
        "errorResponse": {
            "errorCode": "string",
            "errorType": "string",
            "arguments": [
                "string"
            ],
            "context": {
                "context": "string"
            },
            "message": "string",
            "remediationMessage": "string",
            "causes": [
                {
                    "type": "string",
                    "message": "string"
                }
            ],
            "nestedErrors": [
                "Error Object"
            ],
            "referenceToken": "string"
        },
        "failure": false,
        "completed": false,
        "processing": false
    },
    "result": {
        "elements": [
            {
                "id": "string",
                "domain": {
                    "id": "string",
                    "name": "string",
                    "type": "string"
                },
                "name": "string",
                "status": "One among: ACTIVE, ACTIVATING, UPGRADING, DISABLED, ERROR, SKIPPED, DEACTIVATING, EXPANDING, SHRINKING, CREATING",
                "hciMeshData": {
                    "name": "string",
                    "isHciMeshEnabled": false,
                    "remoteDatastore": "string",
                    "primaryDataStoreId": "string",
                    "vsanDataStores": [
                        "string"
                    ],
                    "clientClusters": [
                        "string"
                    ],
                    "remoteDatastoreInfos": [
                        {
                            "serverCluster": "string",
                            "remoteDatastore": "string"
                        }
                    ],
                    "isServer": false,
                    "isClient": false,
                    "computeOnlyClient": false,
                    "numberOfClients": 0,
                    "numberOfServers": 0
                },
                "primaryDatastoreName": "string",
                "primaryDatastoreType": "One among: VSAN, VSAN_ESA, VSAN_MAX, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
                "hosts": [
                    {
                        "id": "string",
                        "ipAddress": "string",
                        "fqdn": "string",
                        "vmNics": [
                            {
                                "name": "string",
                                "linkSpeedMB": 0,
                                "isInUse": false,
                                "isAutoNegotiateSupported": false,
                                "isActive": false
                            }
                        ],
                        "azName": "string"
                    }
                ],
                "isStretched": false,
                "isDefault": false,
                "failuresToTolerate": 0,
                "vdsSpecs": [
                    {
                        "name": "string",
                        "isUsedByNsxt": false,
                        "nsxtSwitchConfig": {
                            "transportZones": [
                                {
                                    "name": "string",
                                    "transportType": "One among: VLAN, OVERLAY"
                                }
                            ],
                            "hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT"
                        },
                        "portGroupSpecs": [
                            {
                                "name": "string",
                                "transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL",
                                "activeUplinks": [
                                    "string"
                                ],
                                "standByUplinks": [
                                    "string"
                                ],
                                "teamingPolicy": "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased"
                            }
                        ],
                        "niocBandwidthAllocationSpecs": [
                            {
                                "type": "string",
                                "niocTrafficResourceAllocation": {
                                    "limit": 0,
                                    "sharesInfo": {
                                        "shares": 0,
                                        "level": "One among: low, normal, high, custom"
                                    },
                                    "reservation": 0
                                }
                            }
                        ],
                        "mtu": 0
                    }
                ],
                "tags": [
                    {
                        "id": "string",
                        "name": "string",
                        "categoryId": "string",
                        "categoryName": "string"
                    }
                ],
                "isImageBased": false,
                "capacity": {
                    "cpu": {
                        "used": {
                            "value": "number",
                            "unit": "string"
                        },
                        "total": {
                            "value": "number",
                            "unit": "string"
                        },
                        "numberOfCores": 0,
                        "numberOfCPUPackages": 0
                    },
                    "memory": {
                        "used": {
                            "value": "number",
                            "unit": "string"
                        },
                        "total": {
                            "value": "number",
                            "unit": "string"
                        }
                    },
                    "storage": {
                        "used": {
                            "value": "number",
                            "unit": "string"
                        },
                        "total": {
                            "value": "number",
                            "unit": "string"
                        }
                    }
                },
                "vcenter": {
                    "id": "string",
                    "fqdn": "string",
                    "vcInstanceId": "string"
                },
                "managedObjectReferenceId": "string",
                "vsanClusterMode": "string"
            }
        ],
        "pageMetadata": {
            "pageNumber": 0,
            "pageSize": 0,
            "totalElements": 0,
            "totalPages": 0
        }
    }
}
queryInfo
Optional

Represents the query info.

result
Optional

Represents a page of elements of a single type