Read a Namespaced Persistent Volume Claim
GET/api/v1/namespaces/:namespace/persistentvolumeclaims/:name
Get a PersistentVolumeClaim object.
Request
Path Parameters
name stringrequired
Possible values: Value must match regular expression [a-z0-9][a-z0-9\-]*
Name of the resource
namespace stringrequired
Possible values: Value must match regular expression [a-z0-9][a-z0-9\-]*
Object name and auth scope, such as for teams and projects
Query Parameters
exact boolean
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
export boolean
Should this value be exported. Export strips fields that a user can not specify.
Responses
- 200
- 401
OK
- application/json
- application/json;stream=watch
- application/yaml
- Schema
- Example (from schema)
Schema
apiVersion stringrequired
kind stringrequired
metadata object
spec object
status object
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"name": "string",
"namespace": "string"
},
"spec": {
"accessModes": [
"string"
],
"dataSource": {
"apiGroup": "string",
"kind": "string",
"name": "string"
},
"dataSourceRef": {
"apiGroup": "string",
"kind": "string",
"name": "string",
"namespace": "string"
},
"resources": {
"claims": [
{
"name": "string"
}
],
"limits": {},
"requests": {}
},
"selector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"storageClassName": "string",
"volumeMode": "string",
"volumeName": "string"
},
"status": {
"accessModes": [
"string"
],
"allocatedResources": {},
"capacity": {},
"conditions": [
{
"lastProbeTime": {},
"lastTransitionTime": {},
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"phase": "Bound",
"resizeStatus": "string"
}
}
- Schema
- Example (from schema)
Schema
apiVersion stringrequired
kind stringrequired
metadata object
spec object
status object
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"name": "string",
"namespace": "string"
},
"spec": {
"accessModes": [
"string"
],
"dataSource": {
"apiGroup": "string",
"kind": "string",
"name": "string"
},
"dataSourceRef": {
"apiGroup": "string",
"kind": "string",
"name": "string",
"namespace": "string"
},
"resources": {
"claims": [
{
"name": "string"
}
],
"limits": {},
"requests": {}
},
"selector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"storageClassName": "string",
"volumeMode": "string",
"volumeName": "string"
},
"status": {
"accessModes": [
"string"
],
"allocatedResources": {},
"capacity": {},
"conditions": [
{
"lastProbeTime": {},
"lastTransitionTime": {},
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"phase": "Bound",
"resizeStatus": "string"
}
}
- Schema
- Example (from schema)
Schema
apiVersion stringrequired
kind stringrequired
metadata object
spec object
status object
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"name": "string",
"namespace": "string"
},
"spec": {
"accessModes": [
"string"
],
"dataSource": {
"apiGroup": "string",
"kind": "string",
"name": "string"
},
"dataSourceRef": {
"apiGroup": "string",
"kind": "string",
"name": "string",
"namespace": "string"
},
"resources": {
"claims": [
{
"name": "string"
}
],
"limits": {},
"requests": {}
},
"selector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"storageClassName": "string",
"volumeMode": "string",
"volumeName": "string"
},
"status": {
"accessModes": [
"string"
],
"allocatedResources": {},
"capacity": {},
"conditions": [
{
"lastProbeTime": {},
"lastTransitionTime": {},
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"phase": "Bound",
"resizeStatus": "string"
}
}
Unauthorized
- application/json
- application/json;stream=watch
- application/yaml
- Schema
Schema
string
- Schema
Schema
string
- Schema
Schema
string
- curl
- python
- go
- nodejs
- CURL
curl -L -X GET 'https://docs.harvesterhci.io/api/v1/namespaces/:namespace/persistentvolumeclaims/:name' \
-H 'Accept: application/json'