Deleting a Network¶
Function¶
Delete a Network.
Calling Method¶
For details, see Calling APIs.
URI¶
DELETE /apis/yangtse/v2/namespaces/{namespace}/networks/{name}
Parameter | Mandatory | Type | Description |
|---|---|---|---|
name | Yes | String | Name of the Network. |
namespace | Yes | String | Object name and auth scope, such as for teams and projects. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
dryRun | No | String | 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 | No | Integer | 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 | No | 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. |
propagationPolicy | No | 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. |
pretty | No | String | If 'true', then the output is pretty printed. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | User token. It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Content-Type | Yes | String | The type of the message body, with a default value of "application/JSON". |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
apiVersion | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. | |
propagationPolicy | No | 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. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
resourceVersion | No | String | Specifies the target ResourceVersion. |
uid | No | String | Specifies the target UID. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
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 | 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 | 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 |
Parameter | Type | Description |
|---|---|---|
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
|
uid | String | UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
Parameter | Type | Description |
|---|---|---|
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. |
Parameter | Type | Description |
|---|---|---|
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.15do 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. |
Status code: 202
Parameter | Type | Description |
|---|---|---|
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 | 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 reasontype. | |
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 | 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 |
Parameter | Type | Description |
|---|---|---|
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
|
uid | String | UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
Parameter | Type | Description |
|---|---|---|
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. |
Parameter | Type | Description |
|---|---|---|
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. |
Example Requests¶
None
Example Responses¶
Status code: 200
OK
{
"apiVersion" : "yangtse/v2",
"kind" : "Network",
"metadata" : {
"annotations" : {
"yangtse.io/domain-id" : "08a*************************ee60",
"yangtse.io/project-id" : "08a2*************************c03",
"yangtse.io/warm-pool-recycle-interval" : "1",
"yangtse.io/warm-pool-size" : "10"
},
"creationTimestamp" : "2024-10-09T17:46:14Z",
"deletionGracePeriodSeconds" : 0,
"deletionTimestamp" : "2024-10-09T17:46:52Z",
"finalizers" : [ "yangtse.io/network-cleanup" ],
"name" : "test-api",
"namespace" : "test-namespace",
"resourceVersion" : "20608419",
"uid" : "aa839966-6b47-4775-b8b3-c4d32a7b516c"
},
"spec" : {
"networkType" : "underlay_neutron",
"securityGroups" : [ "4120c2f9-3a1d-453e-9b64-f51b92861e26" ],
"subnets" : [ {
"subnetID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
} ]
},
"status" : {
"conditions" : [ {
"lastTransitionTime" : "2024-10-09T17:46:14Z",
"message" : "",
"reason" : "",
"status" : "True",
"type" : "NetworkSynced"
} ],
"status" : "Ready",
"subnetAttrs" : [ {
"networkID" : "377b6228-d2a7-47ab-bdb0-f7fc59802198",
"subnetV4ID" : "2eb62e19-cf1a-4741-90cc-90fb127b20ab"
} ]
}
}
Status Codes¶
Status Code | Description |
|---|---|
200 | OK |
202 | Accepted |
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 |