All Products
Search
Document Center

ApsaraDB RDS:ListScheduledTasks

Last Updated:Mar 05, 2026

Queries the basic information of all inspection configurations under a specified user.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rdsai:ListScheduledTasksget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ScheduledIdstringNo

The ID of the scheduled inspection configuration.

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

The page number. Pages start from 1. Default value: 1.

1
PageSizelongNo

The number of records on each page. Default value: 20. Maximum value: 100.

20

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

Successboolean

Indicates whether the request was successful.

true
Messagestring

The response message.

Schedulesarray<object>

The list of scheduled inspection tasks.

Scheduleobject
ScheduledIdstring

The ID of the scheduled inspection configuration.

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

The name of the task.

Descriptionstring

The description of the inspection task.

CreateTimestring

The creation time of the task.

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

The number of instances covered by the task.

1
Frequencystring

The new inspection frequency. Separate multiple values with commas (,). Default value: DAILY. Valid values:

  • DAILY
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday

Note: DAILY takes precedence over other values. For example, if you set this parameter to DAILY,Monday, the backend will use DAILY as the inspection frequency.

Monday
TaskStartTimestring

The actual start time of the task.

18:00:00Z
TimeRangestring

The inspection time range. The default value is the latest 24 hours. Valid values: 1 to 168. The maximum value is 7 days.

TotalCountlong

The total number of entries that are returned.

20
PageNumberlong

The page number.

1
PageSizelong

The number of records returned on each page.

10
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "Message": "",
  "Schedules": [
    {
      "ScheduledId": "9d246af2-a0cd-4f69-857d-3785048f****",
      "Name": "",
      "Description": "",
      "CreateTime": "2026-02-04T06:51:24Z",
      "InstanceCount": 1,
      "Frequency": "Monday",
      "TaskStartTime": "18:00:00Z",
      "TimeRange": ""
    }
  ],
  "TotalCount": 20,
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterRequest parameter validation failed.Request parameter verification failed
403PermissionDeniedUser has no operation permission.User has no operation permission
403InvalidUserOrderThere is no valid order for this UID.There is no valid order for this UID
404TaskNotFoundThe resource of the specified ld does not exist.The resource of the specified ld does not exist.
500InternalErrorSystem internal exception.System internal exception

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2026-02-05Add OperationView Change Details