GET /api/v1/clusters/:cluster_name — untitled-api

Cluster

get/api/v1/clusters/{cluster_name}

Path parameters

cluster_namestring required

cluster_name is the name of the cluster.

Response

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.

Changes

Changed in 4 of the 10 revisions of this API.21119

Nov 24, 202358206cc16454171See the full diff
- ▲
  the components_list response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ●
  removed the optional property components_list/deployment from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property components_list/event_listener from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property components_list/gateway from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property components_list/multi_tenant from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property components_list/pipeline from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property components_list/progressive_delivery from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property components_list/secret_sync from the response with the 200 status
  response-optional-property-removed
- ○
  added api.cluster.v1.ComponentsList to the components_list response property allOf list for the response status 200
  response-property-all-of-added
Sep 25, 202355de8d9ba1941See the full diff
- ●
  removed the optional property components_list/cert_management from the response with the 200 status
  response-optional-property-removed
Sep 13, 20232bd9e337f83638See the full diff
- ●
  removed the optional property components_list/cert_mgt from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property components_list/ingress_controller from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property components_list/secret_mgt from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property components_list/cert_management to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/deployment/additions to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/event_listener/additions to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/gateway to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/multi_tenant/additions to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/pipeline/additions to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/progressive_delivery/additions to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/secret_sync/additions to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 8, 20239c89db0ede4e110See the full diff
- ▲
  the components_list response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ○
  added the optional property components_list/cert_mgt to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/deployment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/event_listener to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/ingress_controller to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/multi_tenant to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/pipeline to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/progressive_delivery to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/secret_mgt to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property components_list/secret_sync to the response with the 200 status
  response-optional-property-added
- ○
  removed api.cluster.v1.ComponentsList from the components_list response property allOf list for the response status 200
  response-property-all-of-removed
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history