Get Master Task

Get Master Task

Use this endpoint to get task information for the task ID
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER

Request
URI
GET
https://{api_host}/provider/mastertasks/{uuid}
COPY
Path Parameters
string
uuid
Required

ID of the task

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MasterTaskDetailedResponseDTO of type(s) application/vnd.vmware.dms-v1+json 
{
    "id": "string",
    "taskType": "string",
    "userName": "string",
    "createdTimestamp": "string",
    "stateHistory": [
        {
            "state": "string",
            "createdTimestamp": "string",
            "errorEvent": false
        }
    ],
    "infrastructureDetails": {
        "id": "string",
        "name": "string",
        "type": "string"
    },
    "targetDetails": {
        "id": "string",
        "name": "string",
        "type": "string"
    },
    "status": "string",
    "percent": 0,
    "taskErrorInfo": {
        "errorTrace": "string",
        "errorMessage": "string",
        "errorCode": "string"
    },
    "links": [
        {
            "rel": "string",
            "href": "string",
            "hreflang": "string",
            "media": "string",
            "title": "string",
            "type": "string",
            "deprecation": "string",
            "profile": "string",
            "name": "string"
        }
    ]
}
string As uuid As uuid
id
Optional

id

string
taskType
Optional

taskType

Possible values are : CREATE_DB, RESTORE_DB, DELETE_DB, EXTEND_DB_DISK, SCALE_DB_CONFIG, CLONE_DB, DELETE_BACKUP, BACKUP_DB, RE_SYNC_CLOUD_BACKUP, POWER_ON, POWER_OFF, PROTECT_DB, DB_CLIENT_SSL_ENABLE, DB_CLIENT_SSL_DISABLE, DB_SERVER_CERT_REFRESH, DB_TRUSTED_CERT_SYNC, PITR_RESTORE_DB, CREATE_READ_REPLICA, PROMOTE_READ_REPLICA, LOG_BUNDLE, DB_LOG_GENERATION, ENABLE_DB_VM_SSH, DISABLE_DB_VM_SSH, CHANGE_DB_OPTIONS, TENANT_APPLIANCE_MGMT, DB_ENGINE_UPDATE, UPDATE_TEMPLATE_DB_ENGINE, CREATE_TEMPLATE_EDITION, DB_OS_UPDATE, UPDATE_DB_PASSWORD, MODIFY_DB_CONFIG, MODIFY_ENVIRONMENT_S3_CONFIG, RECOVER_DB, UPDATE_VC_RESOURCES, SYNC_VC_RESOURCES, MODIFY_BACKUP_CONFIG, UPDATE_VC_CREDENTIALS, RELEASE_PROCESSING, CONFIGURE_LOG_FORWARDING, RETRY_LOG_FORWARDING, MODIFY_LOG_FORWARDING_CONFIG, CHANGE_BACKUP_STORAGE, DELETE_LOG_FORWARDING, CHANGE_DB_EDITION,
string
userName
Optional

userName

string As date-time As date-time
createdTimestamp
Optional

createdTimestamp

array of FsmHistoryPointDTO
stateHistory
Optional

stateHistory

TargetObjectRefDto
infrastructureDetails
Optional

infrastructureDetails

TargetObjectRefDto
targetDetails
Optional

targetDetails

string
status
Optional

status

Possible values are : NOT_STARTED, IN_PROGRESS, TENANT_TASK_QUEUED, SUCCESS, COMMUNICATION_LOST, FAILED,
integer As int32 As int32
percent
Optional

percent

TaskErrorInfo
taskErrorInfo
Optional

taskErrorInfo

object
masterTaskRequest
Optional

masterTaskRequest

array of Link
links
Optional

links


400

Bad Request

Operation doesn't return any data structure

On This Page
Tasks Operations
GET
Get Master Task
GET
Get Page 5