Skip to main content

ClusterService_GetClusters

GET 
/infra/v3/project/:project/cluster

ClusterService_GetClusters

Request​

Path Parameters

    project stringrequired

Query Parameters

    q string

    query for filtering

    name string

    name is unique ID of a resource along with (partnerID, organizationID, projectID)

    selector string

    selector is used to filter the labels of a resource

    partner string
    organization string
    group string
    role string
    displayName string

    displayName only used for update queries to set displayName (READONLY)

    labels string

    labels only used for update queries to set labels (READONLY)

    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

    annotations string

    annotations only used for update queries to set annotations (READONLY)

    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

    count int64
    offset int64
    limit int64
    ignoreScopeDefault boolean

    ignoreScopeDefault ignores default values for partnerID, organizationID and projectID

    globalScope boolean

    globalScope sets partnerID,organizationID,projectID = 0

    orderBy string
    order string
    deleted boolean
    extended boolean
    urlScope string

    urlScope is supposed to be passed in the URL as kind/HashID(value)

    isSSOUser boolean
    username string
    groups string[]
    blueprintRef string
    publishedVersion string
    clusterID string
    ID string
    account string
    type string

    generic way to specify a type of resource, mainly for use in users endpoint

Responses​

A successful response.

Schema
    apiVersion API Version

    Default value: infra.k8smgmt.io/v3

    API Version of the list resource

    kind Kind

    Default value: ClusterList

    Kind of the list resource

    metadata object

    Metadata of the list resource

    count int64
    offset int64
    limit int64
    items object[]

    List of the resources

  • Array [
    • apiVersion API Versionrequired

    Default value: infra.k8smgmt.io/v3

    API Version of the resource

    kind Kindrequired

    Default value: Cluster

    Kind of the resource

    metadata objectrequired

    Metadata of the resource

    name Namerequired

    name of the resource

    displayName Display Name

    display name of the resource

    description Description

    description of the resource

    labels object

    labels of the resource

    property name* string
    annotations object

    annotations of the resource

    property name* string
    project Projectrequired

    Project of the resource

    organization Organization

    Organization to which the resource belongs

    partner Partner

    Partner to which the resource belongs

    id string
    urlScope string
    createdAt date-time
    modifiedAt date-time
    spec objectrequired

    Spec of the resource

    clusterType Cluster Type

    Default value: Imported

    Type of the cluster being created

    metro object

    Location of the cluster

    id ID of Location

    ID Location of the cluster

    name Location

    Location of the cluster

    city City

    City of the location

    state State

    State of the location

    country Country

    country of the location

    locale Locale

    locale of the location

    latitude Latitude

    Latitude of the location

    longitude Longitude

    Longitude of the location

    countryCode CountryCode

    CountryCode of the location

    stateCode StateCode

    StateCode of the location

    overrideSelector Override Selector

    Override selector of the cluster

    params object

    Cluster provisioning params

    environmentProvider EnvironmentProvider

    environment provider of the cluster

    kubernetesProvider KubernetesProvider

    kubernetes provider

    provisionEnvironment ProvisionEnvironment

    provision environment

    provisionPackageType ProvisionPackageType

    provision package type

    provisionType ProvisionType

    provision type

    state State

    state

    shareMode Override Selector

    Possible values: [ClusterShareModeNotSet, ALL, CUSTOM]

    Default value: ClusterShareModeNotSet

    Override selector of the cluster

    proxyConfig object

    Override selector of the cluster

    httpProxy HttpProxy

    http proxy

    httpsProxy HttpsProxy

    https proxy

    noProxy noproxy

    noproxy

    proxyAuth ProxyAuth

    proxy auth

    allowInsecureBootstrap AllowInsecureBootstrap

    Allow insecure bootstrap

    enabled Enabled

    enabled

    bootstrapCA BootstrapCA

    Certificate Authority of bootstrap server

    clusterData object

    Override selector of the cluster

    provider Provider

    Provider

    passphrase Passphrase

    passphrase of the cluster

    cname CNAME

    cname of the cluster

    arecord DNS A Record

    Entry for DNS A Record

    displayName Display Name

    Display Name

    health Health

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

    Default value: EDGE_IGNORE

    Health

    manufacturer Manufacturer

    Manufacturer

    clusterBlueprint ClusterBlueprint

    Cluster Blueprint

    nodes object[]

    Override selector of the cluster

  • Array [
    • metadata object

    metadata of the resource

    name Namerequired

    name of the resource

    displayName Display Name

    display name of the resource

    description Description

    description of the resource

    labels object

    labels of the resource

    property name* string
    annotations object

    annotations of the resource

    property name* string
    project Projectrequired

    Project of the resource

    organization Organization

    Organization to which the resource belongs

    partner Partner

    Partner to which the resource belongs

    id string
    urlScope string
    createdAt date-time
    modifiedAt date-time
    spec object
    unschedulable boolean
    taints object[]
  • Array [
    • key string

    Required. The taint key to be applied to a node.

    value The taint value corresponding to the taint key. +optional
    effect string

    Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

    timeAdded object

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    +protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

    seconds int64

    Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

    nanos int32

    Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

  • ]
    • status object
    state string

    Possible values: [ClusterNodeCreated, ClusterNodeNotReady, ClusterNodeReady]

    Default value: ClusterNodeCreated

    conditions object[]
  • Array [
    • type string

    Type of node condition.

    status string

    Status of the condition, one of True, False, Unknown.

    lastHeartbeatTime object

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    +protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

    seconds int64

    Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

    nanos int32

    Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

    lastTransitionTime object

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    +protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

    seconds int64

    Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

    nanos int32

    Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

    reason (brief) reason for the condition's last transition. +optional
    message Human readable message indicating details about last transition. +optional
  • ]
    • nodeInfo object

    NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

    machineID MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
    systemUUID SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid
    bootID string

    Boot ID reported by the node.

    kernelVersion string

    Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).

    osImage string

    OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

    containerRuntimeVersion string

    ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).

    kubeletVersion string

    Kubelet Version reported by the node.

    kubeProxyVersion string

    KubeProxy Version reported by the node.

    operatingSystem The Operating System reported by the node
    architecture The Architecture reported by the node
    capacity object
    cpuCount int64
    ephemeralStorageKB int64
    memoryKB int64
    podsCount int64
    gpuCount int64
    allocatable object
    cpuCount int64
    ephemeralStorageKB int64
    memoryKB int64
    podsCount int64
    gpuCount int64
    allocated object
    cpuCount int64
    ephemeralStorageKB int64
    memoryKB int64
    podsCount int64
    gpuCount int64
    ips object[]
  • Array [
    • privateIP string
    publicIP string
  • ]
  • ]
    • projects object[]

    Override selector of the cluster

  • Array [
    • projectID Project ID

    Project ID associated with the cluster

    clusterID Cluster ID

    Cluster ID associated with the project

  • ]
    • clusterStatus object

    Cluster Status

    conditions object[]

    Override selector of the cluster

  • Array [
    • type Cluster Information

    Possible values: [ClusterBlueprintSync, ClusterApprove, ClusterCheckIn, ClusterNodeSync, ClusterRegister, ClusterNamespaceSync, ClusterReady, ClusterAuxiliaryTaskSync, ClusterBootstrapAgent, ClusterDelete]

    Default value: ClusterBlueprintSync

    Override selector of the cluster

    status Cluster Condition Status

    Possible values: [NotSet, Pending, InProgress, Success, Failed, Retry, Skipped, Stopped, Expired, Stopping, Submitted]

    Default value: NotSet

    Current status of the cluster

    lastUpdated date-time

    Cluster condition last updated

    reason Reason of cluster condition

    Reason of cluster condition

  • ]
    • token Cluster Information

    Override selector of the cluster

    publishedBlueprint Cluster Information

    Override selector of the cluster

    systemTaskCount int64

    Override selector of the cluster

    customTaskCount int64

    Override selector of the cluster

    auxiliaryTaskCount int64

    Override selector of the cluster

    status object

    Status of the resource

    conditionType Condition Type

    type of the status condition

    conditionStatus Condition Status

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

    Default value: StatusNotSet

    status of the condition

    lastUpdated date-time

    when the condition status is last updated

    reason Reason

    reason of the last condition status

  • ]
Loading...
CNCF

We are a Cloud Native Computing Foundation sandbox project.

The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see Trademark Usage.

Documentation
GitHub
Blog
Slack