Overview

This documentation is for the Clusterset resource for multicluster engine for Kubernetes. Clusterset resource has four possible requests: create, query, delete and update.

Contact information

Contact Email : apiteam@swagger.io

License information

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/

URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

Tags

  • cluster.open-cluster-management.io : Create and manage Clustersets

External Docs

Description : Find out more about Swagger.
URL : http://swagger.io

Paths

Query all clustersets

GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets

Description

Query your Clustersets for more details.

Parameters

Type Name Description Schema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Responses

HTTP Code Description Schema

200

Success

No Content

403

Access forbidden

No Content

404

Resource not found

No Content

500

Internal service error

No Content

503

Service unavailable

No Content

Consumes

  • clusterset/yaml

Tags

  • cluster.open-cluster-management.io

Create a clusterset

POST /cluster.open-cluster-management.io/v1alpha1/managedclustersets

Description

Create a Clusterset.

Parameters

Type Name Description Schema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Body

body
required

Parameters describing the clusterset to be created.

Clusterset

Responses

HTTP Code Description Schema

200

Success

No Content

403

Access forbidden

No Content

404

Resource not found

No Content

500

Internal service error

No Content

503

Service unavailable

No Content

Consumes

  • clusterset/yaml

Tags

  • cluster.open-cluster-management.io

Example HTTP request

Request body
{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "ManagedClusterSet",
  "metadata" : {
    "name" : "clusterset1"
  },
  "spec": { },
  "status" : { }
}

Query a single clusterset

GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}

Description

Query a single clusterset for more details.

Parameters

Type Name Description Schema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Path

clusterset_name
required

Name of the clusterset that you want to query.

string

Responses

HTTP Code Description Schema

200

Success

No Content

403

Access forbidden

No Content

404

Resource not found

No Content

500

Internal service error

No Content

503

Service unavailable

No Content

Tags

  • cluster.open-cluster-management.io

Delete a clusterset

DELETE /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}

Description

Delete a single clusterset.

Parameters

Type Name Description Schema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Path

clusterset_name
required

Name of the clusterset that you want to delete.

string

Responses

HTTP Code Description Schema

200

Success

No Content

403

Access forbidden

No Content

404

Resource not found

No Content

500

Internal service error

No Content

503

Service unavailable

No Content

Tags

  • cluster.open-cluster-management.io

Definitions

Clusterset

Name Schema

apiVersion
required

string

kind
required

string

metadata
required

object