ListScheduledTasks - 查询用户所有巡检配置

更新时间:
复制为 MD 格式

查询指定用户UID下所有巡检配置的基本信息列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rdsai:ListScheduledTasksget
*全部资源
*

请求参数

名称类型必填描述示例值
ScheduledIdstring

定时巡检配置 ID。

847268a4-196f-416b-aa12-bfe0c115****
PageNumberlong

页码,默认为 1。

1
PageSizelong

每页数量,默认为 20,最大 100。

20

返回参数

名称类型描述示例值
object

Schema of Response

Successboolean

请求结果。

true
Messagestring

返回信息。

任务信息查询成功
Schedulesarray<object>

定时巡检任务列表。

Scheduleobject
ScheduledIdstring

定时巡检配置 ID。

9d246af2-a0cd-4f69-857d-3785048f****
Namestring

任务名称。

巡检测试
Descriptionstring

巡检描述。

每天凌晨2点自动巡检生产环境RDS实例
CreateTimestring

创建时间。

2026-02-04T06:51:24Z
InstanceCountlong

任务实例数。

1
Frequencystring

新的巡检频率,多个取值用英文逗号(,)隔开,默认为 DAILY。取值:

  • DAILY:每天
  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日

注意:DAILY 会覆盖周时间,例如填写 DAILY,Monday 后端会取 DAILY 作为巡检频率

Monday
TaskStartTimestring

任务实际开始时间。

18:00:00Z
TimeRangestring

巡检时间范围,默认最近 24 小时,取值:1~168(最大支持 7 天)。

24小时
TotalCountlong

总记录数。

20
PageNumberlong

页码。

1
PageSizelong

每页记录数。

10
RequestIdstring

请求 ID。

FE9C65D7-930F-57A5-A207-8C396329****

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Message": "任务信息查询成功",
  "Schedules": [
    {
      "ScheduledId": "9d246af2-a0cd-4f69-857d-3785048f****",
      "Name": "巡检测试",
      "Description": "每天凌晨2点自动巡检生产环境RDS实例",
      "CreateTime": "2026-02-04T06:51:24Z",
      "InstanceCount": 1,
      "Frequency": "Monday",
      "TaskStartTime": "18:00:00Z",
      "TimeRange": "24小时"
    }
  ],
  "TotalCount": 20,
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterRequest parameter validation failed.请求参数校验失败
403PermissionDeniedUser has no operation permission.用户无操作权限
403InvalidUserOrderThere is no valid order for this UID.UID并没有有效订单
404TaskNotFoundThe resource of the specified ld does not exist.指定ld的资源不存在
500InternalErrorSystem internal exception.系统内部异常

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2026-02-05新增 OpenAPI查看变更详情