調(diào)用DescribeScheduleTasks接口查看當(dāng)前賬號(hào)下所有或指定的計(jì)劃任務(wù)詳情。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeScheduleTasks |
系統(tǒng)規(guī)定參數(shù),取值為DescribeScheduleTasks。 |
Status | String | 否 | finish |
任務(wù)狀態(tài),取值范圍如下:
說(shuō)明 若該參數(shù)留空,默認(rèn)查詢所有狀態(tài)的計(jì)劃任務(wù)。
|
DBClusterId | String | 否 | pc-************** |
集群ID。 說(shuō)明
|
RegionId | String | 否 | cn-hangzhou |
地域ID。 說(shuō)明
|
PageNumber | Integer | 否 | 1 |
頁(yè)碼,取值為大于0且不超過(guò)Integer數(shù)據(jù)類型的最大值。默認(rèn)值為1。 |
PageSize | Integer | 否 | 30 |
每頁(yè)記錄數(shù),取值為30(默認(rèn)值)、50或100。 |
TaskAction | String | 否 | CreateDBNodes |
任務(wù)類型,取值范圍如下:
說(shuō)明
|
DBClusterDescription | String | 否 | testdb |
集群描述。 |
OrderId | String | 否 | 20951253014**** |
訂單ID。 說(shuō)明 僅支持傳入數(shù)字0~9。
|
PlannedStartTime | String | 否 | 2021-01-28T12:00Z |
為目標(biāo)任務(wù)設(shè)定的執(zhí)行開(kāi)始時(shí)間(UTC時(shí)間)。 |
PlannedEndTime | String | 否 | 2021-01-28T12:30Z |
為目標(biāo)任務(wù)設(shè)定的最晚開(kāi)始時(shí)間(UTC時(shí)間)。 |
ResourceGroupId | String | 否 | rg-************ |
資源組ID。 |
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Message | String | Successful |
請(qǐng)求返回消息。 說(shuō)明 請(qǐng)求成功時(shí)該參數(shù)返回Successful,請(qǐng)求失敗時(shí)會(huì)返回請(qǐng)求異常信息(如錯(cuò)誤碼等)。
|
Data | Object |
結(jié)果集。 |
|
TimerInfos | Array of timerInfos |
計(jì)劃任務(wù)詳情。 |
|
Status | String | finish |
目標(biāo)任務(wù)的狀態(tài)。 |
Action | String | CreateDBNodes |
任務(wù)類型。 |
PlannedEndTime | String | 2021-01-28T12:30Z |
為目標(biāo)任務(wù)設(shè)定的最晚開(kāi)始時(shí)間(UTC時(shí)間)。 |
PlannedTime | String | 2021-01-28T12:16Z |
系統(tǒng)預(yù)計(jì)的任務(wù)開(kāi)始執(zhí)行時(shí)間(UTC時(shí)間)。 |
DBClusterId | String | pc-************** |
集群ID。 |
Region | String | cn-hangzhou |
目標(biāo)任務(wù)所屬地域的地域ID。 |
PlannedStartTime | String | 2021-01-28T12:00Z |
為目標(biāo)任務(wù)設(shè)定的執(zhí)行開(kāi)始時(shí)間(UTC時(shí)間)。 |
TaskId | String | 53879cdb-9a00-428e-acaf-ff4cff****** |
目標(biāo)任務(wù)的任務(wù)ID。 |
OrderId | String | 208161753****** |
訂單ID。 說(shuō)明 僅當(dāng)
Action 取值為CreateDBNodes或ModifyDBNodeClass時(shí)返回該參數(shù)。
|
DbClusterStatus | String | Running |
集群狀態(tài)。 |
DbClusterDescription | String | test_cluster |
集群描述。 |
TaskCancel | Boolean | true |
計(jì)劃任務(wù)是否可以取消。取值:
|
TotalRecordCount | Integer | 1 |
總記錄數(shù)。 |
PageNumber | Integer | 1 |
頁(yè)碼。 |
PageSize | Integer | 30 |
本頁(yè)記錄數(shù)。 |
Success | Boolean | true |
請(qǐng)求結(jié)果。 |
RequestId | String | 936C7025-27A5-4CB1-BB31-540E1F0CCA12 |
請(qǐng)求ID。 |
示例
請(qǐng)求示例
http(s)://polardb.aliyuncs.com/?Action=DescribeScheduleTasks
&<公共請(qǐng)求參數(shù)>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeScheduleTasksResponse>
<Message>Successful</Message>
<Data>
<TimerInfos>
<Status>finish</Status>
<Action>CreateDBNodes</Action>
<PlannedEndTime>2021-01-28T12:30Z</PlannedEndTime>
<PlannedTime>2021-01-28T12:16Z</PlannedTime>
<DBClusterId>pc-**************</DBClusterId>
<Region>cn-hangzhou</Region>
<PlannedStartTime>2021-01-28T12:00Z</PlannedStartTime>
<TaskId>53879cdb-9a00-428e-acaf-ff4cff******</TaskId>
<OrderId>208161753******</OrderId>
<DbClusterStatus>Running</DbClusterStatus>
<DbClusterDescription>test_cluster</DbClusterDescription>
<TaskCancel>true</TaskCancel>
</TimerInfos>
<TotalRecordCount>1</TotalRecordCount>
<PageNumber>1</PageNumber>
<PageSize>30</PageSize>
</Data>
<Success>true</Success>
<RequestId>936C7025-27A5-4CB1-BB31-540E1F0CCA12</RequestId>
</DescribeScheduleTasksResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "Successful",
"Data" : {
"TimerInfos" : [ {
"Status" : "finish",
"Action" : "CreateDBNodes",
"PlannedEndTime" : "2021-01-28T12:30Z",
"PlannedTime" : "2021-01-28T12:16Z",
"DBClusterId" : "pc-**************",
"Region" : "cn-hangzhou",
"PlannedStartTime" : "2021-01-28T12:00Z",
"TaskId" : "53879cdb-9a00-428e-acaf-ff4cff******",
"OrderId" : "208161753******",
"DbClusterStatus" : "Running",
"DbClusterDescription" : "test_cluster",
"TaskCancel" : true
} ],
"TotalRecordCount" : 1,
"PageNumber" : 1,
"PageSize" : 30
},
"Success" : true,
"RequestId" : "936C7025-27A5-4CB1-BB31-540E1F0CCA12"
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。