Get Cluster Network Configuration Query Response

Get Cluster Network Configuration Query Response

The response retrieved is only applicable for pure L2 domain clusters

Request
URI
GET
https://{api_host}/v1/clusters/{id}/network/queries/{queryId}
COPY
Path Parameters
string
id
Required

Cluster ID

string
queryId
Required

Query ID


Responses
200

Ok

Returns ClusterNetworkConfigurationQueryResponse of type(s) application/json
{
    "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"
        },
        "completed": false,
        "failure": false,
        "processing": false
    },
    "result": {
        "elements": [
            {
                "hostDetails": [
                    {
                        "id": "string",
                        "hostName": "string",
                        "hostNetworkConfiguration": {
                            "vmNics": [
                                {
                                    "id": "string",
                                    "vdsName": "string",
                                    "uplink": "string"
                                }
                            ],
                            "networkProfileName": "string"
                        },
                        "azName": "string"
                    }
                ],
                "vdsConfigurations": [
                    {
                        "name": "string",
                        "portGroups": [
                            {
                                "name": "string",
                                "transportType": "string",
                                "activeUplinks": [
                                    "string"
                                ],
                                "standByUplinks": [
                                    "string"
                                ],
                                "policy": "string",
                                "supportedTeamingPolicies": {
                                    "supportedTeamingPolicies": "string"
                                },
                                "vlanId": 0,
                                "mtu": 0
                            }
                        ],
                        "nsxtSwitchConfig": {
                            "transportZones": [
                                {
                                    "name": "string",
                                    "transportType": "One among: VLAN, OVERLAY"
                                }
                            ],
                            "hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT"
                        },
                        "inventoryMismatchInfo": [
                            {
                                "type": "One among: VDS_LEVEL, PORTGROUP_LEVEL, NSX_LEVEL",
                                "inventoryObjects": [
                                    "string"
                                ]
                            }
                        ],
                        "uplinks": [
                            "string"
                        ],
                        "mtu": 0
                    }
                ],
                "nonVcfCreatedVds": [
                    "string"
                ],
                "ipAddressPools": [
                    {
                        "name": "string",
                        "description": "string",
                        "availableIpAddresses": 0,
                        "totalIpAddresses": 0,
                        "blockSubnets": [
                            {
                                "size": 0,
                                "gatewayAssigned": false,
                                "cidr": "string"
                            }
                        ],
                        "staticSubnets": [
                            {
                                "ipAddressPoolRanges": [
                                    {
                                        "start": "string",
                                        "end": "string"
                                    }
                                ],
                                "gateway": "string",
                                "cidr": "string"
                            }
                        ]
                    }
                ],
                "uplinkProfiles": [
                    {
                        "name": "string",
                        "teamings": [
                            {
                                "policy": "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC",
                                "activeUplinks": [
                                    "string"
                                ],
                                "standByUplinks": [
                                    "string"
                                ]
                            }
                        ],
                        "transportVlan": 0,
                        "supportedTeamingPolicies": {
                            "supportedTeamingPolicies": "string"
                        }
                    }
                ],
                "networkProfiles": [
                    {
                        "name": "string",
                        "isDefault": false,
                        "nsxtHostSwitchConfigs": [
                            {
                                "vdsName": "string",
                                "uplinkProfileName": "string",
                                "ipAddressPoolName": "string",
                                "vdsUplinkToNsxUplink": [
                                    {
                                        "vdsUplinkName": "string",
                                        "nsxUplinkName": "string"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ],
        "pageMetadata": {
            "pageNumber": 0,
            "pageSize": 0,
            "totalElements": 0,
            "totalPages": 0
        }
    }
}
object
queryInfo
Optional

Represents the query info.

object
result
Optional

Represents a page of elements of a single type


400

Bad Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/clusters/{id}/network/queries/{queryId}