获取OpenSearch应用定时任务列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
appGroupIdentity String Path my_app_group_name

应用名称

type String Query wipe

定时任务类型

  • wipe 数据清理
  • fork 索引重建
  • check-status 检查应用状态
  • index 索引重建
  • app
pageNumber Integer Query 1

页码,默认 pageNumber = 1

pageSize Integer Query 10

每页返回数目,默认 pageSize = 10

查询参数

字段

类型

是否必要

示例值

描述

id

String

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

任务ID

enabled

Boolean

true

是否已开启定时任务

updated

Integer

1582706232

定时任务的更新时间戳

返回数据

名称 类型 示例值 描述
requestId String 0A6EB64B-B4C8-CF02-810F-E660812972FF

请求ID

result List []

定时任务信息

参考:ScheduledTask

totalCount Long 1

总条数

示例

请求示例

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

正常返回示例

XML格式

<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格式

{
    "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"
        }
    }
}

错误码

访问错误中心查看更多错误码。