DocsICP FilingConsole
Documentation

CreateScheduledTask

Updated at:
Copy as MD
Product
My Favorites

Creates a scheduled inspection configuration for one or more instances.

Operation description

Applicable engines

RDS PostgreSQL

References

Warning This API operation incurs charges. Review the relevant documentation before you proceed.
RDS Supabase

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

create

*All Resource

*

 None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
Name

string

Yes

The name of the scheduled inspection task. The name can be up to 64 characters long.

RDS巡检
Description

string

No

The description of the scheduled inspection task.

定时RDS实例巡检任务
InstanceIds

string

No

The IDs of the instances. Separate multiple instance IDs with a comma (,).

rm-2ze6mk259v322****,rm-2zef3b65430j0****
StartTime

string

No

The time when the scheduled inspection runs. The time must be in the HH:mm:ssZ format (UTC). The default value is 02:00:00Z.

02:00:00Z
Frequency

string

No

The inspection frequency. You can specify multiple values, separated by commas (,). The default value is DAILY. Valid values:

  • DAILY: Every day

  • Monday: Monday

  • Tuesday: Tuesday

  • Wednesday: Wednesday

  • Thursday: Thursday

  • Friday: Friday

  • Saturday: Saturday

  • Sunday: Sunday

Note: The DAILY value overrides day-specific values. For example, if you set this parameter to DAILY,Monday, the system uses DAILY as the inspection frequency.

Monday
TimeRange

string

No

The time range of the data to inspect, specified in hours. The default value is 24 (the last 24 hours). The value must be an integer from 1 to 168.

24
ReportLanguage

string

No

The report language. The default value is zh-CN if the parameter is not specified. Valid values: zh-CN, zh-TW, ja-JP, and en-US.

zh-CN
ReportType

string

No

RegionId

string

No

ReportRegionId

string

No

Response elements

Element

Type

Description

Example

object

The returned data.

ScheduledId

string

The scheduled task ID.

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

boolean

Indicates whether the request was successful.

true
Message

string

The response message.

创建定时巡检任务成功
RequestId

string

The request ID.

D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2

Examples

Success response

JSON format

{
  "ScheduledId": "847268a4-196f-416b-aa12-bfe0c115****",
  "Success": true,
  "Message": "创建定时巡检任务成功",
  "RequestId": "D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2"
}

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.