查询所有定时任务的详情情况。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Status | string | 否 | 任务状态,取值范围如下:
说明
若该参数留空,默认查询所有状态的计划任务。
| finish |
DBClusterId | string | 否 | 集群 ID。 说明
| pc-************** |
RegionId | string | 否 | 地域 ID。 说明
| cn-hangzhou |
PageNumber | integer | 否 | 页码,取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1。 | 1 |
PageSize | integer | 否 | 每页记录数,取值为 30(默认值)、50 或 100。 | 30 |
TaskAction | string | 否 | 任务类型,取值范围如下:
说明
PlannedStartTime 参数值,会返回目标任务的详情,否则TimerInfos 为空。 | CreateDBNodes |
DBClusterDescription | string | 否 | 集群描述。 | testdb |
OrderId | string | 否 | 订单 ID。 说明
仅支持传入数字 0~9。
| 20951253014**** |
PlannedStartTime | string | 否 | 为目标任务设定的执行开始时间(UTC 时间)。 | 2021-01-28T12:00Z |
PlannedEndTime | string | 否 | 为目标任务设定的最晚开始时间(UTC 时间)。 | 2021-01-28T12:30Z |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-************ |
返回参数
示例
正常返回示例
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"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidOrderId.Malformed | The specified parameter OrderId is not valid. | 指定的订单 ID 无效。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-09-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|