[{"label":"Latest (4.5.0)","version":"latest"},{"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 Cluster Query Response

Description

Get cluster query response

Request

URL

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

Response

Response Body

200 OK

Returns ClusterQueryResponse 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": [
			{
				"hosts": [
					{
						"azName": "string",
						"fqdn": "string",
						"id": "string",
						"ipAddress": "string",
						"vmNics": [
							{
								"isActive": false,
								"isAutoNegotiateSupported": false,
								"isInUse": false,
								"linkSpeedMB": 0,
								"name": "string"
							}
						]
					}
				],
				"id": "string",
				"isDefault": false,
				"isStretched": false,
				"name": "string",
				"primaryDatastoreName": "string",
				"primaryDatastoreType": "One among: VSAN, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
				"tags": [
					{
						"categoryId": "string",
						"categoryName": "string",
						"id": "string",
						"name": "string"
					}
				],
				"vdsSpecs": [
					{
						"isUsedByNsxt": false,
						"name": "string",
						"niocBandwidthAllocationSpecs": [
							{
								"niocTrafficResourceAllocation": {
									"limit": 0,
									"reservation": 0,
									"sharesInfo": {
										"level": "One among: low, normal, high, custom",
										"shares": 0
									}
								},
								"type": "string"
							}
						],
						"portGroupSpecs": [
							{
								"activeUplinks": [
									"string"
								],
								"name": "string",
								"transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
							}
						]
					}
				]
			}
		],
		"pageMetadata": {
			"pageNumber": 0,
			"pageSize": 0,
			"totalElements": 0,
			"totalPages": 0
		}
	}
}

QueryInfo

queryInfo Optional

Query info

PageOfCluster

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/domains/{domainId}/clusters/{clusterName}/queries/{queryId}

vcf

Domains Operations

post

Create Domain

delete

Delete Domain

get

Get Cluster Criteria

get

Get Cluster Criterion

get

Get Cluster Query Response

get

Get Clusters Query Response

get

Get Domain

get

Get Domain Endpoints

get

Get Domains

post

Post Cluster Query

post

Post Clusters Query

patch

Update Domain

post

Validate Domains Operations

Get Cluster Query Response

Request

URL

Path Parameters

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Domains Operations

Was this page helpful?