ModifyScheduledTask-阿里云帮助中心

Modifies an existing inspection configuration.

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:ModifyScheduledTask

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ScheduledId	string	Yes	The ID of the scheduled inspection configuration.	847268a4-196f-416b-aa12-bfe0c115****
Name	string	No	The new name of the inspection configuration.	RDS巡检任务
Description	string	No	The new description of the inspection configuration.	定时RDS实例巡检任务
InstanceIds	string	No	The new instance IDs to associate with the task. Separate multiple IDs with a comma (,).	rm-2ze6mk259v322**,rm-2zef3b65430j0**
StartTime	string	No	The new time to run the inspection task. The time must be in the `HH:mm:ssZ` format and in UTC.	02:00:00Z
Frequency	string	No	The new inspection frequency. Separate multiple values with a comma (,). The default value is DAILY. Valid values: DAILY: Every day Monday: Every Monday Tuesday: Every Tuesday Wednesday: Every Wednesday Thursday: Every Thursday Friday: Every Friday Saturday: Every Saturday Sunday: Every Sunday Note: `DAILY` overrides all other day-of-the-week settings. For example, if you specify `DAILY,Monday`, the system uses `DAILY` as the inspection frequency.	Monday
TimeRange	string	No	The inspection time range in hours. The default is 24, which means data from the last 24 hours is inspected. Valid values: 1 to 168. The maximum supported range is 7 days.	24
ReportLanguage	string	No

Response elements

Element	Type	Description	Example
	object	Response object
Success	boolean	Indicates whether the request was successful.	true
Message	string	The response message.	定时任务更新成功
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329****

Examples

Success response

JSON format

{
  "Success": true,
  "Message": "定时任务更新成功",
  "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.