[{"label":"Latest (v1.1)","version":"latest"}]
vmc

InlineTask1

Properties

string
correlation_id Optional

(Optional) Client provided uniqifier to make task creation idempotent. Be aware not all tasks support this. For tasks that do - supplying the same correlation Id, for the same task type, within a predefined window will ensure the operation happens at most once.


string
customer_error_message Optional

integer as int32
end_resource_entity_version Optional

Entity version of the resource at the end of the task. This is only set for some task types.


string as date-time
end_time Optional

string
error_message Optional

integer as int32
estimated_remaining_minutes Optional

Estimated remaining time in minute of the task execution, < 0 means no estimation for the task.


string
localized_error_message Optional

string
org_id Optional

string
org_type Optional

object
params Optional

string
parent_task_id Optional

If this task was created by another task - this provides the linkage. Mostly for debugging.


string
phase_in_progress Optional

The current in progress phase ID in the task execution, if none in progress, empty string returned.


integer as int32
progress_percent Optional

Estimated progress percentage the task executed


string
resource_id Optional

UUID of the resource the task is acting upon


string
resource_type Optional

Type of resource being acted upon


array of ServiceError
service_errors Optional

Service errors returned from SDDC services.


integer as int32
start_resource_entity_version Optional

Entity version of the resource at the start of the task. This is only set for some task types.


string as date-time
start_time Optional

string
status Optional

Possible values are: STARTEDCANCELINGFINISHEDFAILEDCANCELED


string
sub_status Optional

task_progress_phases Optional

Task progress phases involved in current task execution


string
task_type Optional

string
task_version Optional

JSON Example

{
    "end_resource_entity_version": 5,
    "estimated_remaining_minutes": 4,
    "org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "progress_percent": 75,
    "start_resource_entity_version": 0
}
[{"label":"Latest (v1.1)","version":"latest"}]
vmc
Used By

Task

Feedback

Was this page helpful?