- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Cancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.
HTTP request
POST https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*/executions/*}:cancel
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
name |
Required. The execution resource name. Format: projects/{gcpProjectId}/locations/{location}/products/{product}/integrations/{integrationId}/executions/{executionId} |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "cancelReason": string } |
| Fields | |
|---|---|
cancelReason |
Required. Reason for cancelling the execution. This is provided by the client requesting the cancellation, and is not used by the Platform. |
Response body
Response for cancelling an execution.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{ "isCanceled": boolean } |
| Fields | |
|---|---|
isCanceled |
True if cancellation performed successfully. |
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.cancel
For more information, see the IAM documentation.