APIs
APIs
摘要
第 1 章 APIs
You can access APIs for to create and manage application resources, channels, subscriptions, and to query information.
For more information, review the API documentation for each of the following resources:
1.1. Clusters API
1.1.1. Overview
This documentation is for the cluster resource for Red Hat Advanced Cluster Management for Kubernetes. Cluster resource has four possible requests: create, query, delete and update.
1.1.1.1. Version information
Version : 2.0.0
1.1.1.2. Contact information
Contact Email : apiteam@swagger.io
1.1.1.3. License information
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
1.1.1.4. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.1.1.5. Tags
- cluster.open-cluster-management.io : Create and manage clusters
1.1.1.6. External Docs
Description : Find out more about Swagger.
URL : http://swagger.io
1.1.2. Paths
1.1.2.1. Query all clusters
GET /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.1.1. Description
Query your clusters for more details.
1.1.2.1.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
1.1.2.1.3. 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 |
1.1.2.1.4. Consumes
-
cluster/yaml
1.1.2.1.5. Tags
- cluster.open-cluster-management.io
1.1.2.2. Create a cluster
POST /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.2.1. Description
Create a cluster
1.1.2.2.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Body |
body | Parameters describing the cluster to be created. |
1.1.2.2.3. 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 |
1.1.2.2.4. Consumes
-
cluster/yaml
1.1.2.2.5. Tags
- cluster.open-cluster-management.io
1.1.2.2.6. Example HTTP request
1.1.2.2.6.1. Request body
{
"apiVersion" : "cluster.open-cluster-management.io/v1",
"kind" : "ManagedCluster",
"metadata" : {
"labels" : {
"vendor" : "OpenShift"
},
"name" : "cluster1",
},
"spec": {
"hubAcceptsClient": true,
"managedClusterClientConfigs": [
{
"caBundle": "test",
"url": "https://test.com"
}
]
},
"status" : { }
}1.1.2.3. Query a single cluster
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}1.1.2.3.1. Description
Query a single cluster for more details.
1.1.2.3.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
cluster_name | Name of the cluster that you want to query. | string |
1.1.2.3.3. 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 |
1.1.2.3.4. Tags
- cluster.open-cluster-management.io
1.1.2.4. Delete a cluster
DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}1.1.2.4.1. Description
Delete a single cluster
1.1.2.4.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
cluster_name | Name of the cluster that you want to delete. | string |
1.1.2.4.3. 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 |
1.1.2.4.4. Tags
- cluster.open-cluster-management.io
1.1.3. Definitions
1.1.3.1. Cluster
| Name | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| Name | Schema |
|---|---|
|
hubAcceptsClient | bool |
|
managedClusterClientConfigs | < managedClusterClientConfigs > array |
|
leaseDurationSeconds | integer (int32) |
managedClusterClientConfigs
| Name | Description | Schema |
|---|---|---|
|
URL | string | |
|
CABundle |
Pattern : | string (byte) |
1.2. Channels API
1.2.1. Overview
This documentation is for the Channel resource for Red Hat Advanced Cluster Management for Kubernetes. The Channel resource has four possible requests: create, query, delete and update.
1.2.1.1. Version information
Version : 2.0.0
1.2.1.2. Contact information
Contact Email : apiteam@swagger.io
1.2.1.3. License information
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
1.2.1.4. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.2.1.5. Tags
- channels.apps.open-cluster-management.io : Create and manage deployables
1.2.1.6. External Docs
Description : Find out more about Swagger.
URL : http://swagger.io
1.2.2. Paths
1.2.2.1. Create a channel
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels1.2.2.1.1. Description
Create a channel.
1.2.2.1.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
| Body |
body | Parameters describing the deployable to be created. |
1.2.2.1.3. 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 |
1.2.2.1.4. Consumes
-
application/yaml
1.2.2.1.5. Tags
- channels.apps.open-cluster-management.io
1.2.2.1.6. Example HTTP request
1.2.2.1.6.1. Request body
{
"apiVersion" : "apps.open-cluster-management.io/v1",
"kind" : "Channel",
"name" : "sample-channel",
"namespace" : "default",
"spec" : {
"type" : "Git",
"pathname" : "https://github.com/IBM/charts.git",
"configMapRef" : {
"name" : "bookinfo-resource-filter-configmap",
"kind" : "configmap"
}
}
}1.2.2.2. Query all channels for the target namespace
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels1.2.2.2.1. Description
Query your channels for more details.
1.2.2.2.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.2.2.2.3. 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 |
1.2.2.2.4. Consumes
-
application/yaml
1.2.2.2.5. Tags
- channels.apps.open-cluster-management.io
1.2.2.3. Query a single channels of a namespace
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}1.2.2.3.1. Description
Query a single channels for more details.
1.2.2.3.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
channel_name | Name of the deployable that you wan to query. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.2.2.3.3. 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 |
1.2.2.3.4. Tags
- channels.apps.open-cluster-management.io
1.2.2.4. Delete a Channel
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}1.2.2.4.1. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
channel_name | Name of the Channel that you want to delete. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.2.2.4.2. 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 |
1.2.2.4.3. Tags
- channels.apps.open-cluster-management.io
1.2.3. Definitions
1.2.3.1. Channel
| Name | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| Name | Description | Schema |
|---|---|---|
|
configMapRef | ObjectReference contains enough information to let you inspect or modify the referred object. | |
|
gates | ChannelGate defines criteria for promote to channel | |
|
pathname | string | |
|
secretRef | ObjectReference contains enough information to let you inspect or modify the referred object. | |
|
sourceNamespaces | < enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) > array |
configMapRef
| Name | Description | Schema |
|---|---|---|
|
apiVersion | API version of the referent. | string |
|
fieldPath | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. | string |
|
kind | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | string |
|
name | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | string |
|
namespace | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string |
|
resourceVersion | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency | string |
|
uid | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | string |
gates
| Name | Description | Schema |
|---|---|---|
|
annotations | typical annotations of k8s | |
|
labelSelector | A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. | |
|
name | string |
annotations
| Name | Schema |
|---|---|
|
key | string |
|
value | string |
labelSelector
| Name | Description | Schema |
|---|---|---|
|
matchExpressions | matchExpressions is a list of label selector requirements. The requirements are ANDed. | < matchExpressions > array |
|
matchLabels | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. | < string, string > map |
matchExpressions
| Name | Description | Schema |
|---|---|---|
|
key | key is the label key that the selector applies to. | string |
|
operator | operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. | string |
|
values | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. | < string > array |
secretRef
| Name | Description | Schema |
|---|---|---|
|
apiVersion | API version of the referent. | string |
|
fieldPath | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. | string |
|
kind | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | string |
|
name | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | string |
|
namespace | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string |
|
resourceVersion | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency | string |
|
uid | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | string |
1.3. Subscriptions API
1.3.1. Overview
This documentation is for the Subscription resource for Red Hat Advanced Cluster Management for Kubernetes. The Subscription resource has four possible requests: create, query, delete and update.
1.3.1.1. Version information
Version : 2.0.0
1.3.1.2. Contact information
Contact Email : apiteam@swagger.io
1.3.1.3. License information
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
1.3.1.4. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.3.1.5. Tags
- subscriptions.apps.open-cluster-management.io : Create and manage subscriptions
1.3.1.6. External Docs
Description : Find out more about Swagger.
URL : http://swagger.io
1.3.2. Paths
1.3.2.1. Create a subscription
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions1.3.2.1.1. Description
Create a subscription.
1.3.2.1.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
| Body |
body | Parameters describing the subscription to be created. |
1.3.2.1.3. 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 |
1.3.2.1.4. Consumes
-
subscription/yaml
1.3.2.1.5. Tags
- subscriptions.apps.open-cluster-management.io
1.3.2.1.6. Example HTTP request
1.3.2.1.6.1. Request body
{
"apiVersion" : "apps.open-cluster-management.io/v1",
"kind" : "Subscription",
"metadata" : {
"name" : "sample_subscription",
"namespace" : "default",
"labels" : {
"app" : "sample_subscription-app"
},
"annotations" : {
"apps.open-cluster-management.io/git-path" : "apps/sample/",
"apps.open-cluster-management.io/git-branch" : "sample_branch"
}
},
"spec" : {
"channel" : "channel_namespace/sample_channel",
"packageOverrides" : [ {
"packageName" : "my-sample-application",
"packageAlias" : "the-sample-app",
"packageOverrides" : [ {
"path" : "spec",
"value" : {
"persistence" : {
"enabled" : false,
"useDynamicProvisioning" : false
},
"license" : "accept",
"tls" : {
"hostname" : "my-mcm-cluster.icp"
},
"sso" : {
"registrationImage" : {
"pullSecret" : "hub-repo-docker-secret"
}
}
}
} ]
} ],
"placement" : {
"placementRef" : {
"kind" : "PlacementRule",
"name" : "demo-clusters"
}
}
}
}1.3.2.2. Query all subscriptions
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions1.3.2.2.1. Description
Query your subscriptions for more details.
1.3.2.2.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.3.2.2.3. 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 |
1.3.2.2.4. Consumes
-
subscription/yaml
1.3.2.2.5. Tags
- subscriptions.apps.open-cluster-management.io
1.3.2.3. Query a single subscription
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}1.3.2.3.1. Description
Query a single subscription for more details.
1.3.2.3.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
| Path |
subscription_name | Name of the subscription that you wan to query. | string |
1.3.2.3.3. 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 |
1.3.2.3.4. Tags
- subscriptions.apps.open-cluster-management.io
1.3.2.4. Delete a subscription
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}1.3.2.4.1. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
| Path |
subscription_name | Name of the subscription that you want to delete. | string |
1.3.2.4.2. 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 |
1.3.2.4.3. Tags
- subscriptions.apps.open-cluster-management.io
1.3.3. Definitions
1.3.3.1. Subscription
| Name | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | |
|
spec | |
|
status |
metadata
| Name | Schema |
|---|---|
|
annotations | object |
|
labels | object |
|
name | string |
|
namespace | string |
spec
| Name | Schema |
|---|---|
|
channel | string |
|
name | string |
|
overrides | < overrides > array |
|
packageFilter | |
|
packageOverrides | < packageOverrides > array |
|
placement | |
|
timewindow |
overrides
| Name | Schema |
|---|---|
|
clusterName | string |
|
clusterOverrides | < object > array |
packageFilter
| Name | Description | Schema |
|---|---|---|
|
annotations | < string, string > map | |
|
filterRef | ||
|
labelSelector | ||
|
version |
Pattern : | string |
filterRef
| Name | Schema |
|---|---|
|
name | string |
labelSelector
| Name | Schema |
|---|---|
|
matchExpressions | < matchExpressions > array |
|
matchLabels | < string, string > map |
matchExpressions
| Name | Schema |
|---|---|
|
key | string |
|
operator | string |
|
values | < string > array |
packageOverrides
| Name | Schema |
|---|---|
|
packageAlias | string |
|
packageName | string |
|
packageOverrides | < object > array |
placement
| Name | Schema |
|---|---|
|
clusterSelector | |
|
clusters | < clusters > array |
|
local | boolean |
|
placementRef |
clusterSelector
| Name | Schema |
|---|---|
|
matchExpressions | < matchExpressions > array |
|
matchLabels | < string, string > map |
matchExpressions
| Name | Schema |
|---|---|
|
key | string |
|
operator | string |
|
values | < string > array |
clusters
| Name | Schema |
|---|---|
|
name | string |
placementRef
| Name | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
timewindow
| Name | Schema |
|---|---|
|
daysofweek | < string > array |
|
hours | < hours > array |
|
location | string |
|
windowtype | enum (active, blocked, Active, Blocked) |
hours
| Name | Schema |
|---|---|
|
end | string |
|
start | string |
status
| Name | Schema |
|---|---|
|
lastUpdateTime | string (date-time) |
|
message | string |
|
phase | string |
|
reason | string |
|
statuses | object |
1.4. Placementrules API
1.4.1. Overview
This documentation is for the Placementrule resource for Red Hat Advanced Cluster Management for Kubernetes. The Placementrule resource has four possible requests: create, query, delete and update.
1.4.1.1. Version information
Version : 2.0.0
1.4.1.2. Contact information
Contact Email : apiteam@swagger.io
1.4.1.3. License information
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
1.4.1.4. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.4.1.5. Tags
- placementrules.apps.open-cluster-management.io : Create and manage placementrules
1.4.1.6. External Docs
Description : Find out more about Swagger.
URL : http://swagger.io
1.4.2. Paths
1.4.2.1. Create a placementrule
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules1.4.2.1.1. Description
Create a placementrule.
1.4.2.1.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
| Body |
body | Parameters describing the placementrule to be created. |
1.4.2.1.3. 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 |
1.4.2.1.4. Consumes
-
application/yaml
1.4.2.1.5. Tags
- placementrules.apps.open-cluster-management.io
1.4.2.1.6. Example HTTP request
1.4.2.1.6.1. Request body
{
"apiVersion" : "apps.open-cluster-management.io/v1",
"kind" : "PlacementRule",
"metadata" : {
"name" : "towhichcluster",
"namespace" : "ns-sub-1"
},
"spec" : {
"clusterConditions" : [ {
"type": "ManagedClusterConditionAvailable",
"status": "True"
} ],
"clusterSelector" : { }
}
}1.4.2.2. Query all placementrules
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules1.4.2.2.1. Description
Query your placementrules for more details.
1.4.2.2.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.4.2.2.3. 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 |
1.4.2.2.4. Consumes
-
application/yaml
1.4.2.2.5. Tags
- placementrules.apps.open-cluster-management.io
1.4.2.3. Query a single placementrule
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}1.4.2.3.1. Description
Query a single placementrule for more details.
1.4.2.3.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
| Path |
placementrule_name | Name of the placementrule that you want to query. | string |
1.4.2.3.3. 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 |
1.4.2.3.4. Tags
- placementrules.apps.open-cluster-management.io
1.4.2.4. Delete a placementrule
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}1.4.2.4.1. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
| Path |
placementrule_name | Name of the placementrule that you want to delete. | string |
1.4.2.4.2. 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 |
1.4.2.4.3. Tags
- placementrules.apps.open-cluster-management.io
1.4.3. Definitions
1.4.3.1. Placementrule
| Name | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| Name | Schema |
|---|---|
|
clusterConditions | < clusterConditions > array |
|
clusterReplicas | integer |
|
clusterSelector | |
|
clusters | < clusters > array |
|
policies | < policies > array |
|
resourceHint | |
|
schedulerName | string |
clusterConditions
| Name | Schema |
|---|---|
|
status | string |
|
type | string |
clusterSelector
| Name | Schema |
|---|---|
|
matchExpressions | < matchExpressions > array |
|
matchLabels | < string, string > map |
matchExpressions
| Name | Schema |
|---|---|
|
key | string |
|
operator | string |
|
values | < string > array |
clusters
| Name | Schema |
|---|---|
|
name | string |
policies
| Name | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
resourceHint
| Name | Schema |
|---|---|
|
order | string |
|
type | string |
1.5. Applications API
1.5.1. Overview
This documentation is for the Application resource for Red Hat Advanced Cluster Management for Kubernetes. Application resource has four possible requests: create, query, delete and update.
1.5.1.1. Version information
Version : 2.0.0
1.5.1.2. Contact information
Contact Email : apiteam@swagger.io
1.5.1.3. License information
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
1.5.1.4. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.5.1.5. Tags
- applications.app.k8s.io : Create and manage applications
1.5.1.6. External Docs
Description : Find out more about Swagger.
URL : http://swagger.io
1.5.2. Paths
1.5.2.1. Create a application
POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications1.5.2.1.1. Description
Create a application.
1.5.2.1.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
| Body |
body | Parameters describing the application to be created. |
1.5.2.1.3. 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 |
1.5.2.1.4. Consumes
-
application/yaml
1.5.2.1.5. Tags
- applications.app.k8s.io
1.5.2.1.6. Example HTTP request
1.5.2.1.6.1. Request body
{
"apiVersion" : "app.k8s.io/v1beta1",
"kind" : "Application",
"metadata" : {
"labels" : {
"app" : "nginx-app-details"
},
"name" : "nginx-app-3",
"namespace" : "ns-sub-1"
},
"spec" : {
"componentKinds" : [ {
"group" : "apps.open-cluster-management.io",
"kind" : "Subscription"
} ]
},
"selector" : {
"matchLabels" : {
"app" : "nginx-app-details"
}
},
"status" : { }
}1.5.2.2. Query all applications
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications1.5.2.2.1. Description
Query your applications for more details.
1.5.2.2.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.5.2.2.3. 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 |
1.5.2.2.4. Consumes
-
application/yaml
1.5.2.2.5. Tags
- applications.app.k8s.io
1.5.2.3. Query a single application
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}1.5.2.3.1. Description
Query a single application for more details.
1.5.2.3.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
application_name | Name of the application that you wan to query. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.5.2.3.3. 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 |
1.5.2.3.4. Tags
- applications.app.k8s.io
1.5.2.4. Delete a application
DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}1.5.2.4.1. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
application_name | Name of the application that you want to delete. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.5.2.4.2. 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 |
1.5.2.4.3. Tags
- applications.app.k8s.io
1.5.3. Definitions
1.5.3.1. Application
| Name | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| Name | Schema |
|---|---|
|
assemblyPhase | string |
|
componentKinds | < object > array |
|
descriptor | |
|
info | < info > array |
|
selector | object |
descriptor
| Name | Schema |
|---|---|
|
description | string |
|
icons | < icons > array |
|
keywords | < string > array |
|
links | < links > array |
|
maintainers | < maintainers > array |
|
notes | string |
|
owners | < owners > array |
|
type | string |
|
version | string |
icons
| Name | Schema |
|---|---|
|
size | string |
|
src | string |
|
type | string |
links
| Name | Schema |
|---|---|
|
description | string |
|
url | string |
maintainers
| Name | Schema |
|---|---|
|
email | string |
|
name | string |
|
url | string |
owners
| Name | Schema |
|---|---|
|
email | string |
|
name | string |
|
url | string |
info
| Name | Schema |
|---|---|
|
name | string |
|
type | string |
|
value | string |
|
valueFrom |
valueFrom
| Name | Schema |
|---|---|
|
configMapKeyRef | |
|
ingressRef | |
|
secretKeyRef | |
|
serviceRef | |
|
type | string |
configMapKeyRef
| Name | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
key | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
ingressRef
| Name | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
host | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
path | string |
|
resourceVersion | string |
|
uid | string |
secretKeyRef
| Name | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
key | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
serviceRef
| Name | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
path | string |
|
port | integer (int32) |
|
resourceVersion | string |
|
uid | string |
1.6. Helm API
1.6.1. Overview
This documentation is for the HelmRelease resource for Red Hat Advanced Cluster Management for Kubernetes. The HelmRelease resource has four possible requests: create, query, delete and update.
1.6.1.1. Version information
Version : 2.0.0
1.6.1.2. Contact information
Contact Email : apiteam@swagger.io
1.6.1.3. License information
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
1.6.1.4. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.6.1.5. Tags
- helmreleases.apps.open-cluster-management.io : Create and manage helmreleases
1.6.1.6. External Docs
Description : Find out more about Swagger.
URL : http://swagger.io
1.6.2. Paths
1.6.2.1. Create a helmrelease
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases1.6.2.1.1. Description
Create a helmrelease.
1.6.2.1.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
| Body |
body | Parameters describing the helmrelease to be created. |
1.6.2.1.3. 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 |
1.6.2.1.4. Consumes
-
application/yaml
1.6.2.1.5. Tags
- helmreleases.apps.open-cluster-management.io
1.6.2.1.6. Example HTTP request
1.6.2.1.6.1. Request body
{
"apiVersion" : "apps.open-cluster-management.io/v1",
"kind" : "HelmRelease",
"metadata" : {
"name" : "nginx-ingress",
"namespace" : "default"
},
"repo" : {
"chartName" : "nginx-ingress",
"source" : {
"helmRepo" : {
"urls" : [ "https://kubernetes-charts.storage.googleapis.com/nginx-ingress-1.26.0.tgz" ]
},
"type" : "helmrepo"
},
"version" : "1.26.0"
},
"spec" : {
"defaultBackend" : {
"replicaCount" : 3
}
}
}1.6.2.2. Query all helmreleases
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases1.6.2.2.1. Description
Query your helmreleases for more details.
1.6.2.2.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.6.2.2.3. 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 |
1.6.2.2.4. Consumes
-
application/yaml
1.6.2.2.5. Tags
- helmreleases.apps.open-cluster-management.io
1.6.2.3. Query a single helmrelease
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}1.6.2.3.1. Description
Query a single helmrelease for more details.
1.6.2.3.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
helmrelease_name | Name of the helmrelease that you wan to query. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.6.2.3.3. 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 |
1.6.2.3.4. Tags
- helmreleases.apps.open-cluster-management.io
1.6.2.4. Delete a helmrelease
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}1.6.2.4.1. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
helmrelease_name | Name of the helmrelease that you want to delete. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.6.2.4.2. 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 |
1.6.2.4.3. Tags
- helmreleases.apps.open-cluster-management.io
1.6.3. Definitions
1.6.3.1. HelmRelease
| Name | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
repo | |
|
spec | object |
|
status |
repo
| Name | Schema |
|---|---|
|
chartName | string |
|
configMapRef | |
|
secretRef | |
|
source | |
|
version | string |
configMapRef
| Name | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
secretRef
| Name | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
source
github
| Name | Schema |
|---|---|
|
branch | string |
|
chartPath | string |
|
urls | < string > array |
helmRepo
| Name | Schema |
|---|---|
|
urls | < string > array |
status
| Name | Schema |
|---|---|
|
conditions | < conditions > array |
|
deployedRelease |
conditions
| Name | Schema |
|---|---|
|
lastTransitionTime | string (date-time) |
|
message | string |
|
reason | string |
|
status | string |
|
type | string |
deployedRelease
| Name | Schema |
|---|---|
|
manifest | string |
|
name | string |
1.7. Policy API
1.7.1. Overview
This documentation is for the Policy resource for Red Hat Advanced Cluster Management for Kubernetes. The Policy resource has four possible requests: create, query, delete and update.
1.7.1.1. Version information
Version : 2.0.0
1.7.1.2. Contact information
Contact Email : apiteam@swagger.io
1.7.1.3. License information
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
1.7.1.4. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.7.1.5. Tags
- policy.open-cluster-management.io/v1 : Create and manage policies
1.7.1.6. External Docs
Description : Find out more about Swagger.
URL : http://swagger.io
1.7.2. Paths
1.7.2.1. Create a policy
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}1.7.2.1.1. Description
Create a policy.
1.7.2.1.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
| Body |
body | Parameters describing the policy to be created. |
1.7.2.1.3. 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 |
1.7.2.1.4. Consumes
-
application/json
1.7.2.1.5. Tags
- policy.open-cluster-management.io
1.7.2.1.6. Example HTTP request
1.7.2.1.6.1. Request body
{
"apiVersion": "policy.open-cluster-management.io/v1/v1alpha1",
"kind": "Policy",
"metadata": {
"name": "test-policy-swagger",
"description": "Example body for Policy API Swagger docs"
},
"spec": {
"remediationAction": "enforce",
"namespaces": {
"include": [
"default"
],
"exclude": [
"kube*"
]
},
"policy-templates": {
"kind": "ConfigurationPolicy",
"apiVersion": "policy.open-cluster-management.io/v1alpha1",
"complianceType": "musthave",
"metadata": {
"namespace": null,
"name": "test-role"
},
"selector": {
"matchLabels": {
"cloud": "IBM"
}
},
"spec" : {
"object-templates": {
"complianceType": "mustHave",
"objectDefinition": {
"apiVersion": "rbac.authorization.k8s.io/v1",
"kind": "Role",
"metadata": {
"name": "role-policy",
},
"rules": [
{
"apiGroups": [
"extensions",
"apps"
],
"resources": [
"deployments"
],
"verbs": [
"get",
"list",
"watch",
"delete"
]
},
{
"apiGroups": [
"core"
],
"resources": [
"pods"
],
"verbs": [
"create",
"update",
"patch"
]
},
{
"apiGroups": [
"core"
],
"resources": [
"secrets"
],
"verbs": [
"get",
"watch",
"list",
"create",
"delete",
"update",
"patchß"
],
},
],
},
},
},
},1.7.2.2. Query all policies
GET /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}1.7.2.2.1. Description
Query your policies for more details.
1.7.2.2.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
namespace | Namespace that you want to apply the policy to, for example, default. | string |
1.7.2.2.3. 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 |
1.7.2.2.4. Consumes
-
application/json
1.7.2.2.5. Tags
- policy.open-cluster-management.io
1.7.2.3. Query a single policy
GET /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}1.7.2.3.1. Description
Query a single policy for more details.
1.7.2.3.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
policy_name | Name of the policy that you want to query. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.7.2.3.3. 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 |
1.7.2.3.4. Tags
- policy.open-cluster-management.io
1.7.2.4. Delete a policy
DELETE /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}1.7.2.4.1. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
| Path |
policy_name | Name of the policy that you want to delete. | string |
| Path |
namespace | Namespace that you want to use, for example, default. | string |
1.7.2.4.2. 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 |
1.7.2.4.3. Tags
- policy.open-cluster-management.io
1.7.3. Definitions
1.7.3.1. Policy
| Name | Description | Schema |
|---|---|---|
|
apiVersion | The versioned schema of Policy. | string |
|
kind | String value that represents the REST resource. | string |
|
metadata | Describes rules that define the policy. | object |
spec
| Name | Description | Schema |
|---|---|---|
|
remediationAction | Value that represents how violations are handled as defined in the resource. | string |
|
namespace | Value that represents which namespaces the policy is applied. | string |
policy-templates
| Name | Description | Schema |
|---|---|---|
|
apiVersion | The versioned schema of Policy. | string |
|
kind | String value that represents the REST resource. | string |
|
complianceType | The compliance standard. | string |
|
metadata | Describes rules that define the policy. | object |
|
clusterConditions | Section to define labels. | string |
|
rules | string |
selector
| Name | Description | Schema |
|---|---|---|
|
matchLabels | The label that is required for the policy to be applied to a namespace. | object |
|
cloud | The label that is required for the policy to be applied to a cloud provider. | string |
rules
| Name | Description | Schema |
|---|---|---|
|
apiGroups | List of APIs that the rule applies to. | string |
|
resources | A list of resource types. | object |
|
verbs | A list of verbs. | string |