Deleting a Network

Function

This API is used to delete a specified network.

URI

DELETE /apis/networking.cci.io/v1beta1/namespaces/{namespace}/networks/{name}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

namespace

Yes

String

Namespace to which the network you want to delete belongs.

name

Yes

String

Name of the network you want to delete.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

pretty

No

String

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

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.

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.

gracePeriodSeconds

Yes

integer (int32)

The duration in seconds before the object should be deleted. Value must be a 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. The value 0 indicates to delete immediately.

Request

Request parameters

For the description about request parameters, see Table 64.

Example request
{
    "Kind": "DeleteOptions",
    "apiVersion": "v1",
    "gracePeriodSeconds": 0
}

Response

Response parameters

For the description about response parameters, see Table 72.

Example response

{
    "kind": "Status",
    "apiVersion": "v1",
    "metadata": {},
    "status": "Success",
    "details": {
        "name": "network-12130306",
        "group": "networking.cci.io",
        "kind": "networks",
        "uid": "27072a31-dfb3-11e7-9c19-fa163e2d897b"
    },
    "code": 200
}

Status Code

Table 3 describes the status code of this API.

Table 3 Status code

Status Code

Description

200

Delete a Network resource object successfully.

For more status codes, see Status Codes.