Generate With Id

Generate With Id

Generate a new support bundle with a specific id (UUID). This operation requires administrative permissions and may take a while.

Request
URI
POST
https://{api_host}//diagnostics/bundles/{bundleId}
COPY
Path Parameters
string
bundleId
Required

bundleId

Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services


Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns ApiTaskOfSupportBundleInfo of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8
{
    "endTime": 1499929558827,
    "error": {
        "args": [
            "string"
        ],
        "code": "string",
        "msg": "string",
        "stacktrace": "string"
    },
    "id": "f61d60d2-698a-46dc-a266-88df27644956",
    "lastUpdated": 1499929558827,
    "progress": 100,
    "result": {
        "generatedOn": "1464261608370L",
        "id": "b05d1e00-6338-48ff-86fb-ee0e55b8cd93",
        "owner": "owner1",
        "sha": "SHA-256:45C9A6614FCCD4F9592D8283A4F25BFF84076FD43EE9F90EAA07746EBBED02CA"
    },
    "resultType": "string",
    "startTime": 1499929548951,
    "state": "SUCCEEDED",
    "user": "root",
    "warnings": [],
    "workflowInfo": {
        "resourceId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963",
        "resourceName": "my vapp 1",
        "resourceType": "vappReplication",
        "type": "sync"
    }
}
integer As int64 As int64
endTime
Optional

Timestamp (in msec) of the task's completion time. -1 means the task hasn't completed.

error
Optional

error

string As uuid As uuid
id
Optional

The unique identifier of the long-running task. It is unique and can be used for monitoring.

integer As int64 As int64
lastUpdated
Optional

Timestamp (in msec) of the last task status update.

integer As int32 As int32
progress
Optional

Percentage-based progress of the task.

result
Optional

result

string
resultType
Optional

Indicates the type of the task result. Populated only if the execution was successful.

integer As int64 As int64
startTime
Optional

Timestamp (in msec) of the task's creation time.

string
state
Optional

The current state of the task. States: [RUNNING, SUCCEEDED, FAILED]

Possible values are : RUNNING, SUCCEEDED, FAILED,
string
user
Optional

The user who started the task.

warnings
Optional

Warnings, which occurred during the task execution.

workflowInfo
Optional

workflowInfo


401

Returned error codes include (but are not limited to):

  • NotAuthenticated
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


403

Returned error codes include (but are not limited to):

  • Forbidden
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

Returned error codes include (but are not limited to):

  • GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.