ModifyActiveOperationTasks - Modify O&M event switching time - PolarDB

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

polardb:ModifyActiveOperationTasks

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the region information of all clusters under the target account.	cn-beijing
TaskIds	string	Yes	The list of task IDs.	11111,22222
SwitchTime	string	No	The planned switchover time to set. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). Note The time cannot be later than the deadline. You can call the DescribeActiveOperationTasks operation and obtain the deadline from the Deadline response parameter.	2023-04-25T06:00:00Z
ImmediateStart	integer	No	Specifies whether to immediately start execution scheduling. 0: No (default). 1: Yes. Note If the value is 0, the SwitchTime parameter is required. If the value is 1, the SwitchTime parameter does not take effect. The event start time is set to the current time, and the switchover time is automatically calculated based on the new start time. The event immediately enters execution scheduling (not an immediate switchover) and begins pre-switchover preparations. The switchover is performed after the preparations are complete. You can call the DescribeActiveOperationTasks operation and obtain the preparation time from the PrepareInterval response parameter.	0

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	42CD2EF5-D77E-5AD4-961B-159330D98286
TaskIds	string	The list of task IDs.	11111,22222

Examples

Success response

JSON format

{
  "RequestId": "42CD2EF5-D77E-5AD4-961B-159330D98286",
  "TaskIds": "11111,22222"
}

Error codes

HTTP status code	Error code	Error message	Description
400	StartTimeBeforeNow	The start time should be later than current time.	The specified time parameter is invalid. The start time must be earlier than the end time.
400	TaskHasStarted	Task has started.	The task has started.
400	IncorrectTaskStatus	Certain task's status does not support this operation.
400	IncorrectTaskType	Current task does not support this operation.	This operation is not supported while the task is in the current state.
400	RequiredParam.NotFound	Required input param is not found.	The specified parameter does not exist.
400	TaskModifyError	Part of the tasks cannot be modified.	Part of the tasks cannot be modified. Please try again later.
400	SwitchTimeAfterDeadline	The switch time should be earlier than deadline.	The specified time parameter is invalid. The switchover time must be earlier than the end time.
400	InvalidTime.Format	InvalidTime.Format Specified time is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.