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

1.12. Search customization API

1.12.1. 概要
リンクのコピー

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

1.12.1.1. ライセンス情報
リンクのコピー

ライセンス: Apache 2.0
ライセンス URL :http://www.apache.org/licenses/LICENSE-2.0.html
利用規約 :

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

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

1.12.1.3. タグ
リンクのコピー

  • search.open-cluster-management.io/v1: 永続ボリュームを作成して管理します。

1.12.2. パス
リンクのコピー

1.12.2.1. searchCustomization の作成
リンクのコピー

POST /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
Copy to Clipboard Toggle word wrap
1.12.2.1.1. 説明
リンクのコピー

searchCustomization を作成します。

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

ボディー

body
必須

作成するポリシーを記述するパラメーター

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.12.2.1.4. 消費
リンクのコピー
  • searchCustomization/json
1.12.2.1.5. タグ
リンクのコピー
  • search.open-cluster-management.io
1.12.2.1.6. HTTP 要求の例
リンクのコピー
1.12.2.1.6.1. 要求のボディー
リンクのコピー
{
  "apiVersion": "search.open-cluster-management.io/v1",
  "kind": "SearchCustomization",
  "metadata": {
    "name": "test-search-swagger",
    "description": "Example body for SearchCustomization API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "search.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"
              ],
            },
          ],
        },
      },
    },
  },
Copy to Clipboard Toggle word wrap

1.12.2.2. searchCustomization のクエリー
リンクのコピー

GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
Copy to Clipboard Toggle word wrap
1.12.2.2.1. 説明
リンクのコピー

searchCustomization に対してクエリーを実行して詳細を確認します。

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

ヘッダー

COOKIE
必須

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

文字列

パス

namespace
必須

ポリシーを適用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.12.2.2.4. 消費
リンクのコピー
  • searchCustomization/json
1.12.2.2.5. タグ
リンクのコピー
  • search.open-cluster-management.io

1.12.2.3. 単一ポリシーのクエリー
リンクのコピー

GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
Copy to Clipboard Toggle word wrap
1.12.2.3.1. 説明
リンクのコピー

単一の searchCustomization に対してクエリーを実行して詳細を確認します。

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

ヘッダー

COOKIE
必須

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

文字列

パス

policy_name
必須

問い合わせるポリシーの名前

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.12.2.3.4. タグ
リンクのコピー
  • search.open-cluster-management.io

1.12.2.4. searchCustomization の削除
リンクのコピー

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

ヘッダー

COOKIE
必須

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

文字列

パス

policy_name
必須

削除するポリシーの名前

文字列

パス

namespace
必須

使用する namespace (例: default)

文字列

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.12.2.4.3. タグ
リンクのコピー
  • search.open-cluster-management.io

1.12.3. 定義
リンクのコピー

1.12.3.1. SearchCustomization
リンクのコピー

Expand
Name説明スキーマ

apiVersion
必須

SearchCustomization のバージョンスキーマ

string

kind
必須

REST リソースを表す文字列の値

string

metadata
必須

ポリシーを定義するルールを記述します。

オブジェクト

spec

Expand
名前説明スキーマ

remediationAction
任意

リソースで定義されているように違反をどのように処理するかを表す値

string

namespaces
必須

ポリシーが適用される際に、include または exclude する namespace を表す値

文字列

policy-templates

Expand
Name説明スキーマ

apiVersion
必須

SearchCustomization のバージョンスキーマ

string

kind
任意

REST リソースを表す文字列の値

string

metadata
必須

ポリシーを定義するルールを記述します。

オブジェクト

complianceType

マネージドクラスターに評価または適用する必要のあるロールおよび他の Kubernetes オブジェクトの予想される動作を一覧表示するのに使用されます。

string

clusterConditions
optional

ラベルを定義するセクション

string

rules
optional

 

string

clusterConditions

Expand
Name説明スキーマ

matchLabels
任意

ポリシーを namespace に適用するのに必要なラベル

object

cloud
任意

ポリシーをクラウドプロバイダーに適用するのに必要なラベル

文字列

rules

Expand
Name説明スキーマ

apiGroups
必須

このルールが適用される API の一覧

string

resources
必須

リソースタイプの一覧

object

verbs
必須

動詞の一覧

文字列

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat