Automate Scheduled Tasks with the OpenSearch API - OpenSearch - Alibaba Cloud - OpenSearch

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:CreateScheduledTask

create

*ScheduledTask

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	my_app_group_name

Request parameters

Parameter	Type	Required	Description	Example
body	ScheduledTask	No	The request body.

Request body

Field	Type	Required	Example	Description
type	String	Yes	"wipe"	The type of the scheduled task. Valid values: - wipe: data cleanup. - fork: data import with index rebuild. - reindex: index rebuild. - clear: data clearing.
cron	String	Yes	"10 20 * * 1,2,3,4,5"	The cron expression for the schedule. For more information, see ScheduledTask scheduling rules.
enabled	Boolean	Yes	true	Specifies whether to enable the scheduled task.
appStrategy	String	No	delete-idle	The strategy for creating a new version. Valid values: - delete-idle: If two versions already exist, delete the non-online version first, and then create a new version. - need-slot: If only one version exists, directly create a new version.
filter	Object	No		The data cleanup conditions.
filter.days	Integer	Yes	7	The number of expiration days. Valid values: 7 to 180.
filter.unit	String	Yes	"s"	The unit of the expiration time. Valid values: - s: seconds. - ms: milliseconds.
filter.field	String	No	"cate_id"	The expiration field.
runNow	Boolean	No	false	Specifies whether to run the task immediately. Default value: false.
permanent	Boolean	No	true	Specifies whether to persist the task. Default value: true.

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.