すべてのプロダクト
Search

このプロダクト

    OpenSearch:ModifyQueryProcessor

    ドキュメントセンター

    OpenSearch:ModifyQueryProcessor

    最終更新日:Nov 24, 2025

    特定のアプリケーションバージョンのクエリ分析ルールを変更します。dryRun パラメーターを true に設定すると、この操作は指定されたクエリ分析ルールをチェックします。dryRun パラメーターを指定しない場合、デフォルト値は false です。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    opensearch:WriteQueryProcessor

    *QueryProcessor

    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

    		 なし なし

    リクエスト構文

    PUT /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    appGroupIdentity

    string

    必須

    アプリケーションの名前。

    “my_app_group_name”
    appId

    integer

    必須

    アプリケーションのバージョン番号。

    110157886
    name

    string

    必須

    ルールの名前。

    “test”

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    dryRun

    boolean

    任意

    ドライランを実行するかどうかを指定します。

    true
    body

    any

    任意

    リクエストボディ。

    { "domain": "GENERAL", "category": "", "processors": [ { "name": "synonym", "useSystemDictionary": true }, { "name": "stop_word", "useSystemDictionary": true } ] }

    リクエストボディ

    パラメータータイプ必須例説明
    domain文字列いいえ"GENERAL"クエリ分析ルールが適用される業界。有効な値:
    - GENERAL: 一般
    - ECOMMERCE: E コマース
    - IT_CONTENT: IT コンテンツ









    indexes配列いいえ["default"]クエリ分析ルールが適用されるインデックス。
    processors[]オブジェクトいいえ分析ルール。
    詳細については、「Processor

    activeブール値いいえtrueルールをアクティブに設定するかどうかを指定します。

    詳細については、「QueryProcessor」をご参照ください。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答本文。

    {}
    requestId

    string

    リクエスト ID。

    D77D0DAF-790D-F5F5-A9C0-133738165014
    result

    object

    ルールに関する情報。

    {}
    created

    integer

    ルールが作成された時間。

    0
    active

    boolean

    ルールがデフォルトルールであるかどうかを示します。

    true
    updated

    integer

    ルールが更新された時間。

    1
    name

    string

    ルールの名前。

    synonym
    domain

    string

    クエリ分析ルールが適用される業界。有効な値:

    • GENERAL: 一般

    • ECOMMERCE: E コマース

    • IT_CONTENT: IT コンテンツ

    GENERAL
    indexes

    array

    クエリ分析ルールが適用されるインデックス。

    ["default"]

    string

    クエリ分析ルールが適用されるインデックス。

    [ "default" ]
    processors

    array<object>

    分析ルール。

    []

    object

    応答で返されるデータ。

    [ "default" ]

    応答パラメーター

    パラメータータイプ説明
    requestId文字列リクエスト ID。
    resultオブジェクトルールに関する情報。
    詳細については、「QueryProcessor

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 0,
    "active": true,
    "updated": 1,
    "name": "synonym",
    "domain": "GENERAL",
    "indexes": [
      "[ \"default\" ]"
    ],
    "processors": [
      [
        "default"
      ]
    ]
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。