创建排序脚本。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
opensearch:WriteSortScript |
*App
|
无 | 无 |
请求语法
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 |
请求参数
| 名称 | 类型 | 是否必选 | 描述 |
| 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"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。