Get Tasks

Get Tasks
Get all tasks

Get all tasks

Request
URI
GET
https://vcf.broadcom.com/sddc-lcm/v1/tasks
COPY
Query Parameters
string
status
Optional

Filter tasks by status

string
type
Optional

Filter tasks by type

string
createdBy
Optional

Filter tasks by creator (username or service account)

string
name
Optional

Filter tasks by name (internal name)

string
description
Optional

Filter tasks by description (public name for the task)

string
startTimeGt
Optional

Filter tasks with start time greater than the specified timestamp (ISO 8601 format)

string
startTimeLt
Optional

Filter tasks with start time less than the specified timestamp (ISO 8601 format)

string
updateTimeGt
Optional

Filter tasks with update time greater than the specified timestamp (ISO 8601 format)

string
updateTimeLt
Optional

Filter tasks with update time less than the specified timestamp (ISO 8601 format)

string
endTimeGt
Optional

Filter tasks with end time greater than the specified timestamp (ISO 8601 format)

string
endTimeLt
Optional

Filter tasks with end time less than the specified timestamp (ISO 8601 format)

string
resourceId
Optional

Filter tasks by resource ID

string
resourceType
Optional

Filter tasks by resource type

boolean
includeSystemTasks
Optional
Constraints: default: false

Whether to include system/internal tasks in the response. Defaults to false (only customer-visible tasks).

integer
pageNumber
Optional

Page Number.

integer
pageSize
Optional

Page Size. Maximum allowed is 50.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PageOfTaskSummary of type(s) application/json 
{
    "elements": [
        {
            "resourceId": "af6ef462-e192-4fe1-9522-67a50a2b3392",
            "updatedBy": "admin",
            "parentTaskId": "f81ec638-4452-4ae6-bffe-2ff284b43710",
            "description": {
                "args": {
                    "cloudProxyFqdn": "cloudProxy1.vsphere.local"
                },
                "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
                "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
                "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
            },
            "updateTime": "2000-01-23T04:56:07.000Z",
            "type": "type",
            "cancellable": true,
            "retriable": true,
            "createdBy": "admin",
            "createTime": "2000-01-23T04:56:07.000Z",
            "name": "vcfa_90_to_91_upgrade",
            "startTime": "2000-01-23T04:56:07.000Z",
            "correlationId": "39ab89c8-a945-4290-9327-13c5bd3f595c",
            "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
            "endTime": "2000-01-23T04:56:07.000Z",
            "status": "PENDING",
            "resourceType": "COMPONENT"
        },
        {
            "resourceId": "af6ef462-e192-4fe1-9522-67a50a2b3392",
            "updatedBy": "admin",
            "parentTaskId": "f81ec638-4452-4ae6-bffe-2ff284b43710",
            "description": {
                "args": {
                    "cloudProxyFqdn": "cloudProxy1.vsphere.local"
                },
                "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
                "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
                "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
            },
            "updateTime": "2000-01-23T04:56:07.000Z",
            "type": "type",
            "cancellable": true,
            "retriable": true,
            "createdBy": "admin",
            "createTime": "2000-01-23T04:56:07.000Z",
            "name": "vcfa_90_to_91_upgrade",
            "startTime": "2000-01-23T04:56:07.000Z",
            "correlationId": "39ab89c8-a945-4290-9327-13c5bd3f595c",
            "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
            "endTime": "2000-01-23T04:56:07.000Z",
            "status": "PENDING",
            "resourceType": "COMPONENT"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "totalPages": 5,
        "pageSize": 6,
        "totalElements": 1
    }
}
array of object
elements
Optional

Represents a hierarchical task structure supporting nested sub-tasks and execution steps. For complete examples demonstrating the hierarchical task model with sub-tasks, steps, and various execution scenarios, see: classpath:sample-task-example.yaml

object
pageMetadata
Optional

Retrieves the parameters needed to help pagination on client.


500

Internal Server Error

Returns PageOfTaskSummary of type(s) application/json 
{
    "elements": [
        {
            "resourceId": "af6ef462-e192-4fe1-9522-67a50a2b3392",
            "updatedBy": "admin",
            "parentTaskId": "f81ec638-4452-4ae6-bffe-2ff284b43710",
            "description": {
                "args": {
                    "cloudProxyFqdn": "cloudProxy1.vsphere.local"
                },
                "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
                "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
                "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
            },
            "updateTime": "2000-01-23T04:56:07.000Z",
            "type": "type",
            "cancellable": true,
            "retriable": true,
            "createdBy": "admin",
            "createTime": "2000-01-23T04:56:07.000Z",
            "name": "vcfa_90_to_91_upgrade",
            "startTime": "2000-01-23T04:56:07.000Z",
            "correlationId": "39ab89c8-a945-4290-9327-13c5bd3f595c",
            "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
            "endTime": "2000-01-23T04:56:07.000Z",
            "status": "PENDING",
            "resourceType": "COMPONENT"
        },
        {
            "resourceId": "af6ef462-e192-4fe1-9522-67a50a2b3392",
            "updatedBy": "admin",
            "parentTaskId": "f81ec638-4452-4ae6-bffe-2ff284b43710",
            "description": {
                "args": {
                    "cloudProxyFqdn": "cloudProxy1.vsphere.local"
                },
                "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
                "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
                "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
            },
            "updateTime": "2000-01-23T04:56:07.000Z",
            "type": "type",
            "cancellable": true,
            "retriable": true,
            "createdBy": "admin",
            "createTime": "2000-01-23T04:56:07.000Z",
            "name": "vcfa_90_to_91_upgrade",
            "startTime": "2000-01-23T04:56:07.000Z",
            "correlationId": "39ab89c8-a945-4290-9327-13c5bd3f595c",
            "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
            "endTime": "2000-01-23T04:56:07.000Z",
            "status": "PENDING",
            "resourceType": "COMPONENT"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "totalPages": 5,
        "pageSize": 6,
        "totalElements": 1
    }
}
array of object
elements
Optional

Represents a hierarchical task structure supporting nested sub-tasks and execution steps. For complete examples demonstrating the hierarchical task model with sub-tasks, steps, and various execution scenarios, see: classpath:sample-task-example.yaml

object
pageMetadata
Optional

Retrieves the parameters needed to help pagination on client.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sddc-lcm/v1/tasks
On This Page
Task Operations
GET
Get Tasks
GET
Get Task
POST
Retry Task
POST
Cancel Task