定時任務是一種預設任務，可以在指定時間執行指定的伸縮規則，實現計算資源的自動擴縮容。定時任務創建完成后，您可以調用API DescribeScheduledTasks查詢定時任務的詳細信息，例如，定時任務的觸發時間點、定時任務總數、執行定時任務的伸縮組的ID等。
接口說明
您可以通過定時任務的 ID、定時任務的名稱、定時任務執行的伸縮規則等查詢定時任務。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ess:DescribeScheduledTasks | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 定時任務所屬伸縮組的地域 ID。 | cn-qingdao |
| PageNumber | integer | 否 | 定時任務列表的頁碼，起始值：1。 默認值：1。 | 1 |
| PageSize | integer | 否 | 分頁查詢時設置的每頁行數，最大值：50。 默認值：10。 | 50 |
| ScalingGroupId | string | 否 | 執行定時任務的伸縮組的 ID。 | asg-bp1bo5tca4m56nap**** |
| ScheduledActions | array | 否 | 僅當定時任務指定了伸縮規則時，定時任務觸發時使用的伸縮規則。 | |
| string | 否 | 僅當定時任務指定了伸縮規則時，定時任務觸發時使用的伸縮規則。 取值為伸縮規則的唯一標識符（ScalingRuleAri）。 | ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd**** | |
| ScheduledTaskIds | array | 否 | 待查詢定時任務的 ID。 | |
| string | 否 | 待查詢定時任務的 ID。 | edRtShc57WGXdt8TlPbr**** | |
| ScheduledTaskNames | array | 否 | 待查詢定時任務的名稱。 | |
| string | 否 | 待查詢定時任務的名稱。 | scheduled**** | |
| TaskName | string | 否 | 任務名稱，支持根據關鍵字模糊搜索。 | scheduled**** |
| RecurrenceType | string | 否 | 重復執行定時任務的類型，取值范圍：
| Weekly |
| RecurrenceValue | string | 否 | 重復執行定時任務的數值。 僅支持當 RecurrenceType 為 Weekly 時指定此字段，可以填入多個值，填多個值時使用半角逗號（,）分隔。例如，周日、周一、周二、周三、周四、周五、周六的值依次為：0,1,2,3,4,5,6。 | 1,2,3 |
| TaskEnabled | boolean | 否 | 定時任務是否已啟動。
| true |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"PageNumber": 1,
"PageSize": 50,
"TotalCount": 1,
"ScheduledTasks": [
{
"TaskEnabled": true,
"RecurrenceValue": "1",
"RecurrenceType": "Daily",
"MaxValue": 10,
"ScheduledTaskName": "scheduled****",
"RecurrenceEndTime": "2014-08-20T16:55Z",
"DesiredCapacity": 10,
"ScheduledTaskId": "edRtShc57WGXdt8TlPbr****",
"MinValue": 0,
"ScalingGroupId": "asg-bp1bo5tca4m56nap****",
"LaunchExpirationTime": 600,
"Description": "Test scheduled task.",
"ScheduledAction": "ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****",
"LaunchTime": "2014-08-18T10:52Z"
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-07-04 | OpenAPI 入參發生變更 | 查看變更詳情 |