You need to enable JavaScript to run this app.
RDS for PostgreSQL

RDS for PostgreSQL

Copy page
Download PDF
Task management
ModifyTask
Copy page
Download PDF
ModifyTask
Call the ModifyTask API to edit the task.​
Request type​
Synchronous request.​
Debug​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
​
Parameter​
Type​
Required?​
Example​
Description​
InstanceId​
String​
Yes​
postgres-2904ed64****​
Instance ID.​
TaskId​
String​
Yes​
202509102225598DA116E6B90D38F149EA-9f0b91​
Task ID.​
TaskEventOperation​
String​
Yes​
ChangeToSpecifiedTime​
The modification type of the task. Values:​
  • ChangeToSpecifiedTime: modify to execute during a specific time period. When the value is ChangeToSpecifiedTime, specify ModifyBeginTime and ModifyEndTime first.​
  • ChangeToMaintainTime: modify to execute during the maintenance window.​
  • ImmediateExecute: execute now.​
  • Cancel: cancel the task.​
tip​
Only tasks in To be switched state support modification.​
ModifyBeginTime​
String​
No​
2025-08-03T06:00:00Z​
The start time for execution within a specific time period. The time format is yyyy-MM-ddTHH:mm:ssZ (UTC time).​
tip​
Required when modifying the task to execute within the specific time period, that is, when TaskEventOperation is set to ChangeToSpecifiedTime.​
ModifyEndTime​
String​
No​
2025-08-03T07:59:00Z​
The end time for execution within the specific time period. The time format is yyyy-MM-ddTHH:mm:ssZ (UTC time).​
tip​
Required when modifying the task to execute within the specific time period, that is, when TaskEventOperation is set to ChangeToSpecifiedTime.​
ProjectName​
String​
No​
default​
Project name.​
​
Response parameter​
null​
Sample​
Sample request​
​
POST /?Action=ModifyTask&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-postgresql.cn-beijing.volcengineapi.com​
X-Date: 20231002T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "postgres-c80c288b****",​
"TaskEventOperation": "Cancel",​
"TaskId": "2025091110404644E00EC62320C40F8011-5345d9"​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "20250911133256F240B7AC2B8EC854351B-748dd1",​
"Action": "ModifyTask",​
"Version": "2022-01-01",​
"Service": "rds_postgresql",​
"Region": "cn-beijing"​
},​
"Result": null​
}​
​
Last updated: 2026.03.31 10:45:19