Requires authorization
Deletes a pool. This deletes all replicas in the pool, and also deletes the associated virtual machine instances. If you would like to keep any virtual machine instances from being deleted, you can specify the instances in the
abandonInstances[]
list.
Try it now
or
see an example
.
Request
HTTP request
POST https://www.googleapis.com/replicapool/v1beta1/projects/projectName/zones/zone/pools/poolName
Parameters
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
poolName
|
string
|
The name of the replica pool to delete. The pool must exist beforehand. |
projectName
|
string
|
The project ID of the replica pool to delete. |
zone
|
string
|
The zone where this replica pool lives. |
Authorization
This request requires authorization with at least one of the following scopes ( read more about authentication and authorization ).
| Scope |
|---|
[Deprecated]
https://www.googleapis.com/auth/ndev.cloudman
|
https://www.googleapis.com/auth/cloud-platform
|
https://www.googleapis.com/auth/replicapool
|
Request body
In the request body, supply data with the following structure:
{
"abandonInstances": [
string
]
}
| Property name | Value | Description | Notes |
|---|---|---|---|
abandonInstances[]
|
list
|
If there are instances you would like to keep, you can specify them here. These instances won't be deleted, but the associated replica objects will be removed. Provide the name of the instances, in a comma-delineated list. The full URL to the instances is not required. |
Response
If successful, this method returns an empty response body.
Examples
Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).
Python
Uses the Python client library .
def deletePool(auth_http, replicapool_service):
body = {
"abandonInstances": [
"replica-one",
"replica-two"
]}
request = replicapool_service.pools().delete(projectName=PROJECT_ID, zone=ZONE, body=body, poolName=POOLNAME)
response = request.execute(auth_http)
_printResults(response)
Try it!
Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer .