文档首页/ 云容器引擎 CCE/ API参考（吉隆坡区域）/ API/ 存储管理/ 删除PVC（待废弃）
更新时间：2024-10-22 GMT+08:00
查看PDF
分享

删除PVC（待废弃）

功能介绍

该API用于删除指定Namespace下的PVC（PersistentVolumeClaim）对象，并可以选择保留后端的云存储。该API待废弃，请使用Kubernetes PVC相关接口。

存储管理的URL格式为：https://{clusterid}.Endpoint/uri。其中{clusterid}为集群ID，uri为资源路径，也即API访问的路径。如果使用https://Endpoint/uri，则必须指定请求header中的X-Cluster-ID参数。

URI

DELETE /api/v1/namespaces/{namespace}/cloudpersistentvolumeclaims/{name}

表1 路径参数

参数

是否必选

参数类型

描述

name

是

String

需要删除的PersistentVolumClaim的名称。

namespace

是

String

指定PersistentVolumeClaim所在的命名空间。
表2 Query参数

参数

是否必选

参数类型

描述

deleteVolume

否

String

删除PersistentVolumeClaim后是否保留后端关联的云存储。false表示不删除，true表示删除，默认为false。

storageType

否

String

云存储的类型，和deleteVolume搭配使用。即deleteVolume和storageType必须同时配置。

  • bs：EVS云硬盘存储

  • nfs：SFS弹性文件存储

  • obs：OBS对象存储

  • efs：SFS Turbo极速文件存储

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式）

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。

X-Cluster-ID

否

String

集群ID，使用https://Endpoint/uri这种URL格式时必须指定此参数。获取方式请参见如何获取接口URI中参数。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

apiVersion

String

API版本，固定值v1

kind

String

API类型，固定值PersistentVolumeClaim

metadata

PersistentVolumeClaimMetadata object

metadata是集群对象的元数据定义，是集合类的元素类型，包含一组由不同名称定义的属性。

spec

PersistentVolumeClaimSpec object

spec是集合类的元素类型，用户对需要管理的集群对象进行详细描述的主体部分都在spec中给出。系统通过spec的描述来创建或更新对象。

status

PersistentVolumeClaimStatus object

status是当前PersistentVolumeClaim的状态信息，创建时不需要添加status参数。
表5 PersistentVolumeClaimMetadata

参数

参数类型

描述

name

String

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

labels

String

PersistentVolumeClaim标签，key/value对格式。

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

  • Value：可以为空或者非空字符串，非空字符串必须以字符或数字开头，可以包含字母、数字、连字符、下划线和点，最长63个字符。
表6 PersistentVolumeClaimSpec

参数

参数类型

描述

volumeID

String

资源需为已经存在的存储资源

  • 如果存储资源类型是SFS、EVS、SFS-Turbo，本参数需要填入对应资源的ID

  • 如果资源类型为OBS，本参数填入OBS名称

storageType

String

云存储的类型，和volumeID搭配使用。即volumeID和storageType必须同时被配置。

  • bs：EVS云存储

  • nfs：SFS弹性文件存储

  • obs：OBS对象存储

  • efs：SFS Turbo极速文件存储

accessModes

Array of strings

指定volume应该具有的访问模式，列表中仅第一个配置参数有效。

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

    说明：

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

  • ReadOnlyMany：该卷可以被多个节点以只读模式挂载（默认）

  • ReadWriteMany：该卷可以被多个节点以读/写模式挂载

storageClassName

String

PVC的StorageClass名称

volumeName

String

PVC绑定的PV名称

resources

ResourceRequirements object

资源需求和限制

volumeMode

String

PVC指定的PV类型
表7 ResourceRequirements

参数

参数类型

描述

limits

Map<String,String>

资源限制，创建时指定无效

requests

Map<String,String>

资源需求，创建时指定无效
表8 PersistentVolumeClaimStatus

参数

参数类型

描述

accessModes

Array of strings

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

capacity

String

底层卷的实际资源

phase

String

PersistentVolumeClaim当前所处的状态

请求示例

无

响应示例

无

状态码

状态码

描述

200

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

错误码

请参见错误码。

父主题： 存储管理