创建一个查询分析规则。当 dryRun=true 时,表示进行查询分析规则校验,默认 dryRun 不传为 false。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
opensearch:WriteQueryProcessor |
create |
*QueryProcessor
|
无 | 无 |
请求语法
POST /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| appGroupIdentity |
string |
是 |
应用名称 |
my_app_group_name |
| appId |
integer |
是 |
版本号 |
110157886 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| dryRun |
boolean |
否 |
是否为空运行请求 |
true |
| body |
string |
否 |
请求体 |
{} |
请求体
| 字段 | 类型 | 是否必要 | 示例值 | 描述 |
| name | String | 是 | "test" | 规则名称 |
| processors[] | Object | 是 | -- | 分析规则 参考: Processor |
| domain | String | 否 | "GENERAL" | 行业类型 - GENERAL 通用行业 - ECOMMERCE 电商 - IT_CONTENT IT 行业 |
| indexes | Array | 否 | ["default"] | 应用的索引范围 |
| active | Boolean | 否 | true | 是否设置为有效 |
参考: QueryProcessor
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| requestId |
string |
请求 ID |
0A6EB64B-B4C8-CF02-810F-E660812972FF |
| result |
object |
规则信息 |
|
| created |
integer |
创建时间 |
1587398402 |
| active |
boolean |
是否默认规则 |
true |
| updated |
integer |
更新时间 |
1587398402 |
| name |
string |
规则名称 |
query_filter |
| domain |
string |
行业类型
|
GENERAL |
| indexes |
array |
应用的索引范围 |
|
|
string |
应用的索引范围 |
"default" |
|
| processors |
array<object> |
包含功能 具体说明查看下文: Processor |
|
|
object |
包含功能 |
{} |
|
| category |
string |
示例
正常返回示例
JSON格式
{
"requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
"result": {
"created": 1587398402,
"active": true,
"updated": 1587398402,
"name": "query_filter",
"domain": "GENERAL",
"indexes": [
"\"default\""
],
"processors": [
{}
],
"category": ""
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。