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}/channels
Copy to Clipboard Toggle word wrap
1.2.2.1.1. Description

Create a channel.

1.2.2.1.2. Parameters
Expand
TypeNameDescriptionSchema

Header

COOKIE
required

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

string

Path

namespace
required

Namespace that you want to use, for example, default.

string

Body

body
required

Parameters describing the deployable to be created.

Channel

1.2.2.1.3. Responses
Expand
HTTP CodeDescriptionSchema

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"
    }
  }
}
Copy to Clipboard Toggle word wrap

1.2.2.2. Query all channels for the target namespace

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
Copy to Clipboard Toggle word wrap
1.2.2.2.1. Description

Query your channels for more details.

1.2.2.2.2. Parameters
Expand
TypeNameDescriptionSchema

Header

COOKIE
required

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

string

Path

namespace
required

Namespace that you want to use, for example, default.

string

1.2.2.2.3. Responses
Expand
HTTP CodeDescriptionSchema

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}
Copy to Clipboard Toggle word wrap
1.2.2.3.1. Description

Query a single channels for more details.

1.2.2.3.2. Parameters
Expand
TypeNameDescriptionSchema

Header

COOKIE
required

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

string

Path

channel_name
required

Name of the deployable that you wan to query.

string

Path

namespace
required

Namespace that you want to use, for example, default.

string

1.2.2.3.3. Responses
Expand
HTTP CodeDescriptionSchema

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}
Copy to Clipboard Toggle word wrap
1.2.2.4.1. Parameters
Expand
TypeNameDescriptionSchema

Header

COOKIE
required

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

string

Path

channel_name
required

Name of the Channel that you want to delete.

string

Path

namespace
required

Namespace that you want to use, for example, default.

string

1.2.2.4.2. Responses
Expand
HTTP CodeDescriptionSchema

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

Expand
NameSchema

apiVersion
required

string

kind
required

string

metadata
required

object

spec
required

spec

spec

Expand
NameDescriptionSchema

configMapRef
optional

ObjectReference contains enough information to let you inspect or modify the referred object.

configMapRef

gates
optional

ChannelGate defines criteria for promote to channel

gates

pathname
required

 

string

secretRef
optional

ObjectReference contains enough information to let you inspect or modify the referred object.

secretRef

sourceNamespaces
optional

 

< enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) > array

configMapRef

Expand
NameDescriptionSchema

apiVersion
optional

API version of the referent.

string

fieldPath
optional

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
optional

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

string

name
optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

string

namespace
optional

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

string

resourceVersion
optional

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
optional

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

string

gates

Expand
NameDescriptionSchema

annotations
optional

typical annotations of k8s

annotations

labelSelector
optional

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.

labelSelector

name
optional

 

string

annotations

Expand
NameSchema

key
optional

string

value
optional

string

labelSelector

Expand
NameDescriptionSchema

matchExpressions
optional

matchExpressions is a list of label selector requirements. The requirements are ANDed.

< matchExpressions > array

matchLabels
optional

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

Expand
NameDescriptionSchema

key
required

key is the label key that the selector applies to.

string

operator
required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

string

values
optional

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

Expand
NameDescriptionSchema

apiVersion
optional

API version of the referent.

string

fieldPath
optional

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
optional

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

string

name
optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

string

namespace
optional

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

string

resourceVersion
optional

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
optional

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

string

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat