CreateScheduledTask - 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:CreateScheduledTask

create

*ScheduledTask

acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

Ninguna

Sintaxis de la solicitud

POST /v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
appGroupIdentity	string	Sí	El nombre de la aplicación.	my_app_group_name

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	ScheduledTask	No	El cuerpo de la solicitud.

Cuerpo de la solicitud

Campo	Tipo	Obligatorio	Ejemplo	Descripción
type	String	Sí	"wipe"	El tipo de la tarea programada. Valores válidos: - wipe: limpieza de datos. - fork: importación de datos con reconstrucción de índice. - reindex: reconstrucción de índice. - clear: eliminación de datos.
cron	String	Sí	"10 20 * * 1,2,3,4,5"	La expresión cron para la programación. Para obtener más información, consulte Reglas de programación de ScheduledTask.
enabled	Boolean	Sí	true	Especifica si se debe habilitar la tarea programada.
appStrategy	String	No	delete-idle	La estrategia para crear una nueva versión. Valores válidos: - delete-idle: Si ya existen dos versiones, elimina primero la versión que no está en línea y luego crea una nueva versión. - need-slot: Si solo existe una versión, crea directamente una nueva versión.
filter	Object	No		Las condiciones de limpieza de datos.
filter.days	Integer	Sí	7	El número de días de caducidad. Valores válidos: de 7 a 180.
filter.unit	String	Sí	"s"	La unidad del tiempo de caducidad. Valores válidos: - s: segundos. - ms: milisegundos.
filter.field	String	No	"cate_id"	El campo de caducidad.
runNow	Boolean	No	false	Especifica si se debe ejecutar la tarea inmediatamente. Valor predeterminado: false.
permanent	Boolean	No	true	Especifica si se debe conservar la tarea de forma permanente. Valor predeterminado: true.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
result	object	La información de la tarea programada. Para obtener más información, consulte ScheduledTask.	{}
requestId	string	El ID de la solicitud.	ABCDEFGH

Ejemplos

Respuesta exitosa

JSON Formato

{
  "result": {},
  "requestId": "ABCDEFGH"
}

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.