Method: projects.locations.integrations.executions.troubleshoot

View detailed explanation of why an integration execution failed, using LLM

HTTP request

GET https://integrations.googleapis.com/v2/{name=projects/*/locations/*/integrations/*/executions/*}:troubleshoot

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Execution resource name. Format: projects/{gcpProjectId}/locations/{location}/integrations/{integration}/executions/{executionId}

Request body

The request body must be empty.

Response body

Response for troubleshooting an integration execution.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "executionId": string,
  "displayMessage": string,
  "errorMessage": string,
  "rootCause": string,
  "detailedExplanation": string
}
Fields
executionId

string

The execution id of the integration execution to be troubleshooted.
displayMessage

string

Display message to be shown to the user. Example - If integration execution succeeded, this field value can be "Integration execution succeeded. No troubleshooting needed.".
errorMessage

string

Error message of the integration execution, if the execution failed.
rootCause

string

Root cause of the integration execution failure.
detailedExplanation

string

Detailed explanation of the root cause of the integration execution failure.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • integrations.executions.get

For more information, see the IAM documentation.