API の概要 - OpenSearch - Alibaba Cloud ドキュメントセンター

API 標準および多言語対応の SDK

本製品 (OpenSearch/2017-12-25) の API は、ROA 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。

カスタム署名

署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。

はじめに

Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。

API セキュリティを確保するには、以下を作成し、設定する必要があります。

RAM ユーザー
RAM ユーザー用の AccessKey ペア

アプリケーションインスタンス

API	タイトル	説明
アプリケーション管理	アプリケーション管理
DescribeAppGroup	DescribeAppGroup	OpenSearch アプリケーションの詳細を照会します。
RenewAppGroup	RenewAppGroup	アプリケーションを更新します。この API 操作は利用できません。アプリケーションを更新するには、OpenSearch コンソールを使用します。
CreateAppGroup	CreateAppGroup	OpenSearch アプリケーションを作成します。
ModifyAppGroup	ModifyAppGroup	OpenSearch アプリケーションのプロパティを変更するか、オンラインバージョンを設定します。
ModifyAppGroupQuota	ModifyAppGroupQuota	OpenSearch アプリケーションのクォータを変更します。
UpdateAppGroupDeleteProtection	インスタンスの削除保護を変更	アプリケーションの削除保護
RemoveAppGroup	RemoveAppGroup	OpenSearch アプリケーションを削除します。
ListAppGroups	ListAppGroups	OpenSearch アプリケーションのリストを照会します。
アプリケーションバージョン	アプリケーションバージョン
CreateApp	CreateApp	OpenSearch アプリケーションの新しいバージョンを作成します。
RemoveApp	RemoveApp	OpenSearch アプリケーションのバージョンを削除します。
DescribeApps	DescribeApps	OpenSearch アプリケーションのバージョンをクエリします。
DescribeApp	DescribeApp	OpenSearch アプリケーションの特定バージョンの情報を照会します。
DescribeAppStatistics	DescribeAppStatistics	OpenSearch アプリケーションの特定バージョンの統計情報を照会します。

インスタンス周辺機能

API	タイトル	説明
カスタムアナライザ	カスタムアナライザ
ListUserAnalyzers	ListUserAnalyzers	アカウントのカスタムアナライザのリストを取得します。
CreateUserAnalyzer	Create Custom Analyzer	カスタムアナライザを作成します。
DescribeUserAnalyzer	DescribeUserAnalyzer	カスタムアナライザの詳細を取得します。
RemoveUserAnalyzer	RemoveUserAnalyzer	カスタムアナライザを削除します。
ListUserAnalyzerEntries	ListUserAnalyzerEntries	カスタムアナライザのエントリを照会します。
PushUserAnalyzerEntries	PushUserAnalyzerEntries	カスタムアナライザのエントリに変更を適用します。
A/B テスト	A/B テスト
実験シナリオ	実験シナリオ
ListABTestScenes	ListABTestScenes	テストシナリオを照会します。
CreateABTestScene	CreateABTestScene	実験シナリオを作成します。
DescribeABTestScene	DescribeABTestScene	A/B テストシナリオの詳細を照会します。
UpdateABTestScene	UpdateABTestScene	実験シナリオを変更します。
DeleteABTestScene	DeleteABTestScene	A/B テストシナリオを削除します。
実験グループ	実験グループ
ListABTestGroups	ListABTestGroups	テストグループのリストを取得します。
CreateABTestGroup	CreateABTestGroup	実験グループを作成します。
DeleteABTestGroup	DeleteABTestGroup	A/B テストグループを削除します。
DescribeABTestGroup	DescribeABTestGroup	A/B テストグループの詳細を取得します。
UpdateABTestGroup	UpdateABTestGroup	テストグループを変更します。
実験	実験
ListABTestExperiments	ListABTestExperiments	実験のリストを照会します。
CreateABTestExperiment	CreateABTestExperiment	実験を作成します。
DescribeABTestExperiment	DescribeABTestExperiment	実験の詳細を取得します。
UpdateABTestExperiment	UpdateABTestExperiment	A/B テスト実験のパラメーターを更新します。
DeleteABTestExperiment	DeleteABTestExperiment	実験を削除します。
ホワイトリスト	ホワイトリスト
ListABTestFixedFlowDividers	ListABTestFixedFlowDividers	ホワイトリストを一覧表示します。
UpdateABTestFixedFlowDividers	UpdateABTestFixedFlowDividers	ホワイトリストデータを更新します。
基本ソート式	基本ソート式
ListFirstRanks	ListFirstRanks	OpenSearch アプリケーションのバージョンに設定されている基本ソート式を照会します。
CreateFirstRank	CreateFirstRank	OpenSearch アプリケーションのバージョン用の基本ソート式を作成します。`dryRun` を true に設定すると、この操作は指定された基本ソート式を検証します。デフォルトでは、`dryRun` の値は `false` です。
DescribeFirstRank	DescribeFirstRank	OpenSearch アプリケーションバージョンに設定されている基本ソート式を照会します。
RemoveFirstRank	RemoveFirstRank	OpenSearch アプリケーションバージョンの基本ソート設定を削除します。
ModifyFirstRank	ModifyFirstRank	OpenSearch アプリケーションバージョンの基本ソート式を変更します。dryRun パラメーターを true に設定すると、この操作は変更された基本ソート式を検証します。このパラメーターのデフォルト値は false です。
高度ソート式	高度ソート式
ListSecondRanks	ListSecondRanks	OpenSearch アプリケーションの特定のバージョンの高度ソート式をリストします。
CreateSecondRank	CreateSecondRank	OpenSearch アプリケーションのバージョンに対して高度ソート式を作成します。dryRun パラメーターを true に設定すると、この操作は指定された高度ソート式を検証します。このパラメーターのデフォルト値は false です。
DescribeSecondRank	DescribeSecondRank	OpenSearch アプリケーションのバージョンの高度ソート式を照会します。
ModifySecondRank	ModifySecondRank	OpenSearch アプリケーションバージョンの高度ソート式を変更します。`dryRun` を `true` に設定すると、変更された高度ソート式が検証されます。`dryRun` パラメーターは、デフォルトで `false` です。
RemoveSecondRank	RemoveSecondRank	OpenSearch アプリケーションのバージョンから高度ソート式を削除します。
クエリアナライザ	クエリアナライザ
ListQueryProcessors	ListQueryProcessors	OpenSearch アプリケーションの特定のバージョンに設定されているクエリ分析ルールのリストを照会します。
CreateQueryProcessor	CreateQueryProcessor	クエリ分析ルールを作成します。dryRun を true に設定すると、この操作は指定されたクエリ分析ルールを検証します。このパラメーターを指定しない場合、dryRun のデフォルト値は false です。
ModifyQueryProcessor	ModifyQueryProcessor	特定のアプリケーションバージョンのクエリ分析ルールを変更します。dryRun パラメーターを true に設定すると、この操作は指定されたクエリ分析ルールをチェックします。dryRun パラメーターを指定しない場合、デフォルト値は false です。
RemoveQueryProcessor	RemoveQueryProcessor	OpenSearch アプリケーションのバージョンからクエリ分析ルールを削除します。
DescribeQueryProcessor	DescribeQueryProcessor	OpenSearch アプリケーションのバージョンのクエリ分析ルールについて説明します。
ListQueryProcessorNers	ListQueryProcessorNers	固有表現抽出 (NER) のエンティティタイプに推奨される優先度設定を照会します。
ListQueryProcessorAnalyzerResults	ListQueryProcessorAnalyzerResults	クエリ分析の結果をテストします。この操作は、オープンソース互換エディションの既存のアプリケーションに対してのみ呼び出すことができます。
介入辞書	介入辞書
ListInterventionDictionaries	ListInterventionDictionaries	介入辞書のリストを取得します。
CreateInterventionDictionary	CreateInterventionDictionary	介入ディクショナリを作成します。
DescribeInterventionDictionary	DescribeInterventionDictionary	介入ディクショナリの詳細を取得します。
RemoveInterventionDictionary	RemoveInterventionDictionary	介入ディクショナリを削除します。
ListInterventionDictionaryEntries	ListInterventionDictionaryEntries	介入辞書内の介入エントリを照会します。
PushInterventionDictionaryEntries	PushInterventionDictionaryEntries	介入辞書のエントリに変更を適用します。
ListInterventionDictionaryRelatedEntities	ListInterventionDictionaryRelatedEntities	介入辞書に関連付けられているリソースのリストをクエリします。クエリプロセッサ (QP) が辞書を参照している場合、この操作は関連付けられているすべてのアプリケーションと QP に関する情報を返します。
ListInterventionDictionaryNerResults	ListInterventionDictionaryNerResults	固有表現抽出 (NER) の結果を取得します。
最適化 Master	最適化 Master
EnableSlowQuery	EnableSlowQuery	オプティマイザーのスロークエリサービスを有効にします。
DisableSlowQuery	DisableSlowQuery	検索診断機能のスロークエリサービスを無効にします。
DescribeSlowQueryStatus	DescribeSlowQueryStatus	スロークエリ機能のステータスを照会します。
StartSlowQueryAnalyzer	StartSlowQueryAnalyzer	低速クエリ分析タスクを開始します。
ListSlowQueryQueries	ListSlowQueryQueries	クエリオプティマイザーから低速クエリをリストします。
ListSlowQueryCategories	ListSlowQueryCategories	検索診断から低速クエリの最適化案を一覧表示します。
クォータ承認	クォータ承認
ListQuotaReviewTasks	ListQuotaReviewTasks	指定された OpenSearch アプリケーションのクォータ承認チケットを一覧表示します。
スケジュールタスク	スケジュールタスク
ListScheduledTasks	ListScheduledTasks	OpenSearch アプリケーションの定期タスクのリストを照会します。
CreateScheduledTask	CreateScheduledTask	OpenSearch アプリケーションのスケジュールされたタスクを作成します。
DescribeScheduledTask	DescribeScheduledTask	OpenSearch アプリケーションのスケジュールされたタスクの詳細を照会します。
ModifyScheduledTask	ModifyScheduledTask	スケジュールされたタスクを変更します。
RemoveScheduledTask	RemoveScheduledTask	OpenSearch アプリケーションからスケジュールされたタスクを削除します。
検索ポリシー	検索ポリシー
ListSortExpressions	ListSortExpressions	OpenSearch アプリケーションのバージョンに設定されているソート式を一覧表示します。
Elasticsearch エンジンインスタンス	Elasticsearch エンジンインスタンス
UnbindEsInstance	UnbindEsInstance	OpenSearch アプリケーションから Elasticsearch インスタンスのバインドを解除します。
BindEsInstance	BindEsInstance	Elasticsearch インスタンスを依存関係としてバインドします。
BindESUserAnalyzer	BindESUserAnalyzer	カスタムアナライザを Elasticsearch インスタンスにバインドします。
UnbindESUserAnalyzer	UnbindESUserAnalyzer	Elasticsearch インスタンスからカスタムアナライザをデタッチします。
現在の処理フロー	現在の処理フロー
ListProceedings	ListProceedings	現在の議事録を一覧表示します。
統計	統計
ListStatisticLogs	ListStatisticLogs	アプリケーションエラーログ、ホットワードランキング、スロークエリログなどのログ統計をクエリします。
ListStatisticReport	ListStatisticReport	アプリケーション、検索候補、トップ検索ヒントワード、A/B テスト、データ品質レポートなどの統計レポートをクエリします。
Cava スクリプト	Cava スクリプト
ListSortScripts	ListSortScripts	指定されたアプリケーションバージョンのすべてのソートスクリプトをリストします。
UpdateSortScript	UpdateSortScript	ソートスクリプトの説明を変更します。
SaveSortScriptFile	SaveSortScriptFile	ソートスクリプトをアップロードします。
ReleaseSortScript	ReleaseSortScript	ソートスクリプトをリリースします。
GetSortScriptFile	GetSortScriptFile	ソートスクリプトの内容を取得します。
GetSortScript	GetSortScript	ソートスクリプトの詳細を取得します。
GetScriptFileNames	GetScriptFileNames	特定のアプリケーションバージョンについて、指定されたスクリプト内のすべてのファイルの名前を取得します。
DeleteSortScriptFile	DeleteSortScriptFile	スクリプトファイルを削除します。
DeleteSortScript	DeleteSortScript	ソートスクリプトを削除します。
CreateSortScript	CreateSortScript	ソートスクリプトを作成します。
CompileSortScript	CompileSortScript	ソートスクリプトをコンパイルします。
クエリポリシー	クエリポリシー
UpdateSearchStrategy	UpdateSearchStrategy	この操作はドライランをサポートしています。
RemoveSearchStrategy	RemoveSearchStrategy	検索戦略を削除します。
ListSearchStrategies	ListSearchStrategies	クエリポリシーの詳細を取得します。
GetSearchStrategy	GetSearchStrategy	クエリポリシーの詳細を取得します。
CreateSearchStrategy	CreateSearchStrategy	検索戦略を作成します。

バージョン周辺機能

API	タイトル	説明
デフォルト表示フィールド	デフォルト表示フィールド
UpdateFetchFields	UpdateFetchFields	この操作はドライランをサポートしています。
検索結果サマリー	検索結果サマリー
UpdateSummaries	UpdateSummaries	この操作はドライランをサポートしています。

アルゴリズム周辺機能

API	タイトル	説明
CreateFunctionResource	CreateFunctionResource	指定された特徴のアルゴリズムリソースを作成します。
GetFunctionCurrentVersion	GetFunctionCurrentVersion	インスタンスの作成に使用される特徴のバージョン情報を取得します。
GetFunctionVersion	GetFunctionVersion	関数バージョンの情報を照会します。
GetFunctionDefaultInstance	GetFunctionDefaultInstance	アプリケーションのデフォルトのアルゴリズムインスタンスを照会します。
UpdateFunctionDefaultInstance	UpdateFunctionDefaultInstance	指定されたアプリケーションのデフォルトのアルゴリズムインスタンスを設定します。新しいアルゴリズムインスタンスは、以前に設定されたデフォルトのインスタンスを自動的に上書きします。インスタンスが指定されていない場合、デフォルトのインスタンスはキャンセルされます。
ListFunctionTasks	ListFunctionTasks	トレーニングタスクを照会します。結果は開始時刻の降順でソートされます。
GetFunctionTask	GetFunctionTask	Queries the details of a training task.
DeleteFunctionTask	DeleteFunctionTask	トレーニングレコードを削除します。進行中のトレーニングレコードは削除できません。
CreateFunctionTask	CreateFunctionTask	この操作はトレーニングタスクを開始します。
ListFunctionInstances	ListFunctionInstances	指定された条件に一致するすべてのインスタンスをリストします。
GetFunctionInstance	GetFunctionInstance	インスタンス名でアルゴリズムインスタンスの詳細を照会します。
DeleteFunctionInstance	DeleteFunctionInstance	アルゴリズムインスタンスを削除します。インスタンスを削除する前に、サービスの中断を防ぐために、インスタンスが使用中でないことを確認してください。
UpdateFunctionInstance	UpdateFunctionInstance	関数インスタンスの構成を更新します。
GetFunctionResource	GetFunctionResource	指定されたアルゴリズムリソースを取得します。
ListFunctionResources	ListFunctionResources	アルゴリズムリソースを一覧表示します。
DeleteFunctionResource	DeleteFunctionResource	指定されたアルゴリズムリソースを削除します。
UpdateFunctionResource	UpdateFunctionResource	アルゴリズムリソースを更新します。
CreateFunctionInstance	CreateFunctionInstance	機能のアルゴリズムインスタンスを作成します。

その他（ディレクトリに含まれないドキュメント）

API	タイトル	説明
ValidateDataSources	ValidateDataSources	データソースを検証します。
ReplaceAppGroupCommodityCode	ReplaceAppGroupCommodityCode	サービスベースのアプリケーションをインスタンスベースのアプリケーションに変換します。
ListDataSourceTables	ListDataSourceTables	指定されたデータソースからすべてのデータを取得します。
ListDataSourceTableFields	ListDataSourceTableFields	この内部 API は、指定されたデータテーブルからすべてのフィールドを取得します。
GetDomain	GetDomain	業界タイプを取得します。
GenerateMergedTable	GenerateMergedTable	複数のテーブルに対して JOIN 操作を実行した後に生成されるワイドテーブルの情報を照会します。
DescribeRegions	DescribeRegions	すべてのリージョンのエンドポイントを取得します。

その他

API	タイトル	説明
DescribeDataCollction	DescribeDataCollction	指定されたアプリケーションのデータ収集の詳細を取得します。
ListDataCollections	ListDataCollections	OpenSearch アプリケーションのデータ収集を一覧表示します。
RemoveDataCollection	RemoveDataCollection	データ収集を無効にします。
UntagResources	UntagResources	リソースからタグを削除します。
ListTagResources	ListTagResources	指定されたリソースのタグをクエリします。
TagResources	TagResources	リソースにタグを追加します。
CreateAppGroupCredentials	CreateAppGroupCredentials	指定されたアプリケーショングループのアクセス資格情報を作成します。この操作は、結果をプレビューするためのドライランをサポートしています。