Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800
seconds (30
minutes) and can be changed to a maximum value of 31536000
seconds (one year)
for long-running operations using the connector_params
field. See the Connectors reference
.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors .
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters ( connector_params
), refer to Invoke a connector call
.
Arguments
instance
string
Required. Name of the instance resource to stop.
project
string
Required. Project ID for this request.
zone
string
Required. The name of the zone for this request.
discardLocalSsd
boolean
If true, discard the contents of any attached localSSD partitions. Default value is false.
requestId
string
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Raised exceptions
ConnectionError
HttpError
TimeoutError
TypeError
ValueError
OperationError
ResponseTypeError
Response
If successful, the response contains an instance of Operation
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation .
YAML
- stop : call : googleapis.compute.beta.instances.stop args : instance : ... project : ... zone : ... discardLocalSsd : ... requestId : ... result : stopResult
JSON
[ { "stop" : { "call" : "googleapis.compute.beta.instances.stop" , "args" : { "instance" : "..." , "project" : "..." , "zone" : "..." , "discardLocalSsd" : "..." , "requestId" : "..." }, "result" : "stopResult" } } ]
