Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

1.6. Subscriptions API

1.6.1. 概要
リンクのコピー

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Subscription リソースについて説明します。Subscription リソースには、create、query、delete、update の 4 つの要求を使用できます。非推奨: PlacementRule

1.6.1.1. バージョン情報
リンクのコピー

バージョン: 2.9.0

1.6.1.2. URI スキーム
リンクのコピー

ベースパス: /kubernetes/apis
スキーム: HTTPS

1.6.1.3. タグ
リンクのコピー

  • subscriptions.apps.open-cluster-management.io: サブスクリプションを作成して管理します。

1.6.2. パス
リンクのコピー

1.6.2.1. サブスクリプションの作成
リンクのコピー

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
Copy to Clipboard Toggle word wrap
1.6.2.1.1. 説明
リンクのコピー

サブスクリプションを作成します。

1.6.2.1.2. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

Header

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

string

パス

namespace
必須

使用する namespace (例: default)

string

Body

body
必須

作成するサブスクリプションを記述するパラメーター

Subscription

1.6.2.1.3. 応答
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.6.2.1.4. 消費
リンクのコピー
  • subscription/yaml
1.6.2.1.5. タグ
リンクのコピー
  • subscriptions.apps.open-cluster-management.io
1.6.2.1.6. HTTP リクエストの例
リンクのコピー
1.6.2.1.6.1. 要求の 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"
      }
    }
  }
}
Copy to Clipboard Toggle word wrap

1.6.2.2. 全サブスクリプションのクエリー
リンクのコピー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
Copy to Clipboard Toggle word wrap
1.6.2.2.1. 説明
リンクのコピー

サブスクリプションにクエリーを行い、詳細を確認します。

1.6.2.2.2. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

Header

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

string

パス

namespace
必須

使用する namespace (例: default)

string

1.6.2.2.3. レスポンス
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.6.2.2.4. 消費
リンクのコピー
  • subscription/yaml
1.6.2.2.5. タグ
リンクのコピー
  • subscriptions.apps.open-cluster-management.io

1.6.2.3. 単一サブスクリプションのクエリー
リンクのコピー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
Copy to Clipboard Toggle word wrap
1.6.2.3.1. 説明
リンクのコピー

1 つのサブスクリプションにクエリーを行い、詳細を確認します。

1.6.2.3.2. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

Header

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

string

パス

namespace
必須

使用する namespace (例: default)

string

パス

subscription_name
必須

問い合わせるサブスクリプションの名前

string

1.6.2.3.3. レスポンス
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.6.2.3.4. タグ
リンクのコピー
  • subscriptions.apps.open-cluster-management.io

1.6.2.4. サブスクリプションの削除
リンクのコピー

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
Copy to Clipboard Toggle word wrap
1.6.2.4.1. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

Header

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

string

パス

namespace
必須

使用する namespace (例: default)

string

パス

subscription_name
必須

削除するサブスクリプションの名前

string

1.6.2.4.2. レスポンス
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.6.2.4.3. タグ
リンクのコピー
  • subscriptions.apps.open-cluster-management.io

1.6.3. 定義
リンクのコピー

1.6.3.1. サブスクリプション
リンクのコピー

Expand
Nameスキーマ

apiVersion
必須

string

kind
必須

string

metadata
必須

metadata

spec
必須

spec

status
任意

status

metadata

Expand
Nameスキーマ

annotations
任意

object

labels
任意

object

name
任意

string

namespace
任意

string

spec

Expand
名前スキーマ

channel
必須

string

name
任意

string

overrides
任意

overrides array

packageFilter
任意

packageFilter

packageOverrides
任意

packageOverrides array

placement
任意

placement

timewindow
任意

timewindow

overrides

Expand
Nameスキーマ

clusterName
必須

string

clusterOverrides
必須

object array

packageFilter

Expand
Name説明スキーマ

annotations
任意

 

string、string map

filterRef
任意

 

filterRef

labelSelector
任意

 

labelSelector

version
任意

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

string

filterRef

Expand
Nameスキーマ

name
任意

string

labelSelector

Expand
Nameスキーマ

matchExpressions
任意

matchExpressions array

matchLabels
任意

string、string map

matchExpressions

Expand
Nameスキーマ

key
必須

string

operator
必須

string

values
任意

string array

packageOverrides

Expand
Nameスキーマ

packageAlias
任意

string

packageName
必須

string

packageOverrides
任意

object array

placement

Expand
Nameスキーマ

clusterSelector
任意

clusterSelector

clusters
任意

clusters array

local
任意

boolean

placementRef
任意

placementRef

clusterSelector

Expand
Nameスキーマ

matchExpressions
任意

matchExpressions array

matchLabels
任意

string、string map

matchExpressions

Expand
Nameスキーマ

key
必須

string

operator
必須

string

values
任意

string array

clusters

Expand
Nameスキーマ

name
必須

string

placementRef

Expand
Nameスキーマ

apiVersion
任意

string

fieldPath
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

resourceVersion
任意

string

uid
任意

string

timewindow

Expand
Nameスキーマ

daysofweek
任意

string array

hours
任意

hours array

location
任意

string

windowtype
任意

列挙 (active、blocked、Active、Blocked)

hours

Expand
Nameスキーマ

end
任意

string

start
任意

string

status

Expand
Nameスキーマ

lastUpdateTime
任意

string (date-time)

message
任意

string

phase
任意

string

reason
任意

string

statuses
任意

object

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat