DescribeScheduledTasks - Auto Scaling

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

介面說明

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	DescribeScheduledTasks	系統規定參數。取值：DescribeScheduledTasks。
RegionId	String	是	cn-qingdao	定時任務所屬伸縮組的地區ID。
PageNumber	Integer	否	1	定時工作清單的頁碼，起始值：1。預設值：1。
PageSize	Integer	否	50	分頁查詢時設定的每頁行數，最大值：50。預設值：10。
ScalingGroupId	String	否	asg-bp1bo5tca4m56nap****	執行定時任務的伸縮組的ID。
ScheduledAction.N	String	否	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**	僅當定時任務指定了伸縮規則時，定時任務觸發時使用的伸縮規則。N的取值範圍：0~20。取值為伸縮規則的唯一識別碼（ScalingRuleAri）。
ScheduledTaskId.N	String	否	edRtShc57WGXdt8TlPbr****	待查詢定時任務的ID，N的取值範圍：1～20。
ScheduledTaskName.N	String	否	scheduled****	待查詢定時任務的名稱，N的取值範圍：1～20。
TaskName	String	否	scheduled****	任務名稱，支援根據關鍵字模糊搜尋。
RecurrenceType	String	否	Weekly	重複執行定時任務的類型，取值範圍： Daily：每多少天重複執行一次定時任務。 Weekly：每周指定幾天重複執行一次定時任務。 Monthly：每月內指定幾天重複執行一次定時任務。 Cron：按照指定的Cron運算式執行定時任務。
RecurrenceValue	String	否	1,2,3	重複執行定時任務的數值。僅支援當RecurrenceType為Weekly時指定此欄位，可以填入多個值，填多個值時使用半形逗號（,）分隔。例如，周日、周一、周二、周三、周四、周五、周六的值依次為：0,1,2,3,4,5,6。
TaskEnabled	Boolean	否	true	定時任務是否已啟動。 true：任務已啟動。 false：任務已停止。

返回資料

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

樣本

請求樣本

http(s)://ess.aliyuncs.com/?Action=DescribeScheduledTasks
&RegionId=cn-qingdao
&PageNumber=1
&PageSize=50
&ScalingGroupId=asg-bp1bo5tca4m56nap****
&ScheduledAction=["ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****"]
&ScheduledTaskId=["edRtShc57WGXdt8TlPbr****"]
&ScheduledTaskName=["scheduled****"]
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeScheduledTasksResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>50</PageSize>
    <TotalCount>1</TotalCount>
    <ScheduledTasks>
        <TaskEnabled>true</TaskEnabled>
        <RecurrenceValue>1</RecurrenceValue>
        <RecurrenceType>Daily</RecurrenceType>
        <MaxValue>10</MaxValue>
        <ScheduledTaskName>scheduled****</ScheduledTaskName>
        <RecurrenceEndTime>2014-08-20T16:55Z</RecurrenceEndTime>
        <DesiredCapacity>10</DesiredCapacity>
        <ScheduledTaskId>edRtShc57WGXdt8TlPbr****</ScheduledTaskId>
        <MinValue>0</MinValue>
        <ScalingGroupId>asg-bp1bo5tca4m56nap****</ScalingGroupId>
        <LaunchExpirationTime>600</LaunchExpirationTime>
        <Description>Test scheduled task.</Description>
        <ScheduledAction>ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****</ScheduledAction>
        <LaunchTime>2014-08-18T10:52Z</LaunchTime>
    </ScheduledTasks>
</DescribeScheduledTasksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
  } ]
}

錯誤碼

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