ListScheduledTasks-阿里云帮助中心

Lists the basic information of all inspection configurations for a specified user ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rdsai:ListScheduledTasks

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ScheduledId	string	No	The ID of the scheduled inspection configuration.	847268a4-196f-416b-aa12-bfe0c115****
PageNumber	integer	No	The page number to return. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The default is 20 and the maximum is 100.	20

Response elements

Element	Type	Description	Example
	object	The data returned.
Success	boolean	Indicates whether the request was successful.	true
Message	string	The response message.	任务信息查询成功
Schedules	array<object>	A list of scheduled inspection tasks.
	object
ScheduledId	string	The ID of the scheduled inspection configuration.	9d246af2-a0cd-4f69-857d-3785048f****
Name	string	The task name.	巡检测试
Description	string	The inspection description.	每天凌晨2点自动巡检生产环境RDS实例
CreateTime	string	The creation time.	2026-02-04T06:51:24Z
InstanceCount	integer	The number of instances included in the task.	1
Frequency	string	The inspection frequency. You can specify multiple values, separated by commas (,). The default value is DAILY. Valid values: `DAILY`: Runs the inspection every day. `Monday`: Runs the inspection on Monday. `Tuesday`: Runs the inspection on Tuesday. `Wednesday`: Runs the inspection on Wednesday. `Thursday`: Runs the inspection on Thursday. `Friday`: Runs the inspection on Friday. `Saturday`: Runs the inspection on Saturday. `Sunday`: Runs the inspection on Sunday. Note: The `DAILY` value takes precedence over specific days of the week. For example, if you specify `DAILY,Monday`, the inspection runs daily.	Monday
TaskStartTime	string	The start time of the task.	18:00:00Z
TimeRange	string	The duration of the inspection period in hours, measured backward from the task start time. The value must be an integer from 1 to 168. The default is 24.	24小时
ReportLanguage	string
ReportType	string
RegionId	string
InspectionItems	string
TotalCount	integer	The total number of tasks found.	20
PageNumber	integer	The number of the returned page.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The unique ID of the request.	FE9C65D7-930F-57A5-A207-8C396329****

Examples

Success response

JSON format

{
  "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小时",
      "ReportLanguage": "",
      "ReportType": "",
      "RegionId": "",
      "InspectionItems": ""
    }
  ],
  "TotalCount": 20,
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Request parameter validation failed.	Request parameter verification failed
500	InternalError	System internal exception.	System internal exception
403	PermissionDenied	User has no operation permission.	User has no operation permission
403	InvalidUserOrder	There is no valid order for this UID.	There is no valid order for this UID
404	TaskNotFound	The resource of the specified ld does not exist.	The resource of the specified ld does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.