[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Get NSX-T Cluster Query Response

Description

Get NSX cluster query response

Request

URL

get

https://sfo-vcf01.rainpole.io/v1/nsxt-clusters/queries/{id}

Copy

Path Parameters

string

id Required

Response

200 OK Response Body>

Response Body

200 OK

Returns NsxTQueryResponse of type(s) application/json

{
	"queryInfo": {
		"completed": false,
		"errorResponse": {
			"arguments": [
				"string"
			],
			"causes": [
				{
					"message": "string",
					"type": "string"
				}
			],
			"context": {
				"key": "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"
			}
		],
		"pageMetadata": {
			"pageNumber": 0,
			"pageSize": 0,
			"totalElements": 0,
			"totalPages": 0
		}
	}
}

QueryInfo

queryInfo Optional

Query info

PageOfNsxTCluster

result Optional

Query result

202 Accepted Response Body>

Response Body

202 Accepted

Returns NsxTQueryResponse of type(s) application/json

{
	"queryInfo": {
		"completed": false,
		"errorResponse": {
			"arguments": [
				"string"
			],
			"causes": [
				{
					"message": "string",
					"type": "string"
				}
			],
			"context": {
				"key": "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"
			}
		],
		"pageMetadata": {
			"pageNumber": 0,
			"pageSize": 0,
			"totalElements": 0,
			"totalPages": 0
		}
	}
}

QueryInfo

queryInfo Optional

Query info

PageOfNsxTCluster

result Optional

Query result

Errors

Error

400

Bad Request

Error

404

Query Not Found

Error

500

Internal Server Error

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/nsxt-clusters/queries/{id}

vcf

NSX-T Clusters Operations

get

Get Criteria

get

Get Criterion

get

Get NSX-T Cluster

get

Get NSX-T Cluster Query Response

get

Get NSX-T Clusters

get

Get NSX-T IP Address Pool

get

Get NSX-T IP Address Pools

get

Get Validation Result

post

Post Query

post

Validate IP Pool

Get NSX-T Cluster Query Response

Request

URL

Path Parameters

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

On This Page

NSX-T Clusters Operations

Was this page helpful?