[{"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/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
DescriptionGet cluster query response
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/domains/{domainId}/clusters/{clusterName}/queries/{queryId}
Path Parameters
Path Parameters
string
domainId
Required
Domain ID
string
clusterName
Required
Cluster Name
string
queryId
Required
Query ID
Response
Response
Response BodyResponse 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,
"isImageBased": false,
"isStretched": false,
"name": "string",
"primaryDatastoreName": "string",
"primaryDatastoreType": "One among: VSAN, VSAN_ESA, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
"tags": [
{
"categoryId": "string",
"categoryName": "string",
"id": "string",
"name": "string"
}
],
"vdsSpecs": [
{
"isUsedByNsxt": false,
"mtu": 0,
"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, VM_MANAGEMENT"
}
]
}
]
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}
}
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}
[{"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/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
On This Page
Domains Operations
post
Assign Tags To Domain
Introduced
get
Attachable Tags To Domain
Introduced
post
delete
post
Detach Tags From Domain
Introduced
get
get
Get Domain Tag Manager URL
Introduced
get
get
Get Tags Assigned To Domain
Introduced
post
post
patch
