文档

GetSortScript - 获取排序脚本详情

更新时间:

获取排序脚本详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
opensearch:DescribeSortScript
  • App
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

请求语法

GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}

请求参数

名称类型必填描述示例值
appGroupIdentitystring

应用的名称、应用 id

my_app
scriptNamestring

脚本名称

script1
appVersionIdstring

应用下的版本 id

160051478

返回参数

名称类型描述示例值
object
requestIdstring

唯一标识一次请求

ABCDEFGH
resultobject

脚本的详情

scopestring

脚本的作用范围

second_rank
createTimestring

脚本创建时间

2020-04-02 20:21:14
statusstring

脚本的状态,详情请参考下节脚本状态列表

released
modifyTimestring

脚本最后一次修改时间

2020-04-02 21:21:14
typestring

脚本的类型

cava_script
scriptNamestring

脚本名称

rank_cava_20230606_v7
错误返回
{
    "requestId" : "ABCDEFGH",
		"code":"ResourceNotFound",
    "message":"The specified script not found.",
    "httpCode":404
}

示例

正常返回示例

JSON格式

{
  "requestId": "ABCDEFGH",
  "result": {
    "scope": "second_rank",
    "createTime": "2020-04-02 20:21:14",
    "status": "released",
    "modifyTime": "2020-04-02 21:21:14",
    "type": "cava_script",
    "scriptName": "rank_cava_20230606_v7\n"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-16OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更