[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Get Tasks

Description

Get the Tasks

Request

URL

get

https://sfo-vcf01.rainpole.io/v1/tasks

Copy

Query Parameters

integer

completedAfter Optional

A time based filter to get tasks which are completed after the given timestamp. A task is completed if its status is ‘Successsful’ or ‘Failed’. Time is in milliseconds.

integer

limit Optional

The number of elements to be returned in the result

string

resourceId Optional

resourceId

string

resourceType Optional

resourceType

string

taskStatus Optional

taskStatus

string

taskType Optional

taskType

Response

Response Body

200 OK

Returns PageOfTask of type(s) application/json

Returns the list of tasks.

{
	"elements": [
		{
			"completionTimestamp": "string",
			"creationTimestamp": "string",
			"errors": [
				{
					"arguments": [
						"string"
					],
					"causes": [
						{
							"message": "string",
							"type": "string"
						}
					],
					"context": {
						"key": "string"
					},
					"errorCode": "string",
					"errorType": "string",
					"message": "string",
					"nestedErrors": "Error Object",
					"referenceToken": "string",
					"remediationMessage": "string"
				}
			],
			"id": "string",
			"isCancellable": false,
			"localizableDescriptionPack": {
				"arguments": [
					"string"
				],
				"component": "string",
				"message": "string",
				"messageKey": "string"
			},
			"name": "string",
			"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
			"resources": [
				{
					"fqdn": "sfo-vc01.rainpole.io",
					"name": "string",
					"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
					"sans": [
						"sfo-vc01.rainpole.io"
					],
					"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
				}
			],
			"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
			"subTasks": [
				{
					"completionTimestamp": "string",
					"creationTimestamp": "string",
					"description": "string",
					"errors": [
						{
							"arguments": [
								"string"
							],
							"causes": [
								{
									"message": "string",
									"type": "string"
								}
							],
							"context": {
								"key": "string"
							},
							"errorCode": "string",
							"errorType": "string",
							"message": "string",
							"nestedErrors": "Error Object",
							"referenceToken": "string",
							"remediationMessage": "string"
						}
					],
					"name": "string",
					"resources": [
						{
							"fqdn": "sfo-vc01.rainpole.io",
							"name": "string",
							"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
							"sans": [
								"sfo-vc01.rainpole.io"
							],
							"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
						}
					],
					"stages": [
						{
							"completionTimestamp": "string",
							"creationTimestamp": "string",
							"description": "string",
							"errors": [
								{
									"arguments": [
										"string"
									],
									"causes": [
										{
											"message": "string",
											"type": "string"
										}
									],
									"context": {
										"key": "string"
									},
									"errorCode": "string",
									"errorType": "string",
									"message": "string",
									"nestedErrors": "Error Object",
									"referenceToken": "string",
									"remediationMessage": "string"
								}
							],
							"name": "string",
							"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
							"type": "string"
						}
					],
					"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
					"subTasks": "SubTask Object",
					"type": "string"
				}
			],
			"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}

array of Task

elements Optional

The list of elements included in this page

PageMetadata

pageMetadata Optional

Pageable elements pagination metadata information

Errors

Error

500

Unexpected error

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/tasks

vcf

Tasks Operations

delete

Cancel Task

get

Get Task

get

Get Tasks

patch

Retry Task

Get Tasks

Request

URL

Query Parameters

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Tasks Operations

Was this page helpful?