OpenSearch アプリバージョン管理のための DescribeApps API 概要 - OpenSearch

OpenSearch アプリケーションのバージョンをクエリします。

操作説明

同じ名前の Standard Edition アプリケーションが存在する場合、新しいバージョンが作成されます。
新しいバージョンを作成する場合、autoSwitch および realtimeShared パラメーターは必須です。
新しいバージョンを作成する場合、クォータは以前のバージョンから継承されます。
新しいバージョンを作成する場合、クォータへの変更は有効になりません。

今すぐお試しください

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

list

*App

acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーショングループの名前または ID。	my_app_group_name

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID。	77CAA411-0010-4DB9-82E2-1C384E590AFF
result	array<object>	レスポンスパラメーター。
	array<object>	バージョン情報。詳細については、「アプリケーション」をご参照ください。	{}
id	string	アプリケーションの ID。	100302881
isCurrent	boolean	バージョンがオンラインバージョンであるかどうかを示します。	12333
clusterName	string	クラスターの名前。	vpc_sh_domain_1
autoSwitch	boolean	自動スイッチオーバーが有効になっているかどうかを示します。	true
type	string	アプリケーションのタイプ。有効な値: standard: Standard Edition アプリケーション。 advance: 旧バージョンの Advanced Edition アプリケーション。このエディションは、新しいアプリケーションではサポートされていません。 enhanced: Advanced Edition の新しいバージョン。	enhanced
description	string	説明。	""
status	string	バージョンのステータス。有効な値: ok: バージョンは正常です。 stopped: バージョンは一時停止しています。 frozen: バージョンは凍結されています。 initializing: バージョンは初期化中です。 unavailable: バージョンは無効です。 data_waiting: データは初期化を待機しています。 data_preparing: データは初期化中です。	normal
schema	object	アプリケーションスキーマ。
tables	object	テーブルスキーマ。
indexes	object	インデックススキーマ。
filterFields	array	属性フィールド。
	string	属性フィールド。	id
searchFields	object	インデックスフィールド。
routeField	string	レベル 1 のルートフィールド。	field1
routeFieldValues	array	レベル 1 のルートフィールドのホットデータ値。
	string	レベル 1 のルートフィールドのホットデータ値。	routeFieldValues
secondRouteField	string	レベル 2 のルートフィールド。このパラメーターは、routeFieldValues パラメーターが設定されている場合にのみ有効になります。デフォルトでは、ワイドテーブルのプライマリキーがレベル 2 のルートフィールドとして使用されます。	field2
ttlField	object	ドキュメントの生存時間 (TTL) 設定。
name	string	ドキュメントの TTL フィールド。	text1
ttl	integer	生存時間 (TTL)。単位: ミリ秒。	1000
indexSortConfig	array<object>	インデックスのソート設定。
	object	インデックスのソート設定。
field	string	ソートフィールド。	field1
direction	string	ソート順。有効な値: ASC DESC	DESC
name	string	ワイドテーブルの名前。	test
progressPercent	integer	データインポートの進捗状況をパーセンテージで示します。たとえば、値 83 は 83% を示します。	100
fetchFields	array	デフォルト表示フィールド。
	string	デフォルト表示フィールド。	{}
quota	object	クォータ情報。
spec	string	仕様。有効な値: opensearch.share.junior: ベーシック opensearch.share.common: 共有汎用 opensearch.share.compute: 共有コンピューティング最適化 opensearch.share.storage: 共有ストレージ最適化 opensearch.private.common: 専用汎用 opensearch.private.compute: 専用コンピューティング最適化 opensearch.private.storage: 専用ストレージ最適化	opensearch.share.common
qps	integer	1 秒あたりのクエリ数 (QPS)。このパラメーターは、以前の課金モデルで使用されます。	5
docSize	integer	ストレージ容量。単位: GB。	1
computeResource	integer	計算リソース。単位: 論理計算ユニット (LCU)。	20
domain	object	業界。有効な値: GENERAL ECOMMERCE IT_CONTENT
category	string	アプリケーションのエディション。有効な値: standard (Standard Edition)、advance (新しいアプリケーションでは利用できないレガシーの Premium Edition)、enhanced (新しい Premium Edition)。	-
name	string	英語名。	test
functions	object	検索機能。
service	array	サービス機能。
	string	サービス機能。	-
qp	array	クエリ処理機能。
	string	クエリプロセッサに関する情報。	spellcheck
algo	array	構造 1
	string	構造 1	pop
schemas	array<object>	非パーティションテーブルのスキーマ。
	array<object>	非パーティションテーブルのスキーマ。
tables	object	テーブルスキーマ。
indexes	object	インデックススキーマ。
filterFields	array	属性フィールド。
	string	属性フィールド。	field1
searchFields	object	インデックスフィールド。
routeField	string	レベル 1 のルートフィールド。	field1
routeFieldValues	array	レベル 1 のルートフィールドのホットデータ値。
	string	レベル 1 のルートフィールドのホットデータ値。	routeFieldValues
secondRouteField	string	レベル 2 のルートフィールド。このパラメーターは、routeFieldValues パラメーターが設定されている場合にのみ有効になります。デフォルトでは、ワイドテーブルのプライマリキーがレベル 2 のルートフィールドとして使用されます。	field2
ttlField	object	ドキュメントの TTL 設定。
name	string	ドキュメントの TTL フィールド。	fIeld1
ttl	integer	生存時間 (TTL)。単位: ミリ秒。	1000
indexSortConfig	array<object>	インデックスのソート設定。
	object	インデックスのソート設定。
field	string	ソートフィールド。	fIeld1
direction	string	ソート順。有効な値: ASC DESC	DESC
name	string	ワイドテーブルの名前。	main
firstRanks	array<object>	粗粒度ソート設定。
	object	粗粒度ソート設定。
type	string	式のタイプ。有効な値: STRUCT: 構造化された式。STRING (デフォルト): カスタム数式。 STRUCT: 式の内容は構造です。 STRING (デフォルト): カスタム数式を設定できます。	STRING
name	string	粗粒度ソート式の名前。	test
description	string	説明。	描述
active	boolean	これがデフォルトの式であるかどうかを示します。	False
meta	any	式。配列または文字列を指定できます。	String :"random()*100+now()"； Array: [ { "attribute": "static_bm25()", "arg": "", "weight": 10 } ]
secondRanks	array<object>	詳細ソート設定。
	object	詳細ソート設定。
meta	any	詳細ソート式。フィールド、特徴関数、および数学関数で構成される式を定義して、複雑なソートロジックを実装できます。	"cate_id > 0 and cate_id < 1000"
name	string	詳細ソート式の名前。	default
description	string	説明。	描述
active	boolean	これがデフォルトの式であるかどうかを示します。	False
dataSources	array<object>	データソース設定。
	array<object>	データソース設定。
tableName	string	アプリケーション内のテーブルの名前。	main
type	string	データソースのタイプ。有効な値: rds odps opensearch polardb	rds
fields	array<object>	フィールドマッピング。
	object	フィールドマッピング。
plugins	object	フィールドのデータ処理プラグイン。プラグイン名 (name) JsonKeyValueExtractor MultiValueSpliter KeyValueExtractor StringCatenateExtractor HTMLTagRemover プラグインパラメーター (parameters): JsonKeyValueExtractor MultiValueSpliter KeyValueExtractor StringCatenateExtractor HTMLTagRemover
keyField	string	プライマリキー。	id
schemaName	string	ワイドテーブルの名前。	name
parameters	object	データソースパラメーター。
summaries	array<object>	検索結果のサマリー設定。
	array<object>	検索結果のサマリー設定。
name	string	サマリーグループの名前。	fefault
meta	array<object>	サマリー設定。
	object	サマリー設定。
field	string	フィールド。	field1
len	integer	セグメントの長さ。有効な値: 1～300。	50
element	string	ハイライト表示用の HTML タグ。	em
ellipsis	string	セグメントを接続するために使用されるコネクタ。	...
snippet	string	セグメントの数。有効な値: 1～5。	5
queryProcessors	array<object>	クエリ分析設定。
	array<object>	クエリ分析設定。
name	string	クエリ分析ルールの名前。	test
domain	string	業界。有効な値: GENERAL ECOMMERCE IT_CONTENT	GENERAL
category	string	業界カテゴリ。	""
processors	array<object>	特徴。
	object	特徴。
