文档

ListQueryProcessors - 取某版本的查询分析规则列表

更新时间:

获取指定OpenSearch应用版本的查询分析规则列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
opensearch:ListQueryProcessor
  • QueryProcessor
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

请求语法

GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors

请求参数

名称类型必填描述示例值
appGroupIdentitystring

应用名称

my_app_group_name
appIdinteger

版本号

110157886
isActiveinteger

是否已设置为默认规则,默认值为 0

  • 0 表示查询所有
  • 1 表示查询已设置为默认的规则
  • 2 表示查询未设置为默认的规则
0

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID

0A6EB64B-B4C8-CF02-810F-E660812972FF
resultobject []

规则信息

参考: QueryProcessor

createdinteger

创建时间

1587398402
activeboolean

是否默认规则

true
updatedinteger

更新时间

1587398402
namestring

规则名称

ner
domainstring

行业类型

  • GENERAL 通用
  • ECOMMERCE 电商
  • IT_CONTENT IT 内容
GENERAL
indexesarray

应用的索引范围

string

应用的索引范围

[ "default" ]
processorsobject []

包含功能

object

包含功能

具体说明查看下文: Processor

[]

示例

正常返回示例

JSON格式

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "created": 1587398402,
      "active": true,
      "updated": 1587398402,
      "name": "ner",
      "domain": "GENERAL",
      "indexes": [
        "[                 \"default\"             ]"
      ],
      "processors": [
        []
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史