Post Host Query
Post a host query
Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/clusters/{id}/hosts/queries
COPY
Path Parameters
string
id
Required
Cluster ID
Request Body
HostCriterion of type(s) application/json
Optional
{
"arguments": {
"arguments": "string"
},
"description": "string",
"name": "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"
}object
arguments
Optional
Arguments required for a particular criterion
string
description
Optional
Description of the criterion
string
name
Optional
Name of the criterion
Responses
200
Ok
Returns HostQueryResponse of type(s) application/json
{
"queryInfo": {
"completed": false,
"errorResponse": {
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
},
"failure": false,
"processing": false,
"queryId": "string",
"status": "string"
},
"result": {
"elements": [
{
"bundleRepoDatastore": "string",
"cluster": {
"id": "string"
},
"compatibleStorageType": "string",
"cpu": {
"cores": 0,
"cpuCores": [
{
"frequencyMHz": "number",
"manufacturer": "string",
"model": "string"
}
],
"frequencyMHz": "number",
"usedFrequencyMHz": "number"
},
"domain": {
"id": "string",
"name": "string"
},
"esxiVersion": "string",
"fqdn": "string",
"hardwareModel": "string",
"hardwareVendor": "string",
"hybrid": false,
"id": "string",
"ipAddresses": [
{
"ipAddress": "string",
"type": "One among: MANAGEMENT, VSAN, VMOTION, NFS"
}
],
"isPrimary": false,
"memory": {
"totalCapacityMB": "number",
"usedCapacityMB": "number"
},
"networkpool": {
"id": "string",
"name": "string"
},
"physicalNics": [
{
"deviceName": "string",
"macAddress": "string",
"speed": 0,
"unit": "string"
}
],
"serialNumber": {
"present": false
},
"sshThumbprint": {
"present": false
},
"sslThumbprint": {
"present": false
},
"status": "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
"storage": {
"disks": [
{
"capacityMB": "number",
"diskType": "One among: HDD, FLASH",
"manufacturer": "string",
"model": "string"
}
],
"totalCapacityMB": "number",
"usedCapacityMB": "number"
},
"tags": [
{
"categoryId": "string",
"categoryName": "string",
"id": "string",
"name": "string"
}
]
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}
}
400
Bad Request
Returns Error of type(s) application/json
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
remediationMessage
Optional
The localized remediation error message
500
Internal Server Error
Returns Error of type(s) application/json
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
remediationMessage
Optional
The localized remediation error message
Clusters Operations
POST
Add Datastore To Cluster
GET
Assignable Tags To Cluster
PUT
Assign Tags To Existing Cluster
POST
Create Cluster
DELETE
Delete Cluster
GET
Get Cluster
GET
Get Cluster Datastores
GET
Get Clusters
GET
Get Cluster Tag Manager Url
GET
Get Datastore Criterion
GET
Get Datastore Query Response
GET
Get Datastores Criteria
GET
Get Host Criteria
GET
Get Host Criterion
GET
Get Host Query Response
GET
Get Tags Assigned To Cluster
GET
Get Tags Assigned To Clusters
GET
Get Vdses
POST
Post Datastore Query
POST
Post Host Query
DELETE
Remove Datastore From Cluster
DELETE
Remove Tags From Existing Cluster
PATCH
Update Cluster
POST
Validate Cluster Operations
POST
Validate Clusters Operations
POST
Validate Vsan Remote Datastore