ClusterService_DeleteCluster

DELETE 
/infra/v3/project/{metadata.project}/cluster/{metadata.name}

ClusterService_DeleteCluster

Request

Path Parameters

metadata.project stringrequired

Project of the resource

metadata.name stringrequired

name of the resource

Query Parameters

apiVersion stringrequired

Default value: infra.k8smgmt.io/v3

API Version

API Version of the resource

kind stringrequired

Default value: Cluster

Kind

Kind of the resource

metadata.displayName string

Display Name

display name of the resource

metadata.description string

Description

description of the resource

metadata.labels string

Labels

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

metadata.annotations string

Annotations

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

metadata.organization string

Organization

Organization to which the resource belongs

metadata.partner string

Partner

Partner to which the resource belongs

metadata.id string
metadata.urlScope string
metadata.createdAt date-time
metadata.modifiedAt date-time
spec.clusterType string

Default value: Imported

Cluster Type

Type of the cluster being created

spec.metro.id string

ID of Location

ID Location of the cluster

spec.metro.name string

Location

Location of the cluster

spec.metro.city string

City

City of the location

spec.metro.state string

State

State of the location

spec.metro.country string

Country

country of the location

spec.metro.locale string

Locale

locale of the location

spec.metro.latitude string

Latitude

Latitude of the location

spec.metro.longitude string

Longitude

Longitude of the location

spec.metro.countryCode string

CountryCode

CountryCode of the location

spec.metro.stateCode string

StateCode

StateCode of the location

spec.overrideSelector string

Override Selector

Override selector of the cluster

spec.params.environmentProvider string

EnvironmentProvider

environment provider of the cluster

spec.params.kubernetesProvider string

KubernetesProvider

kubernetes provider

spec.params.provisionEnvironment string

ProvisionEnvironment

provision environment

spec.params.provisionPackageType string

ProvisionPackageType

provision package type

spec.params.provisionType string

ProvisionType

provision type

spec.params.state string

State

state

spec.shareMode string

Possible values: [ClusterShareModeNotSet, ALL, CUSTOM]

Default value: ClusterShareModeNotSet

Override Selector

Override selector of the cluster

spec.proxyConfig.httpProxy string

HttpProxy

http proxy

spec.proxyConfig.httpsProxy string

HttpsProxy

https proxy

spec.proxyConfig.noProxy string

noproxy

noproxy

spec.proxyConfig.proxyAuth string

ProxyAuth

proxy auth

spec.proxyConfig.allowInsecureBootstrap boolean

AllowInsecureBootstrap

Allow insecure bootstrap

spec.proxyConfig.enabled boolean

Enabled

enabled

spec.proxyConfig.bootstrapCA string

BootstrapCA

Certificate Authority of bootstrap server

spec.clusterData.provider string

Provider

Provider

spec.clusterData.passphrase string

Passphrase

passphrase of the cluster

spec.clusterData.cname string

CNAME

cname of the cluster

spec.clusterData.arecord string

DNS A Record

Entry for DNS A Record

spec.clusterData.displayName string

Display Name

Display Name

spec.clusterData.health string

Possible values: [EDGE_IGNORE, EDGE_HEALTHY, EDGE_UNHEALTHY, EDGE_DISCONNECTED]

Default value: EDGE_IGNORE

Health

Health

spec.clusterData.manufacturer string

Manufacturer

Manufacturer

spec.clusterData.clusterBlueprint string

ClusterBlueprint

Cluster Blueprint

spec.clusterData.clusterStatus.token string

Cluster Information

Override selector of the cluster

spec.clusterData.clusterStatus.publishedBlueprint string

Cluster Information

Override selector of the cluster

spec.clusterData.clusterStatus.systemTaskCount int64

Cluster Information

Override selector of the cluster

spec.clusterData.clusterStatus.customTaskCount int64

Cluster Information

Override selector of the cluster

spec.clusterData.clusterStatus.auxiliaryTaskCount int64

Cluster Information

Override selector of the cluster

status.conditionType string

Condition Type

type of the status condition

status.conditionStatus string

Possible values: [StatusNotSet, StatusSubmitted, StatusOK, StatusFailed]

Default value: StatusNotSet

Condition Status

status of the condition

status.lastUpdated date-time

Last Updated

when the condition status is last updated

status.reason string

Reason

reason of the last condition status

Responses

200

A successful response.

application/json

Schema

Schema

object

Example (from schema)

{}

application/yaml

Schema

Schema

object

Example (from schema)

{}

204

Returned when project is deleted successfully.

application/json

Schema

Schema

any

application/yaml

Schema

Schema

any

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

any

application/yaml

Schema

Schema

any

404

Returned when the resource does not exist.

application/json

Schema

Schema

string

application/yaml

Schema

Schema

string

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/yaml

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...