红帽全球峰会1.12. 搜索查询 API
搜索查询 API 不是 Kubernetes API，因此无法通过 Red Hat OpenShift Container Platform API Explorer 显示。继续阅读以了解搜索查询 API 功能。
1.12.1. 概述
您可以使用路由公开搜索查询 API，并使用 API 解析搜索查询。API 是一个 GraphQL 端点。您可以使用任何客户端，如 curl 或 Postman。
1.12.1.1. 版本信息
版本 : 2.10.0
1.12.1.2. URI scheme
basePath : /searchapi/graphql
Schemes : HTTPS
1.12.1.3. 配置 API 访问
使用以下命令，创建路由以访问集群外部的搜索 API：
oc create route passthrough search-api --service=search-search-api -n open-cluster-management重要： 您必须配置路由来保护您的环境。如需了解更多详细信息，请参阅 OpenShift Container Platform 文档中的 Route 配置。
1.12.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]
}
带有 ! 的参数表示需要字段。
1.12.2.1. 查询输入的描述表
| 类型 | 描述 | 属性 |
|---|---|---|
| SearchFilter | 定义用于过滤结果的键和值。当您为属性提供多个值时，API 会将值解释为"OR"操作。当您提供多个过滤器时，结果会匹配所有过滤器，API 会解释为"AND"操作。 | string |
| SearchInput | 输入关键字以接收资源列表。当您提供许多关键字时，API 会将它解析为"AND"操作。 | 字符串 |
| limit |
确定输入查询后返回的最大结果数。默认值为 | 整数 |
1.12.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
}
]
}
}1.12.3. 通用模式
type Query {
search(input: [SearchInput]): [SearchResult]
searchComplete(property: String!, query: SearchInput, limit: Int): [String]
searchSchema: Map
messages: [Message]
}1.12.4. 支持的查询
继续读取以查看 JSON 格式支持的查询类型。
1.12.4.1. 搜索部署
query：
query mySearch($input: [SearchInput]) {
search(input: $input) {
items
}
}变量：
{"input":[
{
"keywords":[],
"filters":[
{"property":"kind","values":["Deployment"]}],
"limit":10
}
]}1.12.4.2. 搜索 pod
query：
query mySearch($input: [SearchInput]) {
search(input: $input) {
items
}
}变量：
{"input":[
{
"keywords":[],
"filters":[
{"property":"kind","values":["Pod"]}],
"limit":10
}
]}
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}