CreateScheduledTask - OpenSearch - Alibaba Cloud Documentation Center

Creates a scheduled task for an OpenSearch application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
opensearch:CreateScheduledTask		ScheduledTask acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	my_app_group_name
body	ScheduledTask	No	The request body.

Request body

Parameter	Type	Required	Example	Description
type	String	Yes	"wipe"	The type of the scheduled task. Valid values:wipe: data scrubbingfork: data import and reindexingreindex: reindexingclear: data clearing
cron	String	Yes	"10 20 * * 1,2,3,4,5"	The configuration of the scheduled task.For more information, see cron field in ScheduledTask.
enabled	Boolean	Yes	true	Specify whether the scheduled task is enabled.
appStrategy	String	No	delete-idle	The policy for creating a new version. Valid values:delete-idle: Two versions exist. Delete the non-online version first and then create a new version.need-slot: Only one version exists. Create a new version directly.
filter	Object	No		The conditions that are used to delete data.
filter.days	Integer	Yes	7	The remaining validity period.Valid values: [7,180]. Unit: days.
filter.unit	String	Yes	"s"	The unit of the expiration time of the field. Valid values:s: secondsms: milliseconds
filter.field	String	No	"cate_id"	The field that the task clears based on the expiration settings.
runNow	Boolean	No	false	Specifies whether to immediately execute the task. Default value: false.
permanent	Boolean	No	true	Specifies whether the scheduled task can always be executed. Default value: true.

Response parameters

Parameter	Type	Description	Example
	object
result	object	For more information about a scheduled task, see ScheduledTask .	{}
requestId	string	The request ID.	ABCDEFGH

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-05-24	The request parameters of the API has changed	View Change Details