Overview
This documentation is for the clusterview resource for multicluster engine for Kubernetes. The clusterview resource provides a CLI command that enables you to view a list of the managed clusters and managed cluster sets that that you can access. The three possible requests are: list, get, and watch.
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
-
clusterview.open-cluster-management.io : View a list of managed clusters that your ID can access.
External Docs
Description : Find out more about Swagger.
URL : http://swagger.io
Paths
Get managed clusters
GET /managedclusters.clusterview.open-cluster-management.io
Description
View a list of the managed clusters that you can access.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
COOKIE |
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
-
managedcluster/yaml
Tags
-
clusterview.open-cluster-management.io
List managed clusters
LIST /managedclusters.clusterview.open-cluster-management.io
Description
View a list of the managed clusters that you can access.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
COOKIE |
Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. |
string |
Body |
body |
Name of the user ID for which you want to list the managed clusters. |
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
-
managedcluster/yaml
Tags
-
clusterview.open-cluster-management.io
Example HTTP request
Request body
{
"apiVersion" : "clusterview.open-cluster-management.io/v1alpha1",
"kind" : "ClusterView",
"metadata" : {
"name" : "<user_ID>"
},
"spec": { },
"status" : { }
}Watch the managed cluster sets
WATCH /managedclusters.clusterview.open-cluster-management.io
Description
Watch the managed clusters that you can access.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
COOKIE |
Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. |
string |
Path |
clusterview_name |
Name of the user ID that you want to watch. |
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 |
List the managed cluster sets.
GET /managedclustersets.clusterview.open-cluster-management.io
Description
List the managed clusters that you can access.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
COOKIE |
Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. |
string |
Path |
clusterview_name |
Name of the user ID that you want to watch. |
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 |
List the managed cluster sets.
LIST /managedclustersets.clusterview.open-cluster-management.io
Description
List the managed clusters that you can access.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
COOKIE |
Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. |
string |
Path |
clusterview_name |
Name of the user ID that you want to watch. |
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 |
Watch the managed cluster sets.
WATCH /managedclustersets.clusterview.open-cluster-management.io
Description
Watch the managed clusters that you can access.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
COOKIE |
Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. |
string |
Path |
clusterview_name |
Name of the user ID that you want to watch. |
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 |