All Products
Search
Document Center

OpenSearch:ListScheduledTasks

Last Updated:Mar 03, 2024

Queries a list of scheduled tasks of an OpenSearch application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

my_app_group_name

my_app_group_name
typestringNo

wipe

wipe
pageNumberintegerNo

1

1
pageSizeintegerNo

10

10

Response parameters

ParameterTypeDescriptionExample
object
totalCountlong

The total number of the returned scheduled tasks.

1
requestIdstring

The ID of the request.

0A6EB64B-B4C8-CF02-810F-E660812972FF
resultobject []

The details of the scheduled tasks.

For more information, see ScheduledTask .

object
[]

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