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

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

本製品 (searchengine/2021-10-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	タイトル	説明
CreatePublicUrl	パブリックドメイン名を有効にします	パブリックドメイン名を有効にします。
DeletePublicUrl	パブリックドメイン名を削除します	パブリックドメイン名を削除します。
ModifyPublicUrlIpList	パブリックドメイン名のホワイトリストを変更します。	パブリックドメイン名のホワイトリストを変更します。
ModifyPassword	インスタンスのパスワードを変更します	インスタンスのパスワードを変更します。
ListInstanceSpecs	ListInstanceSpecs	インスタンスの仕様を照会します。

構成センター

API	タイトル	説明
オンラインテーブル構成	オンラインテーブル構成
GetIndexOnlineStrategy	GetIndexOnlineStrategy	インデックスのオンラインで有効なポリシーを照会します。
ModifyIndexOnlineStrategy	ModifyIndexOnlineStrategy	インデックスのオンラインポリシーを変更します。
ModifyOnlineConfig	ModifyOnlineConfig	オンライン構成を変更します。
ListOnlineConfigs	ListOnlineConfigs	オンライン構成の詳細を照会します。
インデックス構造	インデックス構造
ModifyIndex	インデックスを変更します	インデックスを変更します。
StartIndex	StartIndex	インデックスを再開します。
StopIndex	StopIndex	インデックスを停止します。
BuildIndex	BuildIndex	インデックスを再構築します。
ModifyIndexVersion	ModifyIndexVersion	クラスターのインデックスバージョンを変更 (インデックスバージョンのロールバック) します。
ModifyFile	ModifyFile	ファイルを変更します。
PublishIndexVersion	PublishIndexVersion	指定されたインデックスバージョンを公開します。
ModifyIndexPartition	ModifyIndexPartition	インデックスパーティションに関する情報を変更します。
GetIndexVersion	GetIndexVersion	現在のインデックスバージョンからロールバック可能なインデックスバージョンの情報を照会します。
ListIndexes	ListIndexes	インデックスのリストを取得します。
RecoverIndex	インデックスからデータを回復します。	インデックスからデータを回復します。
詳細設定	詳細設定
CreateConfigDir	詳細設定にファイルディレクトリを作成します	詳細設定にファイルディレクトリを作成します。
DeleteConfigDir	詳細設定フォルダを削除します	詳細設定フォルダを削除します。
ModifyAdvanceConfig	ModifyAdvanceConfig	HTTP または Git ファイルのコンテンツを変更します。
DeleteAdvanceConfig	DeleteAdvanceConfig	詳細設定に関する詳細を削除します。
ModifyAdvanceConfigFile	辞書を変更します。	辞書を変更します。
PublishAdvanceConfig	詳細バージョンを公開します	詳細バージョンを公開します。
GetAdvanceConfig	GetAdvanceConfig	詳細設定の情報を照会します。
GetAdvanceConfigFile	GetAdvanceConfigFile	詳細設定ファイルに関する情報を照会します。
ListAdvanceConfigDir	詳細設定ディレクトリ内のファイルリストを取得します	詳細設定ディレクトリ内のファイルリストを取得します。
ListAdvanceConfigs	ListAdvanceConfigs	詳細設定のリストを取得します。
データソース構成	データソース構成
ModifyDataSourceDeploy	データソースのデプロイ情報の変更	データソースのデプロイ情報を変更します。
ListDataSourceSchemas	ListDataSourceSchemas	データソースのスキーマ情報を照会します。
ListDateSourceGenerations	データソースの既存データのデータ逆流情報を取得します。	データソースの既存データのデータ逆流情報を取得します。
GetDataSourceDeploy	GetDataSourceDeploy	データソースのデプロイメント情報を取得します。

O&M センター

API	タイトル	説明
SQL 開発	SQL 開発
CloneSqlInstance	SQL インスタンスをクローンします	SQL インスタンスをクローンします。
DeleteSqlInstance	DeleteSqlInstance	SQL インスタンスを削除します。
ExecuteSqlInstance	SQL インスタンスを実行します。	SQL インスタンスを実行します。
GetDatabaseSchema	GetDatabaseSchema	データベースのスキーマを取得します。
UpdateSqlInstanceContent	UpdateSqlInstanceContent	SQL インスタンスのコンテンツを更新します。
UpdateSqlInstanceName	UpdateSqlInstanceName	SQL インスタンスの名前を更新します。
UpdateSqlInstanceParams	UpdateSqlInstanceParams	SQL インスタンスのパラメーターを更新します。
RenameFolder	RenameFolder	フォルダの名前を変更します。
リリースノート	リリースノート
ListClusterTasks	ListClusterTasks	クラスタータスクを照会します。
ListDataSourceTasks	ListDataSourceTasks	データソースタスクを表示します。
ForceSwitch	ForceSwitch	強制スイッチオーバーを実行します。
ログ管理	ログ管理
ListLogs	ListLogs	インスタンスのログを照会します。
Deployment 管理	Deployment 管理
ModifyNodeConfig	ModifyNodeConfig	ノードの構成を変更します。
GetDeployGraph	GetDeployGraph	デプロイメントの概要を表示します。
GetNodeConfig	ノードの構成情報を取得します	ノードの構成情報を取得します。
運用管理	運用管理
ListIndexRecoverRecords	ListIndexRecoverRecords	データ回復レコードをリストします。
ListPausePolicys	ListPausePolicys	一時停止ポリシーを照会します。
ModifyPausePolicy	ModifyPausePolicy	一時停止ポリシーを変更します。
RemoveCluster	RemoveCluster	クラスターを削除します。
ModifyClusterDesc	ModifyClusterDesc	指定されたクラスターの説明を変更します。
ModifyClusterOfflineConfig	ModifyClusterOfflineConfig	クラスターの設定情報を変更します。
ModifyClusterOnlineConfig	ModifyClusterOnlineConfig	クラスターのオンライン構成を変更します。
GetCluster	GetCluster	クラスターの詳細を照会します。
GetClusterRunTimeInfo	GetClusterRunTimeInfo	指定されたクラスターのランタイム情報を照会します。
ListClusterNames	ListClusterNames	クラスター名を照会します。

テーブル管理

API	タイトル	説明
テーブルエイリアス管理	テーブルエイリアス管理
ModifyAlias	ModifyAlias	テーブルのエイリアスを変更します。
CreateTable	インデックステーブルを作成します	インデックステーブルを作成します。
ModifyTable	インデックステーブルを変更します	インデックステーブルを変更します。
DeleteTable	インデックステーブルの削除	インデックステーブルを削除します。
Reindex	インデックスを再作成します	インデックスを再作成します。
ListTableGenerations	ListTableGenerations	インデックスバージョンのリストを照会します。
GetTableGeneration	GetTableGeneration	完全なインデックスバージョンの ID に基づいて、インデックスバージョンのステータスを照会します。

その他

API	タイトル	説明
ListPostQueryResult	ListPostQueryResult	POST リクエストを送信して、検索拡張生成エディションインスタンスの検索テストの結果を取得します。
ListRestQueryResult	ListRestQueryResult	Retrieval Engine Edition インスタンスの REST 検索クエリのテスト結果を取得します。
ListVectorQueryResult	ListVectorQueryResult	Vector Search Edition のベクタークエリテストの結果を取得します。
PushDocuments	PushDocuments	ドキュメントをプッシュします。
ListQueryResult	ListQueryResult	クエリ結果を照会します。
ModifyModel	ModifyModel	モデルの詳細とステータスを変更します。
DebugModel	DebugModel	モデルをデバッグします。
GetModel	GetModel	インスタンス ID とモデル名で特定のモデルの詳細な構成を照会します。
ListModels	モデルのリストを取得します	インスタンス ID を指定して、条件に一致するモデルのリストを照会します。
ModifySearcherReplica	ModifySearcherReplica	インスタンス内のデータノードのレプリカ数またはシャード数を変更します。

Others

API	タイトル	説明
ChangeResourceGroup	ChangeResourceGroup	インスタンスのリソースグループを変更します。
CreateAlias	エイリアスを作成します	エイリアスを作成します。
CreateCluster	クラスターを追加します	クラスターを追加します。
CreateConfigFile	高度な設定でファイルを作成する	高度な設定でファイルを作成します。
CreateDataSource	データソースを作成します	データソースを作成します。
CreateFolder	フォルダを作成します	フォルダを作成します。
CreateIndex	CreateIndex	インデックスを作成します。
CreateInstance	インスタンスを作成します	Wentian エンジンインスタンスを作成します。
CreateModel	CreateModel	モデルを作成します。
CreateSqlInstance	SQL インスタンスを作成します	SQL インスタンスを作成します。
DeleteAlias	エイリアスを削除します	エイリアスを削除します。
DeleteConfigFile	詳細設定ファイルを削除します	詳細設定ファイルを削除します。
DeleteDataSource	DeleteDataSource	指定されたデータソースを削除します。
DeleteFolder	DeleteFolder	フォルダを削除します。
DeleteIndex	DeleteIndex	インデックスを削除します。
DeleteIndexVersion	DeleteIndexVersion	インデックスのバージョンを削除します。
DeleteInstance	DeleteInstance	指定されたインスタンスを削除します。
DeleteModel	DeleteModel	モデルを削除します。
DescribeRegions	DescribeRegions	利用可能なリージョンを照会します。
GetDataSource	GetDataSource	データソースを取得します。
GetFile	GetFile	インデックスバージョンの詳細を取得します。
GetIndex	GetIndex	インデックステーブルバージョンの詳細を取得します。
GetInstance	GetInstance	ID に基づいてインスタンスの詳細を取得します。
GetSqlInstance	SQL インスタンス情報を取得します	SQL インスタンス情報を取得します。
GetTable	インデックステーブル情報を取得します	インデックステーブル情報を取得します。
ListAliases	ListAliases	テーブルエイリアスのリストを表示します。
ListClusters	ListClusters	クラスターを照会します。
ListDatabases	ListDatabases	既存のデータベースをリスト表示します。
ListDataSources	ListDataSources	データソースのリストを取得します。
ListInstances	ListInstances	インスタンスのリストを取得します。
ListSchemas	ListSchemas	データ同期構成に基づいてスキーマのリストを取得します。
ListTables	ListTables	インデックステーブルのリストを照会します。
ListTagResources	ListTagResources	1 つ以上のリソースにアタッチされたタグを照会します。
ListTasks	ListTasks	インスタンスの変更履歴を取得します。
StopTask	StopTask	FSM タスクを停止します。
TagResources	TagResources	複数のリソースのタグを追加または更新します。
UntagResources	UntagResources	リソースのバッチからタグを削除します。
UpdateInstance	UpdateInstance	指定されたインスタンスの構成を変更します。