This API is used to delete all PersistentVolume objects.
DELETE /api/v1/persistentvolumes
Table 1 describes the parameters of this API.
Parameters |
Mandatory |
Description |
|---|---|---|
namespace |
Yes |
object name and auth scope, such as for teams and projects |
pretty |
No |
If 'true', then the output is pretty printed. |
fieldSelector |
No |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
No |
If true, partially initialized resources are included in the response. |
labelSelector |
No |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
resourceVersion |
No |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
No |
Timeout for the list/watch call. |
watch |
No |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
N/A
Response parameters:
For the description about response parameters, see Table 2
Example response:
{
"kind": "PersistentVolumeList",
"apiVersion": "v1",
"metadata": {
"selfLink": "/api/v1/persistentvolumes",
"resourceVersion": "419266"
},
"items": [
{
"metadata": {
"name": "pv-12130306-s",
"namespace": "default",
"selfLink": "/api/v1/namespaces/default/persistentvolumes/pv-12130306-s",
"uid": "15ce60fc-dfb4-11e7-9c19-fa163e2d897b",
"resourceVersion": "419266",
"creationTimestamp": "2017-12-13T03:17:01Z",
"enable": true
},
"spec": {
"capacity": {
"storage": "1Gi"
},
"hostPath": {
"path": "/home"
},
"accessModes": [
"ReadWriteMany"
],
"persistentVolumeReclaimPolicy": "Recycle"
},
"status": {
"phase": "Available"
}
}
]
}
Table 2 describes the status code of this API.
For the description about status codes, see Status Codes.