Returns the specified Generic cloud config

GET 
/v1/cloudconfigs/generic/:configUid

Returns the specified Generic cloud config

Request

Path Parameters

configUid stringrequired

Cluster's cloud config uid

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

OK

application/json

Schema

Schema

kindstring
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

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 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
Generic CloudConfig spec for all cloud types
cloudAccountRef object
ObjectReference contains enough information to let you inspect or modify the referred object.
kindstring
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
namestring
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uidstring
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
clusterConfig object
Generic cluster config
instanceType object
diskGiBint32
DiskGiB is the size of a virtual machine's disk, in GiB
memoryMiBint64
MemoryMiB is the size of a virtual machine's memory, in MiB
namestring
numCPUsint32
NumCPUs is the number of virtual processors in a virtual machine
regionstring
cluster region information
edgeHostRefs object[]
Appliances (Edge Host) uids
Array [
kindstring
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
namestring
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uidstring
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
]
machinePoolConfig object[]
Array [
instanceTypestring
isControlPlanebooleanrequired
whether this pool is for control plane
labelsstring[]
labels for this pool, example: master/worker, gpu, windows
namestring
rootDeviceSizeint64
Size of root volume in GB. Default is 30GB
sizeint32
size of the pool, number of machines
useControlPlaneAsWorkerboolean
if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools
]

Example (from schema)

{
  "kind": "string",
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2023-12-01T21:31:48.319Z",
    "deletionTimestamp": "2023-12-01T21:31:48.319Z",
    "labels": {},
    "lastModifiedTimestamp": "2023-12-01T21:31:48.319Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "cloudAccountRef": {
      "kind": "string",
      "name": "string",
      "uid": "string"
    },
    "clusterConfig": {
      "instanceType": {
        "diskGiB": 0,
        "memoryMiB": 0,
        "name": "string",
        "numCPUs": 0
      },
      "region": "string"
    },
    "edgeHostRefs": [
      {
        "kind": "string",
        "name": "string",
        "uid": "string"
      }
    ],
    "machinePoolConfig": [
      {
        "instanceType": "string",
        "isControlPlane": true,
        "labels": [
          "string"
        ],
        "name": "string",
        "rootDeviceSize": 0,
        "size": 0,
        "useControlPlaneAsWorker": true
      }
    ]
  }
}

Loading...