文档首页 > > API参考> API> 存储管理> 删除PersistentVolume(已废弃)

删除PersistentVolume(已废弃)

分享
更新时间: 2020/06/23 GMT+08:00

功能描述

该API用于删除指定Namespace下的PersistentVolume对象,并可以选择是否保留后端云存储。

URI

DELETE /api/v1/cloudpersistentvolumes/{name}

表1描述该API的参数。

表1 参数解释

参数

是否必选

描述

name

需要删除的PersistentVolume的名称

name格式为:Volume名称[?deleteVolume=BOOLEAN&storageType=云存储类型],中括号内可省略,示例:

  • volume-49f1?deleteVolume=true&storageType=bs
  • volume-49f1

其中:

  • deleteVolume:删除PersistentVolume后是否保留后端关联的云存储。false表示不删除,ture表示删除,默认为false。
    说明:

    当为efs时,不支持删除存储,所以不能设为true。

  • storageType:云存储的类型,和deleteVolume搭配使用。即deleteVolume和storageType必须同时配置。
    • bs:EVS云存储
    • nfs:SFS弹性文件存储
    • obs:OBS对象存储
    • efs:SFS Turbo极速文件存储

请求消息

请求参数:

请求参数如表2所示。

表2 请求Header参数说明

参数

是否必选

描述

Content-Type

消息体的类型(格式),可任选其一使用。

  • application/json;charset=utf-8
  • application/json

X-Auth-Token

使用token认证时必选

调用接口的一种认证方式,使用时需要获取token.

请求示例:

NA

响应消息

响应参数:

响应参数如表3所示。

表3 参数描述

参数

是否必选

参数类型

描述

apiVersion

String

API版本,固定值"v1"

kind

String

API类型,固定值"PersistentVolume"

metadata

metadata object

-

spec

spec object

-

status

status object

-

表4 metadata字段数据结构说明

参数

是否必选

参数类型

描述

name

String

PersistentVolume名称,可以包含小写字母、数字、连字符和点,开头和结尾必须是字母或数字,最长253个字符,同一namespace下name不能重复。

labels

String

PersistentVolume标签,key/value对格式。

  • Key:必须以字母或数字开头,可以包含字母、数字、连字符、下划线和点,最长63个字符;另外可以使用DNS子域作为前缀,例如example.com/my-key, DNS子域最长253个字符。
  • Value:可以为空或者非空字符串,非空字符串必须以字符或数字开头,可以包含字母、数字、连字符、下划线和点,最长63个字符。

示例:"foo": "bar"

表5 spec字段数据结构说明

参数

是否必选

参数类型

描述

volumeName

String

绑定引用的PersistentVolume名称。

说明:

若“volumeID”配置为“是”,该字段取值无效。

accessModes

Array of strings

指定volume应该具有的访问模式。

  • ReadWriteOnce:该卷可以被单个节点以读/写模式挂载
    说明:

    集群版本为v1.13.10且storage-driver版本为1.0.19时,才支持此功能。

  • ReadOnlyMany:该卷可以被多个节点以只读模式挂载
  • ReadWriteMany:该卷可以被多个节点以读/写模式挂载
表6 status字段数据结构说明

参数

是否必选

参数类型

描述

accessModes

Array of strings

显示volume实际具有的访问模式

capacity

Object

底层卷的实际存储空间大小,例:"storage": "1Gi"

phase

String

PersistentVolume当前所处的状态,包括:

  • Available(可用):还是空闲资源,没有被任何PVC绑定
  • Bound(已绑定):卷已经被PVC绑定
  • Released(已释放):之前绑定的PVC被删除,但是资源还未被集群重新声明
  • Failed(失败):该卷的自动回收失败

响应示例:

{
    "kind": "PersistentVolume",
    "apiVersion": "v1",
    "metadata": {
        "name": "pv-test",
        "selfLink": "/api/v1/persistentvolumes/pv-test",
        "uid": "0d93181d-3628-11e7-9093-fa163e8c373b",
        "resourceVersion": "180886",
        "creationTimestamp": "2017-05-11T08:58:51Z",
        "labels": {
            "app": "test"
        }
    },
    "spec": {
        "flexVolume": {
            "driver": "huawei.com/fuxivol",
            "fsType": "ext4",
            "options": {
                "fsType": "ext4",
                "kubernetes.io/namespace": "default",
                "volumeID": "0781b22f-4d89-4e9c-b026-80e545cea16c"
            }
        },
        "capacity": {
            "storage": "1Gi"
        },
        "accessModes": [
            "ReadWriteMany"
        ],
        "persistentVolumeReclaimPolicy": "Delete"
    },
    "status": {
        "phase": "Available"
    }
}

状态码

表 3 状态码描述API的状态码。

表7 状态码

状态码

描述

200

删除指定PersistentVolume作业下发成功。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问