DescribeScheduledTasks
定時任務(wù)是一種預(yù)設(shè)任務(wù),可以在指定時間執(zhí)行指定的伸縮規(guī)則,實(shí)現(xiàn)計(jì)算資源的自動擴(kuò)縮容。定時任務(wù)創(chuàng)建完成后,您可以調(diào)用API DescribeScheduledTasks查詢定時任務(wù)的詳細(xì)信息,例如,定時任務(wù)的觸發(fā)時間點(diǎn)、定時任務(wù)總數(shù)、執(zhí)行定時任務(wù)的伸縮組的ID等。
接口說明
您可以通過定時任務(wù)的ID、定時任務(wù)的名稱、定時任務(wù)執(zhí)行的伸縮規(guī)則等查詢定時任務(wù)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DescribeScheduledTasks | 系統(tǒng)規(guī)定參數(shù)。取值:DescribeScheduledTasks。 |
RegionId | String | 是 | cn-qingdao | 定時任務(wù)所屬伸縮組的地域ID。 |
PageNumber | Integer | 否 | 1 | 定時任務(wù)列表的頁碼,起始值:1。 默認(rèn)值:1。 |
PageSize | Integer | 否 | 50 | 分頁查詢時設(shè)置的每頁行數(shù),最大值:50。 默認(rèn)值:10。 |
ScalingGroupId | String | 否 | asg-bp1bo5tca4m56nap**** | 執(zhí)行定時任務(wù)的伸縮組的ID。 |
ScheduledAction.N | String | 否 | ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd**** | 僅當(dāng)定時任務(wù)指定了伸縮規(guī)則時,定時任務(wù)觸發(fā)時使用的伸縮規(guī)則。N的取值范圍:0~20。 取值為伸縮規(guī)則的唯一標(biāo)識符(ScalingRuleAri)。 |
ScheduledTaskId.N | String | 否 | edRtShc57WGXdt8TlPbr**** | 待查詢定時任務(wù)的ID,N的取值范圍:1~20。 |
ScheduledTaskName.N | String | 否 | scheduled**** | 待查詢定時任務(wù)的名稱,N的取值范圍:1~20。 |
TaskName | String | 否 | scheduled**** | 任務(wù)名稱,支持根據(jù)關(guān)鍵字模糊搜索。 |
RecurrenceType | String | 否 | Weekly | 重復(fù)執(zhí)行定時任務(wù)的類型,取值范圍:
|
RecurrenceValue | String | 否 | 1,2,3 | 重復(fù)執(zhí)行定時任務(wù)的數(shù)值。 僅支持當(dāng)RecurrenceType為Weekly時指定此字段,可以填入多個值,填多個值時使用半角逗號(,)分隔。例如,周日、周一、周二、周三、周四、周五、周六的值依次為:0,1,2,3,4,5,6。 |
TaskEnabled | Boolean | 否 | true | 定時任務(wù)是否已啟動。
|
返回?cái)?shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | 請求ID。 |
PageNumber | Integer | 1 | 當(dāng)前頁碼。 |
PageSize | Integer | 50 | 每頁行數(shù)。 |
TotalCount | Integer | 1 | 定時任務(wù)總數(shù)。 |
ScheduledTasks | Array of ScheduledTask | 定時任務(wù)信息組成的集合。 |
|
ScheduledTask | |||
TaskEnabled | Boolean | true | 是否啟動定時任務(wù)。
默認(rèn)值:true。 |
RecurrenceValue | String | 1 | 重復(fù)觸發(fā)定時任務(wù)的數(shù)值。 |
RecurrenceType | String | Daily | 重復(fù)觸發(fā)定時任務(wù)的類型。 |
MaxValue | Integer | 10 | 定時任務(wù)的 |
ScheduledTaskName | String | scheduled**** | 定時任務(wù)的名稱。 |
RecurrenceEndTime | String | 2014-08-20T16:55Z | 重復(fù)觸發(fā)定時任務(wù)的結(jié)束時間。 |
DesiredCapacity | Integer | 10 | 定時任務(wù)的 |
ScheduledTaskId | String | edRtShc57WGXdt8TlPbr**** | 定時任務(wù)的ID。 |
MinValue | Integer | 0 | 定時任務(wù)的 |
ScalingGroupId | String | asg-bp1bo5tca4m56nap**** | 執(zhí)行定時任務(wù)的伸縮組的ID。 |
LaunchExpirationTime | Integer | 600 | 定時任務(wù)觸發(fā)操作失敗后,在此時間內(nèi)重試。單位為秒,取值范圍:0~21600。 |
Description | String | Test scheduled task. | 定時任務(wù)的描述信息。 |
ScheduledAction | String | ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd**** | 執(zhí)行定時任務(wù)時使用的伸縮規(guī)則。僅當(dāng)定時任務(wù)指定了伸縮規(guī)則時,返回該參數(shù)。 |
LaunchTime | String | 2014-08-18T10:52Z | 定時任務(wù)觸發(fā)的時間點(diǎn)。 |
示例
請求示例
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****"]
&公共請求參數(shù)
正常返回示例
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"
} ]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。