Skip to main content
Version: latest

Returns the specified Custom cloud config

GET 

/v1/cloudconfigs/cloudTypes/:cloudType/:configUid

Returns the specified Custom cloud config

Request

Path Parameters

    cloudType stringrequired

    Cluster's cloud type

    configUid stringrequired

    Cluster's cloud config uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses

OK

Schema

    kindstring

    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

    metadata

    object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations

    object

    Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set, other than that any input on annotations will be ignored

    property name*string
    creationTimestampdate-time

    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.

    deletionTimestampdate-time

    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.

    labels

    object

    Labels or Tags (UI) are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

    property name*string
    lastModifiedTimestampdate-time

    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.

    namestring

    Name of the resource

    uidstring

    UID is the unique identifier generated for the resource. This is not an input field for any request.

    Populated by the system. Read-only.

    spec

    object

    CustomCloudConfigSpec defines the cloud configuration input by user This will translate to clusterspec/machinespec for cluster-api

    cloudAccountRef

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Represents the resource kind

    namestring

    Name of the resource

    uidstring

    Uid of the resource

    clusterConfig

    object

    Cluster level configuration for Custom cloud and applicable for all the machine pools

    valuesstringrequired

    YAML string for Cluster and CloudCluster

    machinePoolConfig

    object[]

  • Array [

  • additionalLabels

    object

    additionalLabels

    property name*string
    isControlPlanebooleanrequired

    whether this pool is for control plane

    namestring
    sizeint32

    size of the pool, number of machines

    taints

    object[]

    master or worker taints

  • Array [

  • effectstring

    Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

    keystring

    The taint key to be applied to a node

    timeAddeddate-time

    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.

    valuestring

    The taint value corresponding to the taint key.

  • ]

  • useControlPlaneAsWorkerboolean

    if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools

    valuesstring

    YAML string for machine

  • ]

Loading...