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

OK

application/json

Schema

Schema

apiVersionstringrequired
kindstringrequired
metadata object
namestringrequired
namespacestring
spec object
accessModesstring[]
dataSource object
apiGroupstring
kindstringrequired
Default value:
namestringrequired
Default value:
dataSourceRef object
apiGroupstring
kindstringrequired
Default value:
namestringrequired
Default value:
namespacestring
resources object
claims object[]
Array [
namestringrequired
Default value:
]
limits object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
requests object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
selector object
matchExpressions object[]
Array [
keystringrequired
Default value:
operatorstringrequired
Default value:
valuesstring[]
]
matchLabels object
property name*string
Default value:
storageClassNamestring
volumeModestring
volumeNamestring
status object
accessModesstring[]
allocatedResources object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
capacity object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
conditions object[]
Array [
lastProbeTimek8s.io.v1.Time (string)
Default value: {}
lastTransitionTimek8s.io.v1.Time (string)
Default value: {}
messagestring
reasonstring
statusstringrequired
Default value:
typestringrequired
Default value:
]
phasestring
Possible values: [Bound, Lost, Pending]
resizeStatusstring

Example (auto)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "name": "string",
    "namespace": "string"
  },
  "spec": {
    "accessModes": [
      ""
    ],
    "dataSource": {
      "apiGroup": "string",
      "kind": "",
      "name": ""
    },
    "dataSourceRef": {
      "apiGroup": "string",
      "kind": "",
      "name": "",
      "namespace": "string"
    },
    "resources": {
      "claims": [
        {
          "name": ""
        }
      ],
      "limits": {},
      "requests": {}
    },
    "selector": {
      "matchExpressions": [
        {
          "key": "",
          "operator": "",
          "values": [
            ""
          ]
        }
      ],
      "matchLabels": {}
    },
    "storageClassName": "string",
    "volumeMode": "string",
    "volumeName": "string"
  },
  "status": {
    "accessModes": [
      ""
    ],
    "allocatedResources": {},
    "capacity": {},
    "conditions": [
      {
        "lastProbeTime": {},
        "lastTransitionTime": {},
        "message": "string",
        "reason": "string",
        "status": "",
        "type": ""
      }
    ],
    "phase": "Bound",
    "resizeStatus": "string"
  }
}

application/json;stream=watch

Schema

Schema

apiVersionstringrequired
kindstringrequired
metadata object
namestringrequired
namespacestring
spec object
accessModesstring[]
dataSource object
apiGroupstring
kindstringrequired
Default value:
namestringrequired
Default value:
dataSourceRef object
apiGroupstring
kindstringrequired
Default value:
namestringrequired
Default value:
namespacestring
resources object
claims object[]
Array [
namestringrequired
Default value:
]
limits object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
requests object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
selector object
matchExpressions object[]
Array [
keystringrequired
Default value:
operatorstringrequired
Default value:
valuesstring[]
]
matchLabels object
property name*string
Default value:
storageClassNamestring
volumeModestring
volumeNamestring
status object
accessModesstring[]
allocatedResources object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
capacity object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
conditions object[]
Array [
lastProbeTimek8s.io.v1.Time (string)
Default value: {}
lastTransitionTimek8s.io.v1.Time (string)
Default value: {}
messagestring
reasonstring
statusstringrequired
Default value:
typestringrequired
Default value:
]
phasestring
Possible values: [Bound, Lost, Pending]
resizeStatusstring

Example (auto)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "name": "string",
    "namespace": "string"
  },
  "spec": {
    "accessModes": [
      ""
    ],
    "dataSource": {
      "apiGroup": "string",
      "kind": "",
      "name": ""
    },
    "dataSourceRef": {
      "apiGroup": "string",
      "kind": "",
      "name": "",
      "namespace": "string"
    },
    "resources": {
      "claims": [
        {
          "name": ""
        }
      ],
      "limits": {},
      "requests": {}
    },
    "selector": {
      "matchExpressions": [
        {
          "key": "",
          "operator": "",
          "values": [
            ""
          ]
        }
      ],
      "matchLabels": {}
    },
    "storageClassName": "string",
    "volumeMode": "string",
    "volumeName": "string"
  },
  "status": {
    "accessModes": [
      ""
    ],
    "allocatedResources": {},
    "capacity": {},
    "conditions": [
      {
        "lastProbeTime": {},
        "lastTransitionTime": {},
        "message": "string",
        "reason": "string",
        "status": "",
        "type": ""
      }
    ],
    "phase": "Bound",
    "resizeStatus": "string"
  }
}

application/yaml

Schema

Schema

apiVersionstringrequired
kindstringrequired
metadata object
namestringrequired
namespacestring
spec object
accessModesstring[]
dataSource object
apiGroupstring
kindstringrequired
Default value:
namestringrequired
Default value:
dataSourceRef object
apiGroupstring
kindstringrequired
Default value:
namestringrequired
Default value:
namespacestring
resources object
claims object[]
Array [
namestringrequired
Default value:
]
limits object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
requests object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
selector object
matchExpressions object[]
Array [
keystringrequired
Default value:
operatorstringrequired
Default value:
valuesstring[]
]
matchLabels object
property name*string
Default value:
storageClassNamestring
volumeModestring
volumeNamestring
status object
accessModesstring[]
allocatedResources object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
capacity object
property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: {}
conditions object[]
Array [
lastProbeTimek8s.io.v1.Time (string)
Default value: {}
lastTransitionTimek8s.io.v1.Time (string)
Default value: {}
messagestring
reasonstring
statusstringrequired
Default value:
typestringrequired
Default value:
]
phasestring
Possible values: [Bound, Lost, Pending]
resizeStatusstring

Example (auto)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "name": "string",
    "namespace": "string"
  },
  "spec": {
    "accessModes": [
      ""
    ],
    "dataSource": {
      "apiGroup": "string",
      "kind": "",
      "name": ""
    },
    "dataSourceRef": {
      "apiGroup": "string",
      "kind": "",
      "name": "",
      "namespace": "string"
    },
    "resources": {
      "claims": [
        {
          "name": ""
        }
      ],
      "limits": {},
      "requests": {}
    },
    "selector": {
      "matchExpressions": [
        {
          "key": "",
          "operator": "",
          "values": [
            ""
          ]
        }
      ],
      "matchLabels": {}
    },
    "storageClassName": "string",
    "volumeMode": "string",
    "volumeName": "string"
  },
  "status": {
    "accessModes": [
      ""
    ],
    "allocatedResources": {},
    "capacity": {},
    "conditions": [
      {
        "lastProbeTime": {},
        "lastTransitionTime": {},
        "message": "string",
        "reason": "string",
        "status": "",
        "type": ""
      }
    ],
    "phase": "Bound",
    "resizeStatus": "string"
  }
}

401

Unauthorized

application/json

Schema

Schema

stringstring

Example (auto)

"string"

application/json;stream=watch

Schema

Schema

stringstring

Example (auto)

"string"

application/yaml

Schema

Schema

stringstring

Example (auto)

"string"

• curl
• python
• go
• nodejs

• CURL

curl -L 'https://699c5de8cd2250875530e216--harvester-preview.netlify.app/api/v1/namespaces/:namespace/persistentvolumeclaims/:name' \
-H 'Accept: application/json'

RequestCollapse all

Parameters

name — pathrequired

namespace — pathrequired

exact — query

---truefalse

export — query

---truefalse