Changed2
[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf

Set Health Check Status

Description

Update vSAN health check status for domain

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
domainId Required

Domain ID


Request Body

Request Body

array of HealthCheckSpec of type(s) application/json Required

Health check update spec

{
	"id": "string",
	"name": "string",
	"resourceType": "string",
	"status": "string"
}
string
id Required

Health Check id


string
name Required

Health Check name


string
resourceType Required

Resource Type


string
status Required

Health check status


string
resourceName Optional

Name of the resource, if the ResourceType is CLUSTER, then the resourceName == ClusterName

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns HealthCheckTask of type(s) application/json
string
id Required

Health Check task id


map of string
resourceStatus Required

Health Check resource status


string
status Required

Health Check task status


202 Accepted Response Body>

Response Body

202 Accepted

Returns HealthCheckTask of type(s) application/json
string
id Required

Health Check task id


map of string
resourceStatus Required

Health Check resource status


string
status Required

Health Check task status

Errors

Errors

400

Bad Request


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '[{"id":"string","name":"string","resourceName":"string","resourceType":"string","status":"string"}]' https://sfo-vcf01.rainpole.io/v1/domains/{domainId}/health-checks


[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
What's changed in 4.5.0?
INTRODUCED
New in this version
Feedback

Was this page helpful?