Request Tech Support Logs

Request Tech Support Logs

Request for asynch Tech-Support action. The supported action includes 'collectTechSupportBundle'. After the request is made, TCA carry out an asynchronous job to carry out the action, and responds with the TCA-JobId.

Request
URI
POST
https://{api_host}/hybridity/api/techsupport
COPY
Query Parameters
string
action
Required

The Tech-Support action to be taken. The supported action includes 'collectTechSupportBundle'.

action example
collectTechSupportBundle

Request Body
TechSupportConfig of type(s) application/json
Required
{
    "k8sClusterNamesWithManagementClusterId": [
        {
            "clusterName": "clusterName",
            "mgmtClusterId": "mgmtClusterId"
        },
        {
            "clusterName": "clusterName",
            "mgmtClusterId": "mgmtClusterId"
        }
    ],
    "collectK8sClusterLogs": true,
    "collectMongoDump": true,
    "k8sClusters": [
        "k8sClusters",
        "k8sClusters"
    ],
    "collectNspTechBundle": true,
    "fleetAppliances": [
        "{}",
        "{}"
    ]
}
boolean
collectMongoDump
Optional

Where or not to collect the underlying TCA inventory details.

boolean
collectNspTechBundle
Optional

Deprecated.

boolean
collectK8sClusterLogs
Optional

Where or not to collect the underlying Kubernetes cluster details.

array of object
fleetAppliances
Optional

Deprecated.

array of string
k8sClusters
Optional

List of clusterIds for which techsupport bundle needs to be collected

k8sClusterNamesWithManagementClusterId
Optional

List of clusterName with managementClusterId for which techsupport bundle needs to be collected, for clusters which do not have ids

Authentication
This operation uses the following authentication methods.
Responses
200

The Tech-Support Async Job details.

Returns TcaJob of type(s) application/json
{
    "jobId": "jobId"
}
string
jobId
Optional

The identifier that may be used to refer to TCA internal internal job that's handling the asynchronous task.


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

500

Internal Server Error

Returns ErrorResponse of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors