删除PV
功能介绍
该API用于删除指定Namespace下的PV(PersistentVolume)对象,并可以选择是否保留后端云存储。该API已废弃,请使用Kubernetes PV相关接口。
存储管理的URL格式为:https://{clusterid}.Endpoint/uri。其中{clusterid}为集群ID,uri为资源路径,也即API访问的路径。如果使用https://Endpoint/uri,则必须指定请求header中的X-Cluster-ID参数。
URI
DELETE /api/v1/cloudpersistentvolumes/{name}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
需要删除的PersistentVolume的名称 name格式为:Volume名称?deleteVolume=BOOLEAN&storageType=云存储类型],中括号内可省略,示例: volume-49f1?deleteVolume=true&storageType=bs volume-49f1 其中: deleteVolume:删除PersistentVolume后是否保留后端关联的云存储。false表示不删除,true表示删除,默认为false。
说明:
当为efs时,不支持删除存储,所以不能设为true。 storageType:云存储的类型,和deleteVolume搭配使用。即deleteVolume和storageType必须同时配置。
说明:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式) 枚举值:
|
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 最大长度:16384 |
X-Cluster-ID |
否 |
String |
集群 ID,使用https://Endpoint/uri这种URL格式时必须指定此参数。获取方式请参见如何获取接口URI中参数 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
API版本,固定值v1 缺省值:v1 |
kind |
String |
API类型,固定值PersistentVolume 缺省值:PersistentVolume |
metadata |
PersistentVolumeMetadata object |
PersistentVolume的元数据信息 |
spec |
PersistentVolumeSpec object |
PersistentVolume的规格信息 |
status |
PersistentVolumeStatus object |
PersistentVolume的状态信息 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
PersistentVolume名称,可以包含小写字母、数字、连字符和点,开头和结尾必须是字母或数字,最长253个字符,同一namespace下name不能重复。 |
labels |
Map<String,String> |
PersistentVolume标签,key/value对格式。
示例:"foo": "bar" |
参数 |
参数类型 |
描述 |
---|---|---|
flexVolume |
FlexVolume object |
Kubernetes的flexvolume存储插件 |
persistentVolumeReclaimPolicy |
String |
PersistentVolume的回收策略,包括:
|
accessModes |
Array of strings |
指定volume应该具有的访问模式。
|
参数 |
参数类型 |
描述 |
---|---|---|
driver |
String |
Flexvolume插件名称,请根据使用的存储类型填写:
|
fsType |
String |
文件系统类型,请根据使用的存储类型填写: |
options |
Options object |
flexVolume配置项 |
请求示例
无
响应示例
状态码: 200
删除指定PersistentVolume作业下发成功。
{ "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" } }
状态码
状态码 |
描述 |
---|---|
200 |
删除指定PersistentVolume作业下发成功。 |
错误码
请参见错误码。