Get Bringup Task By ID

Get Bringup Task By ID

Get a bringup task by its id

Request
URI
GET
https://{api_host}/v1/sddcs/{id}
COPY
Path Parameters
string
id
Required

SDDC ID

id example 
123e4567-e89b-42d3-a456-556642440000
Responses
200

OK

Returns SddcTask of type(s) application/json 
{
    "id": "string",
    "name": "string",
    "status": "COMPLETED_WITH_SUCCESS",
    "localizableNamePack": {
        "component": "string",
        "messageKey": "string",
        "arguments": [
            "string"
        ],
        "message": "string",
        "bundle": "string"
    },
    "creationTimestamp": "string",
    "sddcSubTasks": [
        {
            "sddcId": "123e4567-e89b-42d3-a456-556642440000",
            "processingStateName": "string",
            "processingStateDescription": "string",
            "name": "string",
            "description": "string",
            "localizableNamePack": {
                "component": "string",
                "messageKey": "string",
                "arguments": [
                    "string"
                ],
                "message": "string",
                "bundle": "string"
            },
            "localizableDescriptionPack": {
                "component": "string",
                "messageKey": "string",
                "arguments": [
                    "string"
                ],
                "message": "string",
                "bundle": "string"
            },
            "status": "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
            "creationTimestamp": "string",
            "updateTimestamp": "string",
            "errors": [
                {
                    "errorCode": "string",
                    "errorType": "string",
                    "arguments": [
                        "string"
                    ],
                    "context": {
                        "context": "string"
                    },
                    "message": "string",
                    "remediationMessage": "string",
                    "causes": [
                        {
                            "type": "string",
                            "message": "string"
                        }
                    ],
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string"
                }
            ]
        }
    ]
}
string
id
Optional

SDDC ID

string
name
Optional

Task name

string
status
Required

SDDC Task status. One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE

MessagePack
localizableNamePack
Optional

A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.

string
creationTimestamp
Required

SDDC Task creation timestamp

array of SddcSubTask
sddcSubTasks
Optional

All SDDC Sub-Tasks


400

Bad Request

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


404

Not Found

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

Internal Server Error

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


On This Page
Sddc Operations
GET
Export Bringup Detail Report
GET
Export Bringup Validation Report
GET
Get Bringup App Info
GET
Get Bringup Task By ID
GET
Get Bringup Tasks
GET
Get Bringup Validation
GET
Get Bringup Validations
GET
Get Sddc Manager Info
PATCH
Retry Bringup Validation
PATCH
Retry Sddc
POST
Start Bringup
POST
Start Bringup Spec Conversion
POST
Validate Bringup Spec