Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

1.7. Subscriptions API

deprecated ： API 的文档已弃用。使用控制台或 oc 命令中的 API Explorer 查看当前和支持的 API。

1.7.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的订阅资源相关的 API 信息。订阅资源有 4 个可用的请求：create、query、delete 和 update。已弃用： PlacementRule

1.7.1.1. 版本信息
复制链接

版本 2.7

1.7.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.7.1.3. Tags
复制链接

  • subscription.apps.open-cluster-management.io : 创建和管理订阅

1.7.2. 路径
复制链接

1.7.2.1. 创建订阅
复制链接

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
Copy to Clipboard Toggle word wrap
1.7.2.1.1. 描述
复制链接

创建订阅

1.7.2.1.2. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

要使用的命名空间，如 default。

字符串

Body

body
必需

描述要创建的订阅的参数。

Subscription

1.7.2.1.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.1.4. 使用
复制链接
  • subscription/yaml
1.7.2.1.5. Tags
复制链接
  • subscriptions.apps.open-cluster-management.io
1.7.2.1.6. HTTP 请求示例
复制链接
1.7.2.1.6.1. 请求正文
复制链接
{
  "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"
      }
    }
  }
}
Copy to Clipboard Toggle word wrap

1.7.2.2. 查询所有订阅
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
Copy to Clipboard Toggle word wrap
1.7.2.2.1. 描述
复制链接

查询您的订阅以获取更多详情。

1.7.2.2.2. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

要使用的命名空间，如 default。

字符串

1.7.2.2.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.2.4. 使用
复制链接
  • subscription/yaml
1.7.2.2.5. Tags
复制链接
  • subscriptions.apps.open-cluster-management.io

1.7.2.3. 查询单个订阅
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
Copy to Clipboard Toggle word wrap
1.7.2.3.1. 描述
复制链接

查询单个订阅以了解更多详情。

1.7.2.3.2. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

要使用的命名空间，如 default。

字符串

路径

subscription_name
必需

要查询的订阅名称。

字符串

1.7.2.3.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.3.4. Tags
复制链接
  • subscriptions.apps.open-cluster-management.io

1.7.2.4. 创建一个订阅：
复制链接

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
Copy to Clipboard Toggle word wrap
1.7.2.4.1. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

要使用的命名空间，如 default。

字符串

路径

subscription_name
必需

要删除的订阅的名称。

字符串

1.7.2.4.2. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.4.3. Tags
复制链接
  • subscriptions.apps.open-cluster-management.io

1.7.3. 定义
复制链接

1.7.3.1. Subscription
复制链接

Expand
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

metadata

spec
必需

spec

status
可选

status

metadata

Expand
Name模式

annotations
可选

对象

labels
可选

对象

name
可选

字符串

namespace
可选

字符串

spec

Expand
Name模式

channel
必需

字符串

name
可选

字符串

overrides
可选

overrides 数组

packageFilter
可选

packageFilter

packageOverrides
可选

packageOverrides 数组

placement
可选

placement

timewindow
可选

timewindow

overrides

Expand
Name模式

clusterName
必需

字符串

clusterOverrides
必需

对象数组

packageFilter

Expand
Name描述模式

annotations
可选

 

字符串、字符串映射

filterRef
可选

 

filterRef

labelSelector
可选

 

labelSelector

version
可选

Pattern : "()((\\.[0-9])(\\.)|(\\.[0-9])?(\\.[xX]))$"

字符串

filterRef

Expand
Name模式

name
可选

字符串

labelSelector

Expand
Name模式

matchExpressions
可选

matchExpressions 数组

matchLabels
可选

字符串、字符串映射

matchExpressions

Expand
Name模式

key
必需

字符串

operator
必需

字符串

values
可选

字符串数组

packageOverrides

Expand
Name模式

packageAlias
可选

字符串

packageName
必需

字符串

packageOverrides
可选

对象数组

placement

Expand
Name模式

clusterSelector
可选

clusterSelector

clusters
可选

clusters 数组

local
可选

布尔值

placementRef
可选

placementRef

clusterSelector

Expand
Name模式

matchExpressions
可选

matchExpressions 数组

matchLabels
可选

字符串、字符串映射

matchExpressions

Expand
Name模式

key
必需

字符串

operator
必需

字符串

values
可选

字符串数组

clusters

Expand
Name模式

name
必需

字符串

placementRef

Expand
Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

resourceVersion
可选

字符串

uid
可选

字符串

timewindow

Expand
Name模式

daysofweek
可选

字符串数组

hours
可选

hours 数组

location
可选

字符串

windowtype
可选

enum（active、blocked、Active、Blocked）

hours

Expand
Name模式

end
可选

字符串

start
可选

字符串

status

Expand
Name模式

lastUpdateTime
可选

字符串（date-time）

message
可选

字符串

phase
可选

字符串

reason
可选

字符串

statuses
可选

object

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat