API でアプリバージョンのクエリプロセッサを取得 - OpenSearch

今すぐお試しください

この 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:ListQueryProcessor

*QueryProcessor

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

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーション名。	my_app_group_name
appId	integer	必須	アプリケーションのバージョン番号。	110157886

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
isActive	integer	任意	デフォルトのルールを返すかどうかを指定します。デフォルト値は 0 です。有効な値: 0: すべてのクエリ分析ルールを返します。 1: デフォルトのクエリ分析ルールのみを返します。 2: デフォルト以外のクエリ分析ルールのみを返します。	0

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID。	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	array<object>	クエリ分析ルールに関する情報。詳細については、「QueryProcessor」をご参照ください。
	array<object>	返された結果。
created	integer	クエリ分析ルールが作成された時間。	1587398402
active	boolean	クエリ分析ルールがデフォルトのルールであるかどうかを示します。	true
updated	integer	クエリ分析ルールが最後に変更された時間。	1587398402
name	string	クエリ分析ルールの名前。	ner
domain	string	クエリ分析ルールが適用される業界。有効な値: GENERAL: 一般 ECOMMERCE: E コマース IT_CONTENT: IT コンテンツ	GENERAL
indexes	array	クエリ分析ルールが適用されるインデックス。
	string	クエリ分析ルールが適用されるインデックス。	[ "default" ]
processors	array<object>	クエリ分析ルールで使用される特徴。
	object	クエリ分析ルールで使用される特徴。詳細については、「Processor」をご参照ください。	[]

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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