Start Nsx Criteria Query

Start Nsx Criteria Query

Start a query with NSX Criteria

Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/nsxt-clusters/queries
COPY
Request Body

nsxtCriterion

NsxTCriterion of type(s) application/json
Required 
{
    "arguments": {
        "arguments": "string"
    },
    "description": "string",
    "name": "NSXT_CLUSTERS_WITH_STATUS"
}
object
arguments
Optional

Arguments required for a particular criterion

string
description
Optional

Description of the criterion

string
name
Optional

Name of the criterion

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NsxTQueryResponse 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": [
            {
                "domains": [
                    {
                        "id": "string",
                        "name": "string"
                    }
                ],
                "id": "string",
                "isShareable": false,
                "isShared": false,
                "isVlcmCompatible": false,
                "nodes": [
                    {
                        "fqdn": "string",
                        "id": "string",
                        "ipAddress": "string",
                        "name": "string"
                    }
                ],
                "status": "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED",
                "version": "string",
                "vip": "string",
                "vipFqdn": "string",
                "nativeId": "string"
            }
        ],
        "pageMetadata": {
            "pageNumber": 0,
            "pageSize": 0,
            "totalElements": 0,
            "totalPages": 0
        }
    }
}
QueryInfo
queryInfo
Optional

Represents the query info.

PageOfNsxTCluster
result
Optional

Represents a page of elements of a single type


202

Accepted

Returns NsxTQueryResponse 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": [
            {
                "domains": [
                    {
                        "id": "string",
                        "name": "string"
                    }
                ],
                "id": "string",
                "isShareable": false,
                "isShared": false,
                "isVlcmCompatible": false,
                "nodes": [
                    {
                        "fqdn": "string",
                        "id": "string",
                        "ipAddress": "string",
                        "name": "string"
                    }
                ],
                "status": "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED",
                "version": "string",
                "vip": "string",
                "vipFqdn": "string",
                "nativeId": "string"
            }
        ],
        "pageMetadata": {
            "pageNumber": 0,
            "pageSize": 0,
            "totalElements": 0,
            "totalPages": 0
        }
    }
}
QueryInfo
queryInfo
Optional

Represents the query info.

PageOfNsxTCluster
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


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


On This Page
Nsx T Clusters Operations
GET
Get Nsx Cluster
GET
Get Nsx Cluster Query Response
GET
Get Nsx Clusters
GET
Get Nsx Criteria
GET
Get Nsx Criterion
GET
Get Nsx Ip Address Pool
GET
Get Nsx Ip Address Pools
GET
Get Nsx Transport Zones
GET
Get Validation Result Using GET
POST
Start Nsx Criteria Query
POST
Validate Ip Pool Using POST