1.6. Subscriptions API

1.6.1. 概述

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

1.6.1.1. 版本信息

版本 : 2.8.0

1.6.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.6.1.3. Tags

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

1.6.2. 路径

1.6.2.1. 创建订阅

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

1.6.2.1.1. 描述

创建订阅

1.6.2.1.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的订阅的参数。	Subscription

1.6.2.1.3. 响应

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.6.2.1.4. 使用

subscription/yaml

1.6.2.1.5. Tags

subscriptions.apps.open-cluster-management.io

1.6.2.1.6. HTTP 请求示例

1.6.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"
      }
    }
  }
}

1.6.2.2. 查询所有订阅

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

1.6.2.2.1. 描述

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

1.6.2.2.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.6.2.2.3. 响应

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.6.2.2.4. 使用

subscription/yaml

1.6.2.2.5. Tags

subscriptions.apps.open-cluster-management.io

1.6.2.3. 查询单个订阅

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

1.6.2.3.1. 描述

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

1.6.2.3.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
路径	subscription_name 必需	要查询的订阅名称。	字符串

1.6.2.3.3. 响应

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.6.2.3.4. Tags

subscriptions.apps.open-cluster-management.io

1.6.2.4. 创建一个订阅：

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

1.6.2.4.1. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
路径	subscription_name 必需	要删除的订阅的名称。	字符串

1.6.2.4.2. 响应

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.6.2.4.3. Tags

subscriptions.apps.open-cluster-management.io

1.6.3. 定义

1.6.3.1. Subscription

Name	模式
apiVersion 必需	字符串
kind 必需	字符串
metadata 必需	metadata
spec 必需	spec
status 可选	status

metadata

Name	模式
annotations 可选	对象
labels 可选	对象
name 可选	字符串
namespace 可选	字符串

spec

Name	模式
channel 必需	字符串
name 可选	字符串
overrides 可选	overrides 数组
packageFilter 可选	packageFilter
packageOverrides 可选	packageOverrides 数组
placement 可选	placement
timewindow 可选	timewindow

overrides

Name	模式
clusterName 必需	字符串
clusterOverrides 必需	对象数组

packageFilter

Name	描述	模式
annotations 可选		字符串、字符串映射
filterRef 可选		filterRef
labelSelector 可选		labelSelector
version 可选	Pattern : `"()((\\.[0-9])(\\.)\|(\\.[0-9])?(\\.[xX]))$"`	字符串

filterRef

Name	模式
name 可选	字符串

labelSelector

Name	模式
matchExpressions 可选	matchExpressions 数组
matchLabels 可选	字符串、字符串映射

matchExpressions

Name	模式
key 必需	字符串
operator 必需	字符串
values 可选	字符串数组

packageOverrides

Name	模式
packageAlias 可选	字符串
packageName 必需	字符串
packageOverrides 可选	对象数组

placement

Name	模式
clusterSelector 可选	clusterSelector
clusters 可选	clusters 数组
local 可选	布尔值
placementRef 可选	placementRef

clusterSelector

Name	模式
matchExpressions 可选	matchExpressions 数组
matchLabels 可选	字符串、字符串映射