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

apiVersion stringrequired
kind stringrequired
metadata object
name stringrequired
namespace string
spec object
accessModes string[]
dataSource object
apiGroup string
kind stringrequired
name stringrequired
dataSourceRef object
apiGroup string
kind stringrequired
name stringrequired
namespace string
resources object
claims object[]
Array [
name stringrequired
]
limits object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
requests object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
selector object
matchExpressions object[]
Array [
key stringrequired
operator stringrequired
values string[]
]
matchLabels object
property name* string
storageClassName string
volumeMode string
volumeName string
status object
accessModes string[]
allocatedResources object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
capacity object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
conditions object[]
Array [
lastProbeTime k8s.io.v1.Time (string)
Default value: [object Object]
lastTransitionTime k8s.io.v1.Time (string)
Default value: [object Object]
message string
reason string
status stringrequired
type stringrequired
]
phase string
Possible values: [Bound, Lost, Pending]
resizeStatus string

Example (from schema)

{
  "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"
  }
}

application/json;stream=watch

Schema

Schema

apiVersion stringrequired
kind stringrequired
metadata object
name stringrequired
namespace string
spec object
accessModes string[]
dataSource object
apiGroup string
kind stringrequired
name stringrequired
dataSourceRef object
apiGroup string
kind stringrequired
name stringrequired
namespace string
resources object
claims object[]
Array [
name stringrequired
]
limits object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
requests object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
selector object
matchExpressions object[]
Array [
key stringrequired
operator stringrequired
values string[]
]
matchLabels object
property name* string
storageClassName string
volumeMode string
volumeName string
status object
accessModes string[]
allocatedResources object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
capacity object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
conditions object[]
Array [
lastProbeTime k8s.io.v1.Time (string)
Default value: [object Object]
lastTransitionTime k8s.io.v1.Time (string)
Default value: [object Object]
message string
reason string
status stringrequired
type stringrequired
]
phase string
Possible values: [Bound, Lost, Pending]
resizeStatus string

Example (from schema)

{
  "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"
  }
}

application/yaml

Schema

Schema

apiVersion stringrequired
kind stringrequired
metadata object
name stringrequired
namespace string
spec object
accessModes string[]
dataSource object
apiGroup string
kind stringrequired
name stringrequired
dataSourceRef object
apiGroup string
kind stringrequired
name stringrequired
namespace string
resources object
claims object[]
Array [
name stringrequired
]
limits object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
requests object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
selector object
matchExpressions object[]
Array [
key stringrequired
operator stringrequired
values string[]
]
matchLabels object
property name* string
storageClassName string
volumeMode string
volumeName string
status object
accessModes string[]
allocatedResources object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
capacity object
property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)
Default value: [object Object]
conditions object[]
Array [
lastProbeTime k8s.io.v1.Time (string)
Default value: [object Object]
lastTransitionTime k8s.io.v1.Time (string)
Default value: [object Object]
message string
reason string
status stringrequired
type stringrequired
]
phase string
Possible values: [Bound, Lost, Pending]
resizeStatus string

Example (from schema)

{
  "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"
  }
}

401

Unauthorized

application/json

Schema

Schema

string

application/json;stream=watch

Schema

Schema

string

application/yaml

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'

Request Collapse all

Parameters

name — pathrequired

namespace — pathrequired

exact — query

---truefalse

export — query

---truefalse