调用DescribeScheduleTasks接口查看当前账号下所有或指定的计划任务详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeScheduleTasks |
系统规定参数,取值为DescribeScheduleTasks。 |
Status | String | 否 | finish |
任务状态,取值范围如下:
说明 若该参数留空,默认查询所有状态的计划任务。
|
DBClusterId | String | 否 | pc-************** |
集群ID。 说明
|
RegionId | String | 否 | cn-hangzhou |
地域ID。 说明
|
PageNumber | Integer | 否 | 1 |
页码,取值为大于0且不超过Integer数据类型的最大值。默认值为1。 |
PageSize | Integer | 否 | 30 |
每页记录数,取值为30(默认值)、50或100。 |
TaskAction | String | 否 | CreateDBNodes |
任务类型,取值范围如下:
说明
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Struct |
结果集。 |
|
PageNumber | Integer | 1 |
页码。 |
PageSize | Integer | 30 |
本页记录数。 |
TimerInfos | Array of timerInfos |
计划任务详情。 |
|
Action | String | CreateDBNodes |
任务类型。 |
DBClusterId | String | pc-************** |
集群ID。 |
DbClusterDescription | String | test_cluster |
集群描述。 |
DbClusterStatus | String | Running |
集群状态。 |
OrderId | String | 208161753****** |
订单ID。 说明 仅当
Action 取值为CreateDBNodes或ModifyDBNodeClass时返回该参数。
|
PlannedEndTime | String | 2021-01-28T12:30Z |
为目标任务设定的最晚结束时间(UTC时间)。 |
PlannedStartTime | String | 2021-01-28T12:00Z |
为目标任务设定的执行开始时间(UTC时间)。 |
PlannedTime | String | 2021-01-28T12:16Z |
系统预计的任务开始执行时间(UTC时间)。 |
Region | String | cn-hangzhou |
目标任务所属地域的地域ID。 |
Status | String | finish |
目标任务的状态。 |
TaskId | String | 53879cdb-9a00-428e-acaf-ff4cff****** |
目标任务的任务ID。 |
TotalRecordCount | Integer | 1 |
总记录数。 |
Message | String | Successful |
请求返回消息。 说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
|
RequestId | String | 936C7025-27A5-4CB1-BB31-540E1F0CCA12 |
请求ID。 |
Success | Boolean | true |
请求结果。 |
示例
请求示例
http(s)://polardb.aliyuncs.com/?Action=DescribeScheduleTasks
&<公共请求参数>
正常返回示例
XML
格式
<DescribeScheduleTasksResponse>
<RequestId>936C7025-27A5-4CB1-BB31-540E1F******</RequestId>
<Message>Successful</Message>
<Data>
<TotalRecordCount>1</TotalRecordCount>
<TimerInfos>
<Status>finish</Status>
<Action>CreateDBNodes</Action>
<TaskId>53879cdb-9a00-428e-acaf-ff4cff******</TaskId>
<PlannedTime>2021-01-28T12:16Z</PlannedTime>
<DbClusterDescription>test_cluster</DbClusterDescription>
<PlannedStartTime>2021-01-28T12:00Z</PlannedStartTime>
<DBClusterId>pc-**************</DBClusterId>
<Region>cn-hangzhou</Region>
<OrderId>208161753******</OrderId>
<PlannedEndTime>2021-01-28T12:30Z</PlannedEndTime>
<DbClusterStatus>Running</DbClusterStatus>
</TimerInfos>
<PageSize>30</PageSize>
<PageNumber>1</PageNumber>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeScheduleTasksResponse>
JSON
格式
{
"RequestId": "936C7025-27A5-4CB1-BB31-540E1F******",
"Message": "Successful",
"Data": {
"TotalRecordCount": 1,
"TimerInfos": [
{
"Status": "finish",
"Action": "CreateDBNodes",
"TaskId": "53879cdb-9a00-428e-acaf-ff4cff******",
"PlannedTime": "2021-01-28T12:16Z",
"DbClusterDescription": "test_cluster",
"PlannedStartTime": "2021-01-28T12:00Z",
"DBClusterId": "pc-**************",
"Region": "cn-hangzhou",
"OrderId": "208161753******",
"PlannedEndTime": "2021-01-28T12:30Z",
"DbClusterStatus": "Running"
}
],
"PageSize": 30,
"PageNumber": 1
},
"Code": "200",
"Success": true
}
错误码
访问错误中心查看更多错误码。