System Prechecks APIs

APIs for managing System Prechecks

1. Perform System Precheck

Precheck System API is used to perform the required system level health checks and upgrade pre-checks for an upgrade to be successful. Make sure to run these checks before performing any upgrade.

Tip : Refer to: Get the Upgradables to query for the list of upgradables which can be used for performing Domain, Cluster level checks.

1.1. Prerequisites

The following data is required:

• Resource ID. Ex: Domain ID, Cluster ID.

• Resource Type. Ex: DOMAIN, CLUSTER.

Tip : Refer to: PrecheckSpec and Resource.

Note : Supported Resource Type's are DOMAIN, CLUSTER. For Cluster level checks, the Cluster ID's can be retrieved based on the Host's that are available for upgrade, Refer to: Get the Hosts and Get the Clusters API's.

1.2. Steps

• Invoke the API. This API returns a precheck task which can be polled and monitored.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/system/prechecks' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "resources" : [ {
    "resourceId" : "bbd38966-8537-46f1-9a54-06fbfe7079c6",
    "type" : "DOMAIN"
  } ]
}'

HTTP Request

POST /v1/system/prechecks HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 110
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "resources" : [ {
    "resourceId" : "bbd38966-8537-46f1-9a54-06fbfe7079c6",
    "type" : "DOMAIN"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/system/prechecks/tasks/b8a00d3e-1e61-4258-ac96-386091d21aaa
Content-Length: 667

{
  "id" : "b8a00d3e-1e61-4258-ac96-386091d21aaa",
  "name" : "Precheck Task",
  "type" : "PRECHECK",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2022-01-24T13:10:09.321Z",
  "completionTimestamp" : "2022-01-24T13:10:09.321Z",
  "subTasks" : [ {
    "name" : "Upgrade - DOMAIN ",
    "description" : "Upgrade - DOMAIN ",
    "status" : "PENDING",
    "creationTimestamp" : "2022-01-24T13:10:09.321Z",
    "resources" : [ {
      "resourceId" : "96355926-18c9-4151-aaf1-f4d85dc9143e",
      "type" : "DOMAIN"
    } ]
  } ],
  "resources" : [ {
    "resourceId" : "96355926-18c9-4151-aaf1-f4d85dc9143e",
    "type" : "DOMAIN"
  } ],
  "isCancellable" : false
}

• Poll the status of the task using the precheck task API with the ID from the response of the previous API.

Tip : Refer to: Get System Precheck Task.

2. Get System Precheck Task

Get Precheck Task by ID API is used to retrieve a precheck task.

2.1. Prerequisites

The following data is required

• ID of the precheck task

2.2. Steps

• Invoke the API. This API returns a precheck task which can be polled and monitored.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/system/prechecks/tasks/b8a00d3e-1e61-4258-ac96-386091d21aaa' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Response

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

{
  "id" : "b8a00d3e-1e61-4258-ac96-386091d21aaa",
  "name" : "Precheck Task",
  "type" : "PRECHECK",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2022-01-24T13:10:09.902Z",
  "completionTimestamp" : "2022-01-24T13:10:09.902Z",
  "subTasks" : [ {
    "name" : "Upgrade - DOMAIN ",
    "description" : "Upgrade - DOMAIN ",
    "status" : "PENDING",
    "creationTimestamp" : "2022-01-24T13:10:09.902Z",
    "resources" : [ {
      "resourceId" : "96355926-18c9-4151-aaf1-f4d85dc9143e",
      "type" : "DOMAIN"
    } ]
  } ],
  "resources" : [ {
    "resourceId" : "96355926-18c9-4151-aaf1-f4d85dc9143e",
    "type" : "DOMAIN"
  } ],
  "isCancellable" : false
}

HTTP Response

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

{
  "id" : "b8a00d3e-1e61-4258-ac96-386091d21aaa",
  "name" : "Precheck Task",
  "type" : "PRECHECK",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2022-01-24T13:10:09.902Z",
  "completionTimestamp" : "2022-01-24T13:10:09.902Z",
  "subTasks" : [ {
    "name" : "Upgrade - DOMAIN ",
    "description" : "Upgrade - DOMAIN ",
    "status" : "PENDING",
    "creationTimestamp" : "2022-01-24T13:10:09.902Z",
    "resources" : [ {
      "resourceId" : "96355926-18c9-4151-aaf1-f4d85dc9143e",
      "type" : "DOMAIN"
    } ]
  } ],
  "resources" : [ {
    "resourceId" : "96355926-18c9-4151-aaf1-f4d85dc9143e",
    "type" : "DOMAIN"
  } ],
  "isCancellable" : false
}

Last updated 2022-01-24 06:18:36 PST

Operations

GET

Get Precheck Task

Get Precheck Task by ID

POST

Precheck System

Precheck System