Queries the 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/app-groups/[appGroupIdentity]/scheduled-tasks HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app_group_name

The name of the application.

type String Query No wipe

The type of the scheduled task. Valid values:

  • wipe: data cleaning
  • fork: reindexing
  • check-status: checking of the application status
  • index: reindexing
pageNumber Integer Query No 1

The number of the page to return. Default value: 1.

pageSize Integer Query No 10

The number of items to return on each page. Default value: 10.

Request body

Parameter

Type

Required

Example

Description

id

String

No

"2f12c585-5873-11ea-974a-7cd30ad3e268"

The ID of the scheduled task.

enabled

Boolean

No

true

Specifies whether to query only scheduled tasks that have been enabled.

updated

Integer

No

1582706232

The time when the scheduled task was last modified.

Response parameters

Parameter Type Example Description
requestId String 0A6EB64B-B4C8-CF02-810F-E660812972FF

The ID of the request.

result List []

The details of the scheduled tasks.

For more information, see ScheduledTask.

totalCount Long 1

The total number of the returned scheduled tasks.

Examples

Sample requests

GET /v4/openapi/app-groups/110091051/scheduled-tasks?type=wipe

Sample success responses

XML format

<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>
<totalCount>1</totalCount>
<result>
    <id>2f12c585-5873-11ea-974a-7cd30ad3e268</id>
    <progress>0</progress>
    <status>3</status>
    <lastRanTimestamp/>
    <type>wipe</type>
    <running>false</running>
    <paused>false</paused>
    <finished>false</finished>
    <idle>true</idle>
    <created>1582706232</created>
    <updated>1582706232</updated>
    <cron>0 0 * * 1,2,3,4,5,6,7</cron>
    <enabled>true</enabled>
    <appId/>
    <appGroupId>110091051</appGroupId>
    <ownerId>2656</ownerId>
    <lastScheduledTimestamp/>
    <forkedAppId/>
    <appGroup>
        <id>110091051</id>
    </appGroup>
    <owner>
        <id>2656</id>
    </owner>
    <filter>
        <field>ctime</field>
        <days>30</days>
        <unit>s</unit>
    </filter>
</result>

JSON format

{
    "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
    "totalCount": 1,
    "result": {
        "id": "2f12c585-5873-11ea-974a-7cd30ad3e268",
        "progress": 0,
        "status": 3,
        "lastRanTimestamp": "",
        "type": "wipe",
        "running": false,
        "paused": false,
        "finished": false,
        "idle": true,
        "created": 1582706232,
        "updated": 1582706232,
        "cron": "0 0 * * 1,2,3,4,5,6,7",
        "enabled": true,
        "appId": "",
        "appGroupId": 110091051,
        "ownerId": 2656,
        "lastScheduledTimestamp": "",
        "forkedAppId": "",
        "appGroup": {
            "id": 110091051
        },
        "owner": {
            "id": 2656
        },
        "filter": {
            "field": "ctime",
            "days": 30,
            "unit": "s"
        }
    }
}

Error codes

For a list of error codes, visit the API Error Center.