Queries the details of a scheduled task 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/[taskId] HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app_group_name

The name of the application.

taskId String Path Yes 2f12c585-5873-11ea-974a-7cd30ad3e268

The ID of the scheduled task.

Response parameters

Parameter Type Example Description
requestId String 922DC0D9-31B5-45F9-47B7-37DC678D61A8

The ID of the request.

result Map {}

The details of the scheduled task.

Examples

Sample requests

GET /v4/openapi/app-groups/110091051/scheduled-tasks/2f12c585-5873-11ea-974a-7cd30ad3e268

Sample success responses

XML format

<requestId>922DC0D9-31B5-45F9-47B7-37DC678D61A8</requestId>
<result>
    <id>2f12c585-5873-11ea-974a-7cd30ad3e268</id>
    <progress>60</progress>
    <status>0</status>
    <lastRanTimestamp>1593755495</lastRanTimestamp>
    <type>wipe</type>
    <running>true</running>
    <paused>false</paused>
    <finished>false</finished>
    <idle>false</idle>
    <created>1593747144</created>
    <updated>1593755504</updated>
    <cron>0 0 * * 1,2,3,4,5,6,7</cron>
    <enabled>true</enabled>
    <appId/>
    <appGroupId>110091051</appGroupId>
    <ownerId>84</ownerId>
    <lastScheduledTimestamp/>
    <forkedAppId>100304004</forkedAppId>
    <appGroup>
        <id>110091051</id>
    </appGroup>
    <owner>
        <id>84</id>
    </owner>
    <filter>
        <field>title</field>
        <days>30</days>
        <unit>s</unit>
    </filter>
</result>

JSON format

{
    "requestId": "922DC0D9-31B5-45F9-47B7-37DC678D61A8",
    "result": {
        "id": "2f12c585-5873-11ea-974a-7cd30ad3e268",
        "progress": 60,
        "status": 0,
        "lastRanTimestamp": 1593755495,
        "type": "wipe",
        "running": true,
        "paused": false,
        "finished": false,
        "idle": false,
        "created": 1593747144,
        "updated": 1593755504,
        "cron": "0 0 * * 1,2,3,4,5,6,7",
        "enabled": true,
        "appId": "",
        "appGroupId": 110091051,
        "ownerId": 84,
        "lastScheduledTimestamp": "",
        "forkedAppId": 100304004,
        "appGroup": {
            "id": 110091051
        },
        "owner": {
            "id": 84
        },
        "filter": {
            "field": "title",
            "days": 30,
            "unit": "s"
        }
    }
}

Error codes

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