Stay organized with collections Save and categorize content based on your preferences.
Requires authorization
Cancels and removes the preview currently associated with the deployment. Try it now.
Request HTTP requestPOST https://www.googleapis.com/deploymentmanager/v2/projects/project/global/deployments/deployment/cancelPreviewParameters Parameter name Value Description Path parameters
deployment string The name of the deployment for this request. project string The project ID for this request. Authorization
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).
Scopehttps://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ndev.cloudman Request body
In the request body, supply data with the following structure:
{
"fingerprint": bytes
} Property name Value Description Notes fingerprint bytes Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).
The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.
If successful, this method returns a response body with the following structure:
{
"kind": "deploymentmanager#operation",
"id": unsigned long,
"creationTimestamp": string,
"name": string,
"zone": string,
"clientOperationId": string,
"operationType": string,
"targetLink": string,
"targetId": unsigned long,
"status": string,
"statusMessage": string,
"user": string,
"progress": integer,
"insertTime": string,
"startTime": string,
"endTime": string,
"error": {
"errors": [
{
"code": string,
"location": string,
"message": string
}
]
},
"warnings": [
{
"code": string,
"message": string,
"data": [
{
"key": string,
"value": string
}
]
}
],
"httpErrorStatusCode": integer,
"httpErrorMessage": string,
"selfLink": string,
"region": string,
"description": string
} Property name Value Description Notes kind string [Output Only] Type of the resource. Always compute#operation for Operation resources. id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server. creationTimestamp string [Deprecated] This field is deprecated. name string [Output Only] Name of the resource. zone string [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. clientOperationId string [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. operationType string [Output Only] The type of operation, such as insert, update, or delete, and so on. targetLink string [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. targetId unsigned long [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. status string [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. statusMessage string [Output Only] An optional textual description of the current status of the operation. user string [Output Only] User who requested the operation, for example: user@example.com. progress integer [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. insertTime string [Output Only] The time that this operation was requested. This value is in RFC3339 text format. startTime string [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. endTime string [Output Only] The time that this operation was completed. This value is in RFC3339 text format. error object [Output Only] If errors are generated during processing of the operation, this field will be populated. error.errors[] list [Output Only] The array of errors encountered while processing this operation. error.errors[].code string [Output Only] The error type identifier for this error. error.errors[].location string [Output Only] Indicates the field in the request that caused the error. This property is optional. error.errors[].message string [Output Only] An optional, human-readable error message. warnings[] list [Output Only] If warning messages are generated during processing of the operation, this field will be populated. warnings[].code string [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. warnings[].message string [Output Only] A human-readable description of the warning code. warnings[].data[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }warnings[].data[].key string [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). warnings[].data[].value string [Output Only] A warning data value corresponding to the key. httpErrorStatusCode integer [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. httpErrorMessage string [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. selfLink string [Output Only] Server-defined URL for the resource. region string [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. description string [Output Only] A textual description of the operation, which is set when the operation is created. Try it!
Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.
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 2025-04-30 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 2025-04-30 UTC."],[[["This endpoint allows users to cancel and remove a deployment preview."],["The request requires authorization with either `https://www.googleapis.com/auth/cloud-platform` or `https://www.googleapis.com/auth/ndev.cloudman` scopes."],["A `fingerprint` is required in the request body to ensure optimistic locking and prevent concurrent modifications to the deployment, retrievable through a `get()` request."],["Successful cancellation returns a response containing operation details such as status, timestamps, and any errors or warnings that may have occurred during the process."],["The method uses HTTP `POST` requests to the specified URL, with `deployment` and `project` as mandatory parameters."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4