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

Post Cluster Query

Description

Post a cluster query

Request

URL

post

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

Copy

Path Parameters

string

domainId Required

Domain ID

string

clusterName Required

Cluster Name

Request Body

ClusterCriterion of type(s) application/json Required

clusterCriterion

{
    "name": "One among: UNMANAGED_CLUSTERS_IN_VCENTER, UNMANAGED_CLUSTER_IN_VCENTER"
}

map of string

arguments Optional

Arguments required for a particular criterion

string

description Optional

Description of the criterion

string

name Optional

Name of the criterion

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

500

Internal Server Error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"name":"One among: UNMANAGED_CLUSTERS_IN_VCENTER, UNMANAGED_CLUSTER_IN_VCENTER"}' https://sfo-vcf01.rainpole.io/v1/domains/{domainId}/clusters/{clusterName}/queries

vcf-for-vxrail

Domains Operations

put

Assign Tags To Existing Domain Introduced

get

Assignable Tags To Domain Introduced

post

Create Domain

delete

Delete Domain

get

Domain Create Validation

get

Get Cluster Criteria

get

Get Cluster Criterion

get

Get Cluster Query Response

get

Get Clusters Query Response

get

Get Datastore Criterion Introduced

get

Get Datastore Query Response Introduced

get

Get Datastores Criteria Introduced

get

Get Domain

get

Get Domain Endpoints

get

Get Domain Tag Manager URL

get

Get Domain Update Validation

get

Get Domains

get

Get Tags Assigned To Domain

get

Get Tags Assigned To Domains Introduced

post

Post Cluster Query

post

Post Clusters Query

post

Post Datastore Query Introduced

delete

Remove Tags From Domain Introduced

patch

Update Domain Changed

post

Validate Domains Operations

post

Validate Domains Operations

Post Cluster Query

Request

URL

Path Parameters

Request Body

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Domains Operations

Was this page helpful?