Method: organizations.locations.operations.cancel
Stay organized with collections
Save and categorize content based on your preferences.
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error
value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED
.
HTTP request
POST https://beyondcorp.googleapis.com/v1/{name=organizations/*/locations/*/operations/*}:cancel
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
The name of the operation resource to be cancelled.
|
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-15 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-02-15 UTC."],[[["This API method initiates the cancellation of a long-running operation, which may or may not be successful due to server limitations."],["The HTTP request for cancellation is a `POST` request to a specific URL using gRPC Transcoding syntax, and requires a path parameter `name` representing the operation to be cancelled."],["The request body for this operation must be empty, indicating that all necessary information is included in the URL."],["A successful cancellation will not delete the operation but will set its status to `CANCELLED` with an associated error code."],["The successful usage of this call requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]