All Products
Search
Document Center

OpenSearch:ListScheduledTasks

Last Updated:Oct 16, 2024

Queries a list of scheduled tasks of 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:ListScheduledTask
  • ScheduledTask
    acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The application name.

my_app_group_name
typestringNo

The scheduled task type. Valid values:

  • wipe: data cleaning.
  • fork: reindexing.
  • check-status: application status check.
  • index: reindexing.
wipe
pageNumberintegerNo

The page number. Default value: 1.

1
pageSizeintegerNo

The number of entries per page. Default value: 10.

10

Request parameters

ParameterTypeRequiredExampleDescription
idStringNo"2f12c585-5873-11ea-974a-7cd30ad3e268"The task ID.
enabledBooleanNotrueSpecifies whether the scheduled task is enabled.
updatedIntegerNo1582706232The timestamp when the scheduled task was last updated.

Response parameters

ParameterTypeDescriptionExample
object
totalCountlong

The total number of entries returned.

1
requestIdstring

The request ID.

0A6EB64B-B4C8-CF02-810F-E660812972FF
resultarray<object>
resultobject

The information about the scheduled task.

For more information, see ScheduledTask .

[]

Examples

Sample success responses

JSONformat

{
  "totalCount": 1,
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    []
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history