文档

ListScheduledTasks - 获取应用定时任务列表

更新时间:

获取OpenSearch应用定时任务列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
opensearch:ListScheduledTask
  • ScheduledTask
    acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

请求语法

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

请求参数

名称类型必填描述示例值
appGroupIdentitystring

应用名称

my_app_group_name
typestring

定时任务类型

  • wipe 数据清理
  • fork 索引重建
  • check-status 检查应用状态
  • index 索引重建
wipe
pageNumberinteger

页码,默认 pageNumber = 1

1
pageSizeinteger

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

10

查询参数

字段类型是否必要示例值描述
idString"2f12c585-5873-11ea-974a-7cd30ad3e268"任务 ID
enabledBooleantrue是否已开启定时任务
updatedInteger1582706232定时任务的更新时间戳

返回参数

名称类型描述示例值
object
totalCountlong

总条数

1
requestIdstring

请求 ID

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

定时任务信息

参考: ScheduledTask

[]

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史