Tasks APIs

APIs for managing Tasks

Table of Contents

• Get the Tasks

• Get a Task

• Retry a Task

1. Get the Tasks

1.1. Prerequisites API

None

1.2. Steps API

• Invoke the API

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/tasks' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/tasks HTTP/1.1
Content-Type: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "cfbe7ffd-5a43-464c-83bd-ea984de5c70c",
    "name" : "Enable VMware Customer Experience Improvement Program",
    "status" : "Failed",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z",
    "subTasks" : [ {
      "name" : "FetchEntitiesForCEIPChangeAction",
      "description" : "Obtain Resources for Configuring Customer Experience Improvement Program (CEIP) Setting",
      "status" : "SUCCESSFUL",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    }, {
      "name" : "UpdateCeipForEsxiAction",
      "description" : "Configure Customer Experience Improvement Program (CEIP) Setting on ESXi Hosts",
      "status" : "FAILED",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    }, {
      "name" : "UpdateCeipOnNsxTAction",
      "description" : "Configure Customer Experience Improvement Program (CEIP) Setting on NSX-T",
      "status" : "PENDING",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    }, {
      "name" : "SaveResourceCeipStatusAction",
      "description" : "Save Customer Experience Improvement Program (CEIP) Status to Local Datastore",
      "status" : "PENDING",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    } ],
    "errors" : [ {
      "errorCode" : "VCF_ENABLE_CEIP_ERROR",
      "errorType" : "ERROR",
      "message" : "Unable to modify CEIP operation on VCF",
      "causes" : [ ]
    } ],
    "resources" : [ {
      "resourceId" : "30f2e9e7-ae4d-4e10-bc2f-508ab250913f",
      "type" : "HOST"
    } ],
    "resolutionStatus" : "UNRESOLVED",
    "isCancellable" : false,
    "isRetryable" : false
  }, {
    "id" : "374bc164-5db1-415d-ad79-ee71eec061ba",
    "name" : "Credentials rotate operation",
    "status" : "Successful",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z",
    "subTasks" : [ {
      "name" : "sfo-vcf01.rainpole.io:FTP",
      "description" : "Password rotate for sfo-vcf01.rainpole.io and credential type FTP",
      "status" : "SUCCESSFUL",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    } ],
    "errors" : [ ],
    "resources" : [ {
      "resourceId" : "c20dcdac-8019-4ec0-aaac-7ea768399cd7",
      "type" : "HOST"
    } ],
    "resolutionStatus" : "UNRESOLVED",
    "isCancellable" : false,
    "isRetryable" : false
  } ],
  "pageMetadata" : {
    "pageNumber" : 1,
    "pageSize" : 10,
    "totalElements" : 2,
    "totalPages" : 1
  }
}

1.3. Related APIs API

[_gettasks] API [_gettask] API

2. Get a Task

2.1. Prerequisites API

The following data is required

• ID of the task

2.2. Steps API

• Invoke the API by providing the ID of the task as input.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/tasks/ddb91d1c-efbf-4ed1-a067-a11a9b064278' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/tasks/ddb91d1c-efbf-4ed1-a067-a11a9b064278 HTTP/1.1
Content-Type: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "ddb91d1c-efbf-4ed1-a067-a11a9b064278",
  "name" : "Vi workload Domain Creation",
  "status" : "FAILED",
  "creationTimestamp" : "1970-01-20T21:28:58.036Z",
  "subTasks" : [ {
    "name" : "HostVibValidationAction",
    "description" : "Validate the hosts for any disallowed VIBS",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z"
  }, {
    "name" : "HostMaintenanceModeValidationAction",
    "description" : "Verifies that none of the hosts are in maintenance mode",
    "status" : "FAILED",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z"
  }, {
    "name" : "FetchDnsAndNtpAction",
    "description" : "Fetches DNS \\u0026 NTP IPs",
    "status" : "PENDING",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z"
  } ],
  "errors" : [ ],
  "resources" : [ {
    "resourceId" : "1aaa5fb3-eaf9-4309-8882-8283398f6eb4",
    "type" : "HOST"
  } ],
  "resolutionStatus" : "UNRESOLVED",
  "isCancellable" : false,
  "isRetryable" : false
}

2.3. Related APIs API

[_gettasks] API [_gettask] API

3. Retry a Task

Used to retry a failed task/workflow.

3.1. Prerequisites API

The following data is required

• ID of the failed task

3.2. Steps API

• Invoke the API by providing the ID of the task as input.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/tasks/7878934d-7a3d-432b-b877-a21f9a28f959' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

PATCH /v1/tasks/7878934d-7a3d-432b-b877-a21f9a28f959 HTTP/1.1
Content-Type: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK

Note : The credentials' update/rotate password tasks cannot be retried using this API. Refer to Retry a failed credentials task for a given ID API section.

3.3. Related APIs API

[_gettasks] API [_gettask] API
Last updated 2024-06-21 01:22:12 -0700

Operations

DELETE

Cancel Task

Cancel a Task

GET

Get Task

Retrieve a task by its ID

GET

Get Tasks

Retrieve a list of all tasks

PATCH

Retry Task

Retry a Task