indexes	array	インデックス。
	string	インデックス。	default
active	boolean	これがデフォルトのルールであるかどうかを示します。	False
cluster	object	クラスター設定。
maxTimeoutMS	integer	クラスターのタイムアウト期間。単位: ms。	750
maxQueryClauseLength	integer	クエリ句の最大長。	1024
interpretations	object	フィールドの大規模言語モデル (LLM) 設定。
prompts	array<object>	プロンプト設定。
	object	プロンプト設定。

例

成功レスポンス

JSONJSON

{
  "requestId": "77CAA411-0010-4DB9-82E2-1C384E590AFF",
  "result": [
    {
      "id": "100302881",
      "isCurrent": true,
      "clusterName": "vpc_sh_domain_1",
      "autoSwitch": true,
      "type": "enhanced",
      "description": "\"\"",
      "status": "normal",
      "schema": {
        "tables": {
          "test": "test",
          "test2": 1
        },
        "indexes": {
          "filterFields": [
            "id"
          ],
          "searchFields": {
            "test": "test",
            "test2": 1
          }
        },
        "routeField": "field1",
        "routeFieldValues": [
          "routeFieldValues"
        ],
        "secondRouteField": "field2\n",
        "ttlField": {
          "name": "text1\n",
          "ttl": 1000
        },
        "indexSortConfig": [
          {
            "field": "field1",
            "direction": "DESC"
          }
        ],
        "name": "test"
      },
      "progressPercent": 100,
      "fetchFields": [
        "{}"
      ],
      "quota": {
        "spec": "opensearch.share.common",
        "qps": 5,
        "docSize": 1,
        "computeResource": 20
      },
      "domain": {
        "category": "-",
        "name": "test",
        "functions": {
          "service": [
            "-"
          ],
          "qp": [
            "spellcheck"
          ],
          "algo": [
            "pop"
          ]
        }
      },
      "schemas": [
        {
          "tables": {
            "test": "test",
            "test2": 1
          },
          "indexes": {
            "filterFields": [
              "field1"
            ],
            "searchFields": {
              "test": "test",
              "test2": 1
            }
          },
          "routeField": "field1\n",
          "routeFieldValues": [
            "routeFieldValues"
          ],
          "secondRouteField": "field2",
          "ttlField": {
            "name": "fIeld1",
            "ttl": 1000
          },
          "indexSortConfig": [
            {
              "field": "fIeld1",
              "direction": "DESC"
            }
          ],
          "name": "main"
        }
      ],
      "firstRanks": [
        {
          "type": "STRING",
          "name": "test",
          "description": "描述",
          "active": true,
          "meta": "String :\"random()*100+now()\"；\nArray: [\n    {\n      \"attribute\": \"static_bm25()\",\n      \"arg\": \"\",\n      \"weight\": 10\n    }\n  ]"
        }
      ],
      "secondRanks": [
        {
          "meta": "\"cate_id > 0 and cate_id < 1000\"\n",
          "name": "default\n",
          "description": "描述",
          "active": true
        }
      ],
      "dataSources": [
        {
          "tableName": "main",
          "type": "rds",
          "fields": [
            {
              "test": "test",
              "test2": 1
            }
          ],
          "plugins": {
            "test": "test",
            "test2": 1
          },
          "keyField": "id",
          "schemaName": "name",
          "parameters": {
            "test": "test",
            "test2": 1
          }
        }
      ],
      "summaries": [
        {
          "name": "fefault",
          "meta": [
            {
              "field": "field1",
              "len": 50,
              "element": "em",
              "ellipsis": "...",
              "snippet": "5"
            }
          ]
        }
      ],
      "queryProcessors": [
        {
          "name": "test",
          "domain": "GENERAL",
          "category": "\"\"",
          "processors": [
            {
              "test": "test",
              "test2": 1
            }
          ],
          "indexes": [
            "default"
          ],
          "active": true
        }
      ],
      "cluster": {
        "maxTimeoutMS": 750,
        "maxQueryClauseLength": 1024
      },
      "interpretations": {
        "test": "test",
        "test2": 1
      },
      "prompts": [
        {
          "test": "test",
          "test2": 1
        }
      ]
    }
  ]
}

エラーコード

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

変更履歴

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