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

1.13. Search query API

検索クエリー API は Kubernetes API ではないため、Red Hat OpenShift Container Platform API Explorer では表示されません。検索クエリー API の機能を理解するには、このドキュメントの続きもご確認ください。

非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。

1.13.1. 概要
リンクのコピー

検索クエリー API をルートで公開し、API を使用して検索クエリーを解決できます。API は GraphQL エンドポイントです。curl や Postman などの任意のクライアントを使用できます。

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

バージョン: 2.14.0

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

BasePath : /searchapi/graphql
スキーム : HTTPS

1.13.1.3. API アクセスの設定
リンクのコピー

以下のコマンドを使用して、クラスターの外部から Search API にアクセスするためのルートを作成します。 

oc create route passthrough search-api --service=search-search-api -n open-cluster-management
Copy to Clipboard Toggle word wrap

重要: 環境を保護するには、ルートを設定する必要があります。詳細は、OpenShift Container Platform ドキュメントの ルート設定 を参照してください。

1.13.2. スキーマ設計
リンクのコピー

input SearchFilter {
  property: String!
  values: [String]!
}
input SearchInput {
  keywords: [String]
  filters: [SearchFilter]
  limit: Int
  relatedKinds: [String]
}
type SearchResult {
count: Int
items: [Map]
related: [SearchRelatedResult]
}
type SearchRelatedResult {
kind: String!
count: Int
items: [Map]
}
Copy to Clipboard Toggle word wrap

! を使用したパラメーターは、フィールドが必要であることを示します。

1.13.2.1. クエリー入力の説明表
リンクのコピー

Expand
型説明プロパティー

SearchFilter

結果をフィルタリングするキーと値を定義します。プロパティーに多くの値を指定すると、API は値を "OR" 操作として解釈します。多くのフィルターを指定すると、結果はすべてのフィルターに一致し、API は "AND" 操作として解釈します。

string

SearchInput

リソースの一覧を表示するには、主要な用語を入力します。多くのキーワードを指定すると、API はそれを "AND" 操作として解釈します。

String

limit

クエリーを入力した後に返される結果の最大数を決定します。デフォルト値は 10,000 です。-1 の値は、制限が削除されることを意味します。

Integer

1.13.2.2. スキーマの例
リンクのコピー

{
  "query": "type SearchResult {count: Intitems: [Map]related: [SearchRelatedResult]} type SearchRelatedResult {kind: String!count: Intitems: [Map]}",
  "variables": {
    "input": [
      {
        "keywords": [],
        "filters": [
          {
            "property": "kind",
            "values": [
              "Deployment"
            ]
          }
        ],
        "limit": 10
      }
    ]
  }
}
Copy to Clipboard Toggle word wrap

1.13.3. 汎用スキーマ
リンクのコピー

type Query {
  search(input: [SearchInput]): [SearchResult]
  searchComplete(property: String!, query: SearchInput, limit: Int): [String]
  searchSchema: Map
  messages: [Message]
}
Copy to Clipboard Toggle word wrap

1.13.4. サポートされているクエリー
リンクのコピー

JSON 形式でサポートされているクエリータイプを確認するには、このまま読み進めてください。

1.13.4.1. デプロイメントの検索
リンクのコピー

クエリー: 

query mySearch($input: [SearchInput]) {
    search(input: $input) {
    		items
        }
}
Copy to Clipboard Toggle word wrap

変数: 

{"input":[
    {
        "keywords":[],
        "filters":[
            {"property":"kind","values":["Deployment"]}],
        "limit":10
    }
]}
Copy to Clipboard Toggle word wrap

1.13.4.2. Pod の検索
リンクのコピー

クエリー: 

query mySearch($input: [SearchInput]) {
    search(input: $input) {
    		items
        }
}
Copy to Clipboard Toggle word wrap

変数: 

{"input":[
    {
        "keywords":[],
        "filters":[
            {"property":"kind","values":["Pod"]}],
        "limit":10
    }
]}
Copy to Clipboard Toggle word wrap
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat