Tasks

APIs for managing Tasks

1. Get the Tasks

1.1. Prerequisites

None

1.2. Steps

  • 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: 2172

{
  "elements" : [ {
    "id" : "42abe84a-45a7-4740-a8dc-f60fe45b9f42",
    "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",
      "message" : "Unable to modify CEIP operation on VCF",
      "causes" : [ ]
    } ],
    "resources" : [ {
      "resourceId" : "a73799f0-d975-473d-8f72-a6cbfe7f8a05",
      "type" : "HOST"
    } ],
    "resolutionStatus" : "UNRESOLVED",
    "isCancellable" : false
  }, {
    "id" : "16a6c46e-cc35-4b50-8010-91d65e586440",
    "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"
    } ],
    "resources" : [ {
      "resourceId" : "133a34c6-11f2-4a44-94e4-96f512d5141b",
      "type" : "HOST"
    } ],
    "resolutionStatus" : "UNRESOLVED",
    "isCancellable" : false
  } ]
}

2. Get a Task

2.1. Prerequisites

The following data is required

  • ID of the task

2.2. Steps

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

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/tasks/ada38b3a-d3d7-4b94-b1a3-1f7b100665d7' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/tasks/ada38b3a-d3d7-4b94-b1a3-1f7b100665d7 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: 942

{
  "id" : "ada38b3a-d3d7-4b94-b1a3-1f7b100665d7",
  "name" : "Vi workload Domain Creation",
  "status" : "FAILED",
  "creationTimestamp" : "1970-01-19T21:12:55.349Z",
  "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"
  } ],
  "resources" : [ {
    "resourceId" : "98d2e8a0-5ec5-4ce4-8904-edb1e5a018ed",
    "type" : "HOST"
  } ],
  "resolutionStatus" : "UNRESOLVED",
  "isCancellable" : false
}

3. Retry a Task

Used to retry a failed task/workflow.

3.1. Prerequisites

The following data is required

  • ID of the failed task

3.2. Steps

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

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/tasks/199e4a85-7d94-4e9c-8fd7-62b14ecf1509' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

PATCH /v1/tasks/199e4a85-7d94-4e9c-8fd7-62b14ecf1509 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.

Last updated 2021-11-03 05:03:41 PDT

Operations



Feedback

Was this page helpful?