Start Nsx Criteria Query

Start Nsx Criteria Query

Start a query with NSX Criteria

Request
URI
POST
https://{api_host}/v1/nsxt-clusters/queries
COPY
Request Body
NsxTCriterion of type(s) application/json
Required
{
    "name": "NSXT_CLUSTERS_WITH_STATUS",
    "arguments": {
        "arguments": "string"
    },
    "description": "string"
}
string
name
Optional

Name of the criterion

object
arguments
Optional

Arguments required for a particular criterion

string
description
Optional

Description of the criterion

Responses
202

Accepted

Returns NsxTQueryResponse 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"
        },
        "failure": false,
        "completed": false,
        "processing": false
    },
    "result": {
        "elements": [
            {
                "id": "string",
                "nativeId": "string",
                "vipFqdn": "string",
                "vip": "string",
                "domains": [
                    {
                        "id": "string",
                        "name": "string",
                        "type": "string"
                    }
                ],
                "nodes": [
                    {
                        "id": "string",
                        "fqdn": "string",
                        "ipAddress": "string",
                        "name": "string"
                    }
                ],
                "version": "string",
                "isShared": false,
                "isShareable": false,
                "isVlcmCompatible": false,
                "status": "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED"
            }
        ],
        "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
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.