全部產品

OpenSearch：CreateSortScript - 建立排序指令碼

更新時間：Dec 23, 2025

建立排序指令碼。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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	否

請求參數

名稱	類型	是否必選	描述
scriptParams	Map	是	待註冊的 script 參數

scriptParams

名稱	類型	是否必選	描述
scriptName	String	是	script 名稱
type	String	是	指令碼的類型，目前只支援 cava_script
scope	String	是	指令碼的作用範圍，目前只支援 second_rank

返回參數

名稱	類型	描述	樣本值
	object
requestId	string	唯一標識一次請求	ABCDEFGH
result	object	返回結果
scriptName	string	指令碼名稱	rank_cava_20230606_v7
type	string	指令碼的類型	cava_script
scope	string	指令碼的作用範圍	second_rank

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。