CreateSortScript - OpenSearch - Centro de documentación de Alibaba Cloud

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

opensearch:WriteSortScript

create

*App

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

Ninguna

Sintaxis de la solicitud

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

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
appGroupIdentity	string	Sí	El nombre o ID de la aplicación.	search
appVersionId	string	Sí	El ID del reporte bajo la aplicación.	1234567

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	object	No	El cuerpo de la solicitud.
scriptName	string	No	El nombre del script.	rank_cava_20230606_v7
type	string	No	El tipo de script. Actualmente, solo se admite cava_script.	cava_script
scope	string	No	El alcance del script.	second_rank
description	string	No	Los comentarios del script.

Parámetros de solicitud

Nombre	Tipo	Obligatorio	Descripción
scriptParams	Map	Sí	Los parámetros del script que se registrarán.

scriptParams

Nombre	Tipo	Obligatorio	Descripción
scriptName	String	Sí	El nombre del script.
type	String	Sí	El tipo de script. Actualmente, solo se admite cava_script.
scope	String	Sí	El alcance del script. Actualmente, solo se admite second_rank.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
requestId	string	El ID de la solicitud.	ABCDEFGH
result	object	El resultado devuelto.
scriptName	string	El nombre del script.	rank_cava_20230606_v7
type	string	El tipo de script.	cava_script
scope	string	El alcance del script.	second_rank
status	string

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.