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

Gethealthsummary

Description

Fetch the progress of a Health summary task.

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/system/health-summary/{id}
Copy

Path Parameters

Path Parameters

string
id Required

The Health Summary Id


Response

Response

Response Body

Response Body

200 OK

Returns HealthSummary of type(s) application/json
{
	"bundleAvailable": "string",
	"bundleName": "string",
	"completionTimestamp": "string",
	"creationTimestamp": "string",
	"description": "string",
	"id": "string",
	"status": "string"
}
string
bundleAvailable Optional

Indicate if bundle is available in file system.


string
bundleName Optional

Name of the Support Bundle.


string
completionTimestamp Optional

CompletionTimestamp.


string
creationTimestamp Optional

CreationTimestamp.


string
description Optional

Name of the Operation.


string
id Optional

Id of the Support Bundle task.


string
status Optional

Health summary collection status.

Errors

Errors

400

Bad request! Invalid Headers or Data. Error: {error}


401

Bad request! Authorization Header is missing or not in correct format.


500

Something went wrong. Internal server error occurred. Error {error}

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/system/health-summary/{id}


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

Was this page helpful?