すべてのプロダクト
Search
ドキュメントセンター

OpenSearch:CreateSortScript

最終更新日:Dec 23, 2025

ソートスクリプトを作成します。

今すぐお試しください

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

*App

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

なし なし

リクエスト構文

POST /v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

appGroupIdentity

string

必須

アプリケーションの名前または ID。

search

appVersionId

string

必須

アプリケーション内のレポートの ID。

1234567

リクエストパラメーター

パラメーター

必須 / 任意

説明

body

object

任意

リクエストボディ。

scriptName

string

任意

スクリプトの名前。

rank_cava_20230606_v7

type

string

任意

スクリプトのタイプ。cava_script のみがサポートされています。

cava_script

scope

string

任意

スクリプトの適用範囲。

second_rank

description

string

任意

リクエストパラメーター

名前タイプ必須説明
scriptParamsMapはい登録するスクリプトのパラメーター。

scriptParams

名前タイプ必須説明
scriptNameStringはいスクリプトの名前。
typeStringはいスクリプトのタイプ。cava_script のみがサポートされています。
scopeStringはいスクリプトの適用範囲。second_rank のみがサポートされています。

レスポンスフィールド

フィールド

説明

object

requestId

string

リクエストの一意の ID。

ABCDEFGH

result

object

返された結果。

scriptName

string

スクリプトの名前。

rank_cava_20230606_v7

type

string

スクリプトのタイプ。

cava_script

scope

string

スクリプトの適用範囲。

second_rank

成功レスポンス

JSONJSON

{
  "requestId": "ABCDEFGH",
  "result": {
    "scriptName": "rank_cava_20230606_v7\n",
    "type": "cava_script",
    "scope": "second_rank"
  }
}

エラーコード

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

変更履歴

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