Get Cluster Query Response

Get Cluster Query Response

Get cluster query response

Request
URI
GET
https://sfo-vcf01.rainpole.io/v1/domains/{domainId}/clusters/{clusterName}/queries/{queryId}
COPY
Path Parameters
string
domainId
Required

Domain ID

string
clusterName
Required

Cluster Name

string
queryId
Required

Query ID


Responses
200

Ok

Returns ClusterQueryResponse of type(s) application/json
{
    "queryInfo": {
        "completed": false,
        "errorResponse": {
            "arguments": [
                "string"
            ],
            "causes": [
                {
                    "message": "string",
                    "type": "string"
                }
            ],
            "context": {
                "context": "string"
            },
            "errorCode": "string",
            "errorType": "string",
            "message": "string",
            "nestedErrors": [
                "Error Object"
            ],
            "referenceToken": "string",
            "remediationMessage": "string"
        },
        "failure": false,
        "processing": false,
        "queryId": "string",
        "status": "string"
    },
    "result": {
        "elements": [
            {
                "capacity": {
                    "cpu": {
                        "total": {
                            "unit": "string",
                            "value": "number"
                        },
                        "used": {
                            "unit": "string",
                            "value": "number"
                        }
                    },
                    "memory": {
                        "total": {
                            "unit": "string",
                            "value": "number"
                        },
                        "used": {
                            "unit": "string",
                            "value": "number"
                        }
                    },
                    "storage": {
                        "total": {
                            "unit": "string",
                            "value": "number"
                        },
                        "used": {
                            "unit": "string",
                            "value": "number"
                        }
                    }
                },
                "hosts": [
                    {
                        "azName": "string",
                        "fqdn": "string",
                        "id": "string",
                        "ipAddress": "string",
                        "vmNics": [
                            {
                                "isActive": false,
                                "isAutoNegotiateSupported": false,
                                "isInUse": false,
                                "linkSpeedMB": 0,
                                "name": "string"
                            }
                        ]
                    }
                ],
                "id": "string",
                "isDefault": false,
                "isImageBased": false,
                "isStretched": false,
                "name": "string",
                "primaryDatastoreName": "string",
                "primaryDatastoreType": "One among: VSAN, VSAN_ESA, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
                "tags": [
                    {
                        "categoryId": "string",
                        "categoryName": "string",
                        "id": "string",
                        "name": "string"
                    }
                ],
                "vdsSpecs": [
                    {
                        "isUsedByNsxt": false,
                        "nsxtSwitchConfig": {
                            "transportZones": [
                                {
                                    "name": "string",
                                    "transportType": "One among: VLAN, OVERLAY"
                                }
                            ],
                            "hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT"
                        },
                        "mtu": 0,
                        "name": "string",
                        "niocBandwidthAllocationSpecs": [
                            {
                                "niocTrafficResourceAllocation": {
                                    "limit": 0,
                                    "reservation": 0,
                                    "sharesInfo": {
                                        "level": "One among: low, normal, high, custom",
                                        "shares": 0
                                    }
                                },
                                "type": "string"
                            }
                        ],
                        "portGroupSpecs": [
                            {
                                "activeUplinks": [
                                    "string"
                                ],
                                "standByUplinks": [
                                    "string"
                                ],
                                "teamingPolicy": "One among: loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
                                "name": "string",
                                "transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT"
                            }
                        ]
                    }
                ]
            }
        ],
        "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


400

Bad Request

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


404

Query Not Found

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


500

Internal Server Error

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message