[{"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 Health Check Query

Description

Get vSAN health check status for all cluster on the domain

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/domains/{domainId}/health-checks
Copy

Path Parameters

Path Parameters

string
domainId Required

Domain ID


Query Parameters

Query Parameters

string
status Optional

Status of health check to filter by


Response

Response

200 OK Response Body>

Response Body

200 OK

Returns HealthCheckQueryResult of type(s) application/json
{
	"result": [
		{
			"description": "string",
			"id": "string",
			"name": "string",
			"resourceId": "string",
			"resourceName": "string",
			"resourceType": "One among: CLUSTER",
			"status": "One among: ENABLED, DISABLED",
			"type": "One among: VSAN"
		}
	],
	"resultId": "string",
	"status": "string"
}
string
resultId Required

Result id


string
status Required

status


result Optional

result


202 Accepted Response Body>

Response Body

202 Accepted

Returns HealthCheckQueryResult of type(s) application/json
{
	"result": [
		{
			"description": "string",
			"id": "string",
			"name": "string",
			"resourceId": "string",
			"resourceName": "string",
			"resourceType": "One among: CLUSTER",
			"status": "One among: ENABLED, DISABLED",
			"type": "One among: VSAN"
		}
	],
	"resultId": "string",
	"status": "string"
}
string
resultId Required

Result id


string
status Required

status


result Optional

result

Errors

Errors

Error
400

Bad Request


Error
500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/domains/{domainId}/health-checks


[{"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
Feedback

Was this page helpful?