PublishIndexVersion API でインデックスバージョンを公開 - OpenSearch

操作説明

メソッド

POST

URI

/openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/publish

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

searchengine:PublishIndexVersion

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエスト構文

POST /openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/publish HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	ha-cn-pl32rf0****
indexName	string	必須	インデックス名。	test_api

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディ。	{ "dataSource": "ha-cn-pl32rf0****_test_api", "desc": "备注信息" }

リクエストの例

POST /openapi/ha3/instances/ose-test1/indexes/my_index/actions/publish

{

  "desc": "new version",

  "dataSource": "test1",

  "domain": "test_domain"

}

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
requestId	string	リクエストの ID	E45380E8-994A-5402-9806-F114B3295FCF
result	object	インデックスに関する情報	{}

レスポンスの例

正常なレスポンスの例

{
 
  "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",
 
  "result": []
 
}

詳細については、「応答構造」をご参照ください。

例

成功レスポンス

JSONJSON

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": {}
}

エラーコード

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

変更履歴

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