DescribeScheduledTasks - 查詢定時任務的資訊 - Auto Scaling

定時任務是一種預設任務，可以在指定時間執行指定的伸縮規則，實現計算資源的自動擴縮容。定時任務建立完成後，您可以調用API DescribeScheduledTasks查詢定時任務的詳細資料，例如，定時任務的觸發時間點、定時任務總數、執行定時任務的伸縮組的ID等。

介面說明

您可以通過定時任務的 ID、定時任務的名稱、定時任務執行的伸縮規則等查詢定時任務。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:DescribeScheduledTasks

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

無

請求參數

名稱	類型	必填	描述	樣本值
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	否	重複執行定時任務的類型，取值範圍： Daily：每多少天重複執行一次定時任務。 Weekly：每周指定幾天重複執行一次定時任務。 Monthly：每月內指定幾天重複執行一次定時任務。 Cron：按照指定的 Cron 運算式執行定時任務。	Weekly
RecurrenceValue	string	否	重複執行定時任務的數值。僅支援當 RecurrenceType 為 Weekly 時指定此欄位，可以填入多個值，填多個值時使用半形逗號（,）分隔。例如，周日、周一、周二、周三、周四、周五、周六的值依次為：0,1,2,3,4,5,6。	1,2,3
TaskEnabled	boolean	否	定時任務是否已啟動。 true：任務已啟動。 false：任務已停止。	true

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	當前頁碼。	1
PageSize	integer	每頁行數。	50
TotalCount	integer	定時任務總數。	1
ScheduledTasks	array<object>	定時任務資訊組成的集合。
	object	定時任務資訊組成的集合。
TaskEnabled	boolean	是否啟動定時任務。 true：啟動任務。 false：停止任務。預設值：true。	true
RecurrenceValue	string	重複觸發定時任務的數值。	1
RecurrenceType	string	重複觸發定時任務的類型。	Daily
MaxValue	integer	定時任務的`伸縮方式`選擇`伸縮組內執行個體數量設定`時，指定伸縮組內執行個體的最大數量。	10
ScheduledTaskName	string	定時任務的名稱。	scheduled****
RecurrenceEndTime	string	重複觸發定時任務的結束時間。	2014-08-20T16:55Z
DesiredCapacity	integer	定時任務的`伸縮方式`選擇`伸縮組內執行個體數量設定`時，指定伸縮組內執行個體的期望執行個體數。	10
ScheduledTaskId	string	定時任務的 ID。	edRtShc57WGXdt8TlPbr****
MinValue	integer	定時任務的`伸縮方式`選擇`伸縮組內執行個體數量設定`時，指定伸縮組內執行個體的最小數量。	0
ScalingGroupId	string	執行定時任務的伸縮組的 ID。	asg-bp1bo5tca4m56nap****
LaunchExpirationTime	integer	定時任務觸發操作失敗後，在此時間內重試。單位為秒，取值範圍：0~21600。	600
Description	string	定時任務的描述資訊。	Test scheduled task.
ScheduledAction	string	執行定時任務時使用的伸縮規則。僅當定時任務指定了伸縮規則時，返回該參數。	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
LaunchTime	string	定時任務觸發的時間點。	2014-08-18T10:52Z

樣本

正常返回樣本

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

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。