[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

Get Cluster Query Response

Description

Get cluster query response

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/domains/{domainId}/clusters/{clusterName}/queries/{queryId}
Copy

Path Parameters

Path Parameters

string
domainId Required

Domain ID


string
clusterName Required

Cluster Name


string
queryId Required

Query ID


Response

Response

Response Body

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,
		"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",
				"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 Optional

Query info


result Optional

Query result

Errors

Errors

400

Bad Request


404

Query Not Found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/domains/{domainId}/clusters/{clusterName}/queries/{queryId}


[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?