全部產品
Search
文件中心

OpenSearch:ListScheduledTasks - 擷取應用定時工作清單

更新時間:Dec 23, 2025

擷取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 HTTP/1.1

路徑參數

名稱

類型

必填

描述

樣本值

appGroupIdentity

string

應用程式名稱

my_app_group_name

請求參數

名稱

類型

必填

描述

樣本值

type

string

定時任務類型

  • wipe 資料清理

  • fork 索引重建

  • check-status 檢查應用狀態

  • index 索引重建

wipe

pageNumber

integer

頁碼,預設 pageNumber = 1

1

pageSize

integer

每頁返回數目,預設 pageSize = 10

10

查詢參數

欄位類型是否必要樣本值描述
idString"2f12c585-5873-11ea-974a-7cd30ad3e268"任務 ID
enabledBooleantrue是否已開啟定時任務
updatedInteger1582706232定時任務的更新時間戳記

返回參數

名稱

類型

描述

樣本值

object

totalCount

integer

總條數

1

requestId

string

請求 ID

0A6EB64B-B4C8-CF02-810F-E660812972FF

result

array<object>

object

定時任務資訊

參考: ScheduledTask

[]

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情