华为云计算 云知识 删除StatefulSetdeleteAppsV1NamespacedStatefulSet
删除StatefulSetdeleteAppsV1NamespacedStatefulSet

 

接口说明

删除StatefulSet。

URL
DELETE  https://cci.cn-north-4.myhuaweicloud.com/apis/apps/v1/namespaces/{namespace}/statefulsets/{name} 
请求参数
名称 类型 IN 必选 描述
X-Auth-Token
 
string header

用户Token。

通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type
 
string header

消息体的类型(格式),默认取值为“application/json”

name
 
string path

name of the StatefulSet

namespace
 
string path

object name and auth scope, such as for teams and projects

dryRun
 
string query

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

gracePeriodSeconds
 
integer query

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents
 
boolean query

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy
 
string query

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

pretty
 
string query

If 'true', then the output is pretty printed.

Body参数
名称 类型 必选 描述
apiVersion
 
string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

dryRun
 
Array of strings

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

gracePeriodSeconds
 
long

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

kind
 
string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

orphanDependents
 
boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

preconditions
 
io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions object

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

propagationPolicy
 
string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

参数:
preconditions
名称 类型 必选 描述
resourceVersion
 
string

Specifies the target ResourceVersion

uid
 
string

Specifies the target UID.

返回参数
返回码: 200

OK

名称 类型 必选 描述
apiVersion
 
string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

code
 
integer

Suggested HTTP return code for this status, 0 if not set.

details
 
io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails object

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

kind
 
string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

message
 
string

A human-readable description of the status of this operation.

metadata
 
io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

reason
 
string

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

status
 
string

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

200 details
名称 类型 必选 描述
causes
 
Array of io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause objects

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

group
 
string

The group attribute of the resource associated with the status StatusReason.

kind
 
string

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name
 
string

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

retryAfterSeconds
 
integer

If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.

uid
 
string

UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

200 details.causes
名称 类型 必选 描述
field
 
string

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"

message
 
string

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

reason
 
string

A machine-readable description of the cause of the error. If this value is empty there is no information available.

200 metadata
名称 类型 必选 描述
continue
 
string

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

remainingItemCount
 
long

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

resourceVersion
 
string

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink
 
string

selfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

返回码: 202

Accepted

名称 类型 必选 描述
apiVersion
 
string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

code
 
integer

Suggested HTTP return code for this status, 0 if not set.

details
 
io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails object

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

kind
 
string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

message
 
string

A human-readable description of the status of this operation.

metadata
 
io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

reason
 
string

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

status
 
string

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

202 details
名称 类型 必选 描述
causes
 
Array of io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause objects

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

group
 
string

The group attribute of the resource associated with the status StatusReason.

kind
 
string

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name
 
string

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

retryAfterSeconds
 
integer

If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.

uid
 
string

UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

202 details.causes
名称 类型 必选 描述
field
 
string

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"

message
 
string

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

reason
 
string

A machine-readable description of the cause of the error. If this value is empty there is no information available.

202 metadata
名称 类型 必选 描述
continue
 
string

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

remainingItemCount
 
long

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

resourceVersion
 
string

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink
 
string

selfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

返回码: 400

BadRequest

返回码: 401

Unauthorized

返回码: 403

Forbidden

返回码: 404

NotFound

返回码: 405

MethodNotAllowed

返回码: 406

NotAcceptable

返回码: 409

Conflict

返回码: 415

UnsupportedMediaType

返回码: 422

Invalid

返回码: 429

TooManyRequests

返回码: 500

InternalError

返回码: 503

ServiceUnavailable

返回码: 504

ServerTimeout

请求示例
示例 1

只删除StatefulSet(对应Pod不删除)

 
{ "Kind": "DeleteOptions", "apiVersion": "v1", "propagationPolicy": "Orphan" }
示例 2

前台级联删除(按照Pod->StatefulSet的顺序进行删除)

 
{ "apiVersion": "v1", "kind": "DeleteOptions", "propagationPolicy": "Foreground" }
示例 3

后台级联删除(按照StatefulSet->Pod的顺序进行删除)

 
{ "apiVersion": "v1", "kind": "DeleteOptions", "propagationPolicy": "Background" }
返回示例
返回码:200

OK

示例 1
 
{
"apiVersion": "v1",
"code": 200,
"details": {
"group": "apps",
"kind": "statefulsets",
"name": "statefulset-test",
"uid": "5eb82b50-b028-11e8-9d5d-c88d83be759f"
},
"kind": "Status",
"metadata": {},
"status": "Success"
}
错误码
请参考 错误码说明

 

上一篇:更新网络ACL组NeutronUpdateFirewallGroup 下一篇:云市场交易明细查询