V San Health Check

Table of Contents

• Get vSAN health check status

• Update vSAN health check status

1. Get vSAN health check status

• Get vSAN health check status API is used to fetch vSAN health check status.

1.1. Prerequisites

The following data is required:

• ID of a domain

The following data is optional:

• Status of health check [ENABLED / DISABLED]

1.2. Steps

• Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/domains/ef16054d-1981-4d82-bb42-35f1b3f1a488/health-checks' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/ef16054d-1981-4d82-bb42-35f1b3f1a488/health-checks HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 102

{
  "resultId" : "66f62705-c9de-4133-aafb-019444ba5852",
  "status" : "INPROGRESS",
  "result" : [ ]
}

• Poll the vSAN health check status with the ID from the response of the previous API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/domains/ef16054d-1981-4d82-bb42-35f1b3f1a488/health-checks/queries/66f62705-c9de-4133-aafb-019444ba5852' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/ef16054d-1981-4d82-bb42-35f1b3f1a488/health-checks/queries/66f62705-c9de-4133-aafb-019444ba5852 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 434

{
  "resultId" : "66f62705-c9de-4133-aafb-019444ba5852",
  "status" : "SUCCESS",
  "result" : [ {
    "id" : "objecthealth",
    "name" : "vSAN object health",
    "description" : "Checks the health status of all vSAN objects.",
    "type" : "VSAN",
    "status" : "ENABLED",
    "resourceType" : "CLUSTER",
    "resourceId" : "ce635a56-8cb5-4100-bb96-0df3aef307ea",
    "resourceName" : "c4452935-1c16-474f-9eba-e315cf2f3b67"
  } ]
}

2. Update vSAN health check status

• Update vSAN health check status API is used to update the vSAN health check status.

2.1. Prerequisites

The following data is required:

• ID of the Domain

• List of vSAN health check spec

Tip : Refer to: HealthCheckSpec

2.2. Steps

• Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/domains/ef16054d-1981-4d82-bb42-35f1b3f1a488/health-checks' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '[ {
  "id" : "objecthealth",
  "name" : "vSAN object health",
  "status" : "DISABLED",
  "resourceType" : "CLUSTER",
  "resourceName" : "c4452935-1c16-474f-9eba-e315cf2f3b67"
} ]'

HTTP Request

PATCH /v1/domains/ef16054d-1981-4d82-bb42-35f1b3f1a488/health-checks HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 178
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

[ {
  "id" : "objecthealth",
  "name" : "vSAN object health",
  "status" : "DISABLED",
  "resourceType" : "CLUSTER",
  "resourceName" : "c4452935-1c16-474f-9eba-e315cf2f3b67"
} ]

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 164

{
  "id" : "4a913abd-a6ec-4966-8e29-8063178e86a6",
  "status" : "INPROGRESS",
  "resourceStatus" : {
    "c4452935-1c16-474f-9eba-e315cf2f3b67" : "INPROGRESS"
  }
}

• Poll the status of the vSAN health check update with the ID from the response of the previous API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/domains/ef16054d-1981-4d82-bb42-35f1b3f1a488/health-checks/tasks/4a913abd-a6ec-4966-8e29-8063178e86a6' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/ef16054d-1981-4d82-bb42-35f1b3f1a488/health-checks/tasks/4a913abd-a6ec-4966-8e29-8063178e86a6 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 158

{
  "id" : "4a913abd-a6ec-4966-8e29-8063178e86a6",
  "status" : "SUCCESS",
  "resourceStatus" : {
    "c4452935-1c16-474f-9eba-e315cf2f3b67" : "SUCCESS"
  }
}

Last updated 2023-05-21 23:30:49 PDT

Operations