Sign in

v1

latestOpenAPI 3.0.32026-07-17327475.9 KB
Cluster

get/api/v1/clusters/{cluster_name}

Path parameters

cluster_namestring required

cluster_name is the name of the cluster.

Response

OK

namestring

name is the name of the cluster.

cluster_kindstring

cluster_kind is the kind of the cluster.

cluster_typestring

cluster_type is the type of the cluster.

usagestring

usage is the usage of the cluster.

host_clusterstring

host_cluster specifies the host cluster name if the cluster is a virtual cluster.

primary_domainstring

primary_domain is used to build the domain of components within the cluster.

worker_typestring

worker_type maybe pipeline or deployment, when the cluster usage is 'worker', the WorkType is required.

api_serverstring

api_server specifies the API server address of the cluster.

reserved_namespaces_allowed_productsobject

// reserved_namespaces_allowed_products key is namespace name, value is the product name list witch can use namespace.

product_allowed_cluster_resourcesobject

// product_allowed_cluster_resources key is product name, value is the list of cluster resources.