[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Get Diagnostics Data

Description

Get Diagnostics information for the given edge

Request

Request

URL

URL


get
https://cloud.vmwarehorizon.com/admin/v2/edge-deployments/{id}/diagnostics-data
Copy

Path Parameters

Path Parameters

string
id Required

Edge deployment ID


Query Parameters

Query Parameters

string
diagnosticType Optional

Input required diagnosticType

Possible values are: GET_PODSGET_SERVICESGET_DEPLOYMENTSDESCRIBE_DEPLOYMENTGET_EVENTS


string
edgeDeploymentName Optional

This param is mandatory when diagnosticType is DESCRIBE_DEPLOYMENT

Possible values are: AD_MODULE_DEPLOYMENTAGENT_MODULE_DEPLOYMENTEDGE_DEVICE_DEPLOYMENTINFRA_AZURE_MODULE_DEPLOYMENTSG_UAG_MODULE_DEPLOYMENTTELEMETRY_DEPLOYMENTAUTH_ENGINE_DEPLOYMENT


string
org_id Optional

Organization ID: non-super users can only access their own organization


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns EdgeDeploymentDiagnosticDataTO of type */*

Successfully retrieved requested diagnostic data for edge deployment

{
    "diagnosticData": "diagnosticData",
    "edgeDeploymentId": "id",
    "kubectlCommand": "kubectl get pods",
    "orgId": "orgId"
}
string
diagnosticData Optional

Diagnostic Data response from Kubectl commands


string
edgeDeploymentId Optional

The id of the Edge Deployment


string
kubectlCommand Optional

Command used to fetch from kubernetes


string
orgId Optional

The id of the CSP org

Errors

Errors

ErrorResponse
401

Unauthorized


ErrorResponse
403

Forbidden


ErrorResponse
404

Not Found


ErrorResponse
500

Unexpected internal server error

Code Samples

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/admin/v2/edge-deployments/{id}/diagnostics-data


Feedback

Was this page helpful